filechooser.h

Go to the documentation of this file.

/*
 Copyright (C) 2001-2006, William Joseph.
 All Rights Reserved.

 This file is part of GtkRadiant.

 GtkRadiant is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 GtkRadiant is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with GtkRadiant; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#if !defined(INCLUDED_GTKUTIL_FILECHOOSER_H)
#define INCLUDED_GTKUTIL_FILECHOOSER_H

#include <string>
#include "radiant_i18n.h"


typedef struct _GtkWidget GtkWidget;
const char* file_dialog (GtkWidget *parent, bool open, const std::string& title, const std::string& path = "",
        const std::string& pattern = "");

namespace gtkutil
{

    class FileChooser
    {
        public:
            class Preview
            {
                public:
                    // Retrieve the preview widget for packing into the dialog
                    virtual GtkWidget* getPreviewWidget () = 0;

                    virtual void onFileSelectionChanged (const std::string& newFileName, FileChooser& fileChooser) = 0;
            };

        private:
            // Parent widget
            GtkWidget* _parent;

            GtkWidget* _dialog;

            // Window title
            std::string _title;

            std::string _path;
            std::string _file;

            std::string _pattern;

            std::string _defaultExt;

            // Open or save dialog
            bool _open;

            // The optional preview object
            Preview* _preview;

        public:
            FileChooser (GtkWidget* parent, const std::string& title, bool open, bool browseFolders,
                    const std::string& pattern = "", const std::string& defaultExt = "");

            virtual ~FileChooser ();

            // Lets the dialog start at a certain path
            void setCurrentPath (const std::string& path);

            // Pre-fills the currently selected file
            void setCurrentFile (const std::string& file);

            void attachPreview (Preview* preview);

            virtual std::string getSelectedFileName ();

            virtual std::string display ();

            // Public function for Preview objects. These must set the "active" state
            // of the preview when the onFileSelectionChange() signal is emitted.
            void setPreviewActive (bool active);

        private:
            // GTK callback for updating the preview widget
            static void onUpdatePreview (GtkFileChooser* chooser, FileChooser* self);
    };

} // namespace gtkutil


#endif