filechooser.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_FILECHOOSER_H
#define _GTKMM_FILECHOOSER_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: filechooser.hg,v 1.23 2006/04/18 13:28:56 murrayc Exp $ */
 
/* Copyright (C) 2003 The gtkmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#include <gtkmm/widget.h>
#include <gtkmm/filefilter.h>
#include <glibmm/interface.h>
#include <giomm/file.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkFileChooser GtkFileChooser;
typedef struct _GtkFileChooserClass GtkFileChooserClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class FileChooser_Class; } // namespace Gtk
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gtk
{
 
enum FileChooserAction
{
  FILE_CHOOSER_ACTION_OPEN,
  FILE_CHOOSER_ACTION_SAVE,
  FILE_CHOOSER_ACTION_SELECT_FOLDER,
  FILE_CHOOSER_ACTION_CREATE_FOLDER
};
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::FileChooserAction> : public Glib::Value_Enum<Gtk::FileChooserAction>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
enum FileChooserConfirmation
{
  FILE_CHOOSER_CONFIRMATION_CONFIRM,
  FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME,
  FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN
};
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::FileChooserConfirmation> : public Glib::Value_Enum<Gtk::FileChooserConfirmation>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
//Note that GTK_FILE_SYSTEM_ERROR is not currently public GTK+ API and should
//never be instantiated by the GTK+ C API.
 
class FileChooserError : public Glib::Error
{
public:
  enum Code
  {
    NONEXISTENT,
    BAD_FILENAME,
    ALREADY_EXISTS,
    INCOMPLETE_HOSTNAME
  };
 
  FileChooserError(Code error_code, const Glib::ustring& error_message);
  explicit FileChooserError(GError* gobject);
  Code code() const;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
 
  static void throw_func(GError* gobject);
 
  friend void wrap_init(); // uses throw_func()
 
  #endif //DOXYGEN_SHOULD_SKIP_THIS
};
 
} // namespace Gtk
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::FileChooserError::Code> : public Glib::Value_Enum<Gtk::FileChooserError::Code>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
class FileChooser : public Glib::Interface
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef FileChooser CppObjectType;
  typedef FileChooser_Class CppClassType;
  typedef GtkFileChooser BaseObjectType;
  typedef GtkFileChooserClass BaseClassType;
 
private:
  friend class FileChooser_Class;
  static CppClassType filechooser_class_;
 
  // noncopyable
  FileChooser(const FileChooser&);
  FileChooser& operator=(const FileChooser&);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
protected:
  FileChooser();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  explicit FileChooser(const Glib::Interface_Class& interface_class);
 
public:
  // This is public so that C++ wrapper instances can be
  // created for C instances of unwrapped types.
  // For instance, if an unexpected C type implements the C interface. 
  explicit FileChooser(GtkFileChooser* castitem);
 
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~FileChooser();
 
  static void add_interface(GType gtype_implementer);
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkFileChooser*       gobj()       { return reinterpret_cast<GtkFileChooser*>(gobject_); }
 
  const GtkFileChooser* gobj() const { return reinterpret_cast<GtkFileChooser*>(gobject_); }
 
private:
 
public:
 
  
  void set_action(FileChooserAction action);
  
  FileChooserAction get_action() const;
  
  void set_local_only(bool local_only =  true);
  
  bool get_local_only() const;
  
  void set_select_multiple(bool select_multiple =  true);
  
  bool get_select_multiple() const;
 
  
  void set_show_hidden(bool show_hidden =  true);
  
  bool get_show_hidden() const;
 
  
  void set_do_overwrite_confirmation(bool do_overwrite_confirmation =  true);
  
  bool get_do_overwrite_confirmation() const;
 
  
  void set_create_folders(bool create_folders =  true);
  
  bool get_create_folders() const;
 
  
  void set_current_name(const Glib::ustring& name);
  
  Glib::ustring get_filename() const;
  
  bool set_filename(const Glib::ustring& filename);
  
  bool select_filename(const Glib::ustring& filename);
  
  void unselect_filename(const Glib::ustring& filename);
  
  void select_all();
  
  void unselect_all();
  
  Glib::SListHandle<Glib::ustring> get_filenames() const;
  
  bool set_current_folder(const Glib::ustring& filename);
  
  Glib::ustring get_current_folder() const;
 
 
/* URI manipulation
 */
  
  Glib::ustring get_uri() const;
  
  bool set_uri(const Glib::ustring& uri);
  
  bool select_uri(const Glib::ustring& uri);
  
  void unselect_uri(const Glib::ustring& uri);
  
  Glib::SListHandle<Glib::ustring> get_uris() const;
 
  
  bool set_current_folder_uri(const Glib::ustring& uri);
  
  Glib::ustring get_current_folder_uri() const;
 
  
  bool set_file(const Glib::RefPtr<const Gio::File>& uri);
 
  
  bool select_file(const Glib::RefPtr<const Gio::File>& file);
  
  void unselect_file(const Glib::RefPtr<const Gio::File>& file);
 
 
  Glib::SListHandle< Glib::RefPtr<Gio::File> > get_files();
 
  
  bool set_current_folder_file(const Glib::RefPtr<const Gio::File>& file);
 
  //No refreturn is needed here, because the C function provides a reference:
  
  Glib::RefPtr<Gio::File> get_current_folder_file();
 
  //No refreturn is needed here, because the C function provides a reference:
  
  Glib::RefPtr<Gio::File> get_file();
  
  Glib::RefPtr<const Gio::File> get_file() const;
 
/* Preview widget
 */
  
  void set_preview_widget(Gtk::Widget& preview_widget);
 
  
  Gtk::Widget* get_preview_widget();
  
  const Gtk::Widget* get_preview_widget() const;
 
  
  void set_preview_widget_active(bool active =  true);
  
  bool get_preview_widget_active() const;
 
  
  void set_use_preview_label(bool use_label =  true);
  
  bool get_use_preview_label() const;
 
  
  Glib::ustring get_preview_filename() const;
  
  Glib::ustring get_preview_uri() const;
 
  //No refreturn is needed here, because the C function provides a reference:
  
  Glib::RefPtr<Gio::File> get_preview_file();
  
  Glib::RefPtr<const Gio::File> get_preview_file() const;
 
/* Extra widget
 */
  
  void set_extra_widget(Gtk::Widget& extra_widget);
  
  Gtk::Widget* get_extra_widget();
  
  const Gtk::Widget* get_extra_widget() const;
 
/* List of user selectable filters
 */
  
  void add_filter(const FileFilter& filter);
  
  void remove_filter(const FileFilter& filter);
 
  
  Glib::SListHandle< FileFilter* > list_filters();
  
  Glib::SListHandle< const FileFilter* > list_filters() const;
 
/* Current filter
 */
  
  void set_filter(const FileFilter& filter);
  
  FileFilter* get_filter();
  
  const FileFilter* get_filter() const;
 
/* Per-application shortcut folders */
 
  
  bool add_shortcut_folder(const Glib::ustring& folder);
  
  bool remove_shortcut_folder(const Glib::ustring& folder);
  
  Glib::SListHandle<Glib::ustring> list_shortcut_folders() const;
 
  
  bool add_shortcut_folder_uri(const Glib::ustring& uri);
  
  bool remove_shortcut_folder_uri(const Glib::ustring& uri);
  
  Glib::SListHandle<Glib::ustring> list_shortcut_folder_uris() const;
 
 
  Glib::SignalProxy0< void > signal_current_folder_changed();
 
 
  Glib::SignalProxy0< void > signal_selection_changed();
 
 
  Glib::SignalProxy0< void > signal_update_preview();
 
 
  Glib::SignalProxy0< void > signal_file_activated();
 
 
  Glib::SignalProxy0< FileChooserConfirmation > signal_confirm_overwrite();
 
 
  Glib::PropertyProxy< FileChooserAction > property_action() ;
 
  Glib::PropertyProxy_ReadOnly< FileChooserAction > property_action() const;
 
  //TODO: _WRAP_PROPERTY("file-system-backend", FileSystem) //FileSystem is not really public API.
  Glib::PropertyProxy< FileFilter* > property_filter() ;
 
  Glib::PropertyProxy_ReadOnly< FileFilter* > property_filter() const;
 
  Glib::PropertyProxy< bool > property_local_only() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_local_only() const;
 
  Glib::PropertyProxy< Widget* > property_preview_widget() ;
 
  Glib::PropertyProxy_ReadOnly< Widget* > property_preview_widget() const;
 
  Glib::PropertyProxy< bool > property_preview_widget_active() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_preview_widget_active() const;
 
  Glib::PropertyProxy< bool > property_use_preview_label() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_use_preview_label() const;
 
  Glib::PropertyProxy< Widget* > property_extra_widget() ;
 
  Glib::PropertyProxy_ReadOnly< Widget* > property_extra_widget() const;
 
  Glib::PropertyProxy< bool > property_select_multiple() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_select_multiple() const;
 
  Glib::PropertyProxy< bool > property_show_hidden() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_show_hidden() const;
 
  Glib::PropertyProxy< bool > property_do_overwrite_confirmation() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_do_overwrite_confirmation() const;
 
  Glib::PropertyProxy< bool > property_create_folders() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_create_folders() const;
 
 
public:
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::FileChooser> wrap(GtkFileChooser* object, bool take_copy = false);
 
} // namespace Glib
 
 
#endif /* _GTKMM_FILECHOOSER_H */