Gtk::FileChooser Class Reference

Inheritance diagram for Gtk::FileChooser:

Detailed Description

Gtk::FileChooser is an interface that can be implemented by file selection widgets.

In gtkmm, the main objects that implement this interface are FileChooserWidget and FileChooserDialog. You do not need to write an object that implements the FileChooser interface unless you are trying to adapt an existing file selector to expose a standard programming interface.

File Names and Encodings: When the user is finished selecting files in a FileChooser, your program can get the selected names either as filenames or as URIs. For URIs, the normal escaping rules are applied if the URI contains non-ASCII characters. However, filenames are always returned in the character set specified by the G_FILENAME_ENCODING environment variable. Please see the Glib documentation for more details about this variable.

Important: This means that while you can pass the result of FileChooser::get_filename() to open(2) or fopen(3), you may not be able to directly set it as the text of a Gtk::Label widget unless you convert it first to UTF-8, which all gtkmm widgets expect. You should use Glib::filename_to_utf8() to convert filenames into strings that can be passed to gtkmm widgets.

Note:: The gtkmm FileChooser API is broken in that methods return Glib::ustring even though the returned string is not necessarily UTF-8 encoded. Any FileChooser method that takes or returns a filename (not a URI) should have std::string as parameter or return type. Fortunately this mistake doesn't prevent you from handling filenames correctly in your application. Just pretend that the API uses std::string and call Glib::filename_to_utf8() or Glib::filename_from_utf8() as appropriate.

See http://bugzilla.gnome.org/show_bug.cgi?id=142138 for more information.


Public Member Functions
void	add_filter (const FileFilter& filter)
	Adds filter to the list of filters that the user can select between.
bool	add_shortcut_folder (const Glib::ustring& folder)
	Adds a folder to be displayed with the shortcut folders in a file chooser.
bool	add_shortcut_folder_uri (const Glib::ustring& uri)
	Adds a folder URI to be displayed with the shortcut folders in a file chooser.
FileChooserAction	get_action () const
	Gets the type of operation that the file chooser is performing; see set_action().
Glib::ustring	get_current_folder () const
	Gets the current folder of chooser as a local filename.
Glib::ustring	get_current_folder_uri () const
	Gets the current folder of chooser as an URI.
bool	get_do_overwrite_confirmation () const
	Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists.
const Gtk::Widget*	get_extra_widget () const
	Gets the current preview widget; see set_extra_widget().
Gtk::Widget*	get_extra_widget ()
	Gets the current preview widget; see set_extra_widget().
Glib::ustring	get_filename () const
	Gets the filename for the currently selected file in the file selector.
Glib::SListHandle<Glib::ustring>	get_filenames () const
	Lists all the selected files and subfolders in the current folder of chooser.
const FileFilter*	get_filter () const
	Gets the current filter; see set_filter().
FileFilter*	get_filter ()
	Gets the current filter; see set_filter().
bool	get_local_only () const
	Gets whether only local files can be selected in the file selector.
Glib::ustring	get_preview_filename () const
	Gets the filename that should be previewed in a custom preview widget.
Glib::ustring	get_preview_uri () const
	Gets the URI that should be previewed in a custom preview widget.
const Gtk::Widget*	get_preview_widget () const
	Gets the current preview widget; see set_preview_widget().
Gtk::Widget*	get_preview_widget ()
	Gets the current preview widget; see set_preview_widget().
bool	get_preview_widget_active () const
	Gets whether the preview widget set by set_preview_widget() should be shown for the current filename.
bool	get_select_multiple () const
	Gets whether multiple files can be selected in the file selector.
bool	get_show_hidden () const
	Gets whether hidden files and folders are displayed in the file selector.
Glib::ustring	get_uri () const
	Gets the URI for the currently selected file in the file selector.
Glib::SListHandle<Glib::ustring>	get_uris () const
	Lists all the selected files and subfolders in the current folder of chooser.
bool	get_use_preview_label () const
	Gets whether a stock label should be drawn with the name of the previewed file.
const GtkFileChooser*	gobj () const
	Provides access to the underlying C GObject.
GtkFileChooser*	gobj ()
	Provides access to the underlying C GObject.
Glib::SListHandle< const FileFilter* >	list_filters () const
	Lists the current set of user-selectable filters; see add_filter(), remove_filter().
Glib::SListHandle<FileFilter*>	list_filters ()
	Lists the current set of user-selectable filters; see add_filter(), remove_filter().
Glib::SListHandle<Glib::ustring>	list_shortcut_folder_uris () const
	Queries the list of shortcut folders in the file chooser, as set by add_shortcut_folder_uri().
Glib::SListHandle<Glib::ustring>	list_shortcut_folders () const
	Queries the list of shortcut folders in the file chooser, as set by add_shortcut_folder().
Glib::PropertyProxy_ReadOnly <FileChooserAction>	property_action () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy <FileChooserAction>	property_action ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly <bool>	property_do_overwrite_confirmation () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool>	property_do_overwrite_confirmation ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly <Widget*>	property_extra_widget () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Widget*>	property_extra_widget ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly <FileFilter*>	property_filter () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<FileFilter*>	property_filter ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly <bool>	property_folder_mode () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool>	property_folder_mode ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly <bool>	property_local_only () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool>	property_local_only ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly <Widget*>	property_preview_widget () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Widget*>	property_preview_widget ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly <bool>	property_preview_widget_active () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool>	property_preview_widget_active ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly <bool>	property_select_multiple () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool>	property_select_multiple ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly <bool>	property_show_hidden () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool>	property_show_hidden ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly <bool>	property_use_preview_label () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool>	property_use_preview_label ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
void	remove_filter (const FileFilter& filter)
	Removes filter from the list of filters that the user can select between.
bool	remove_shortcut_folder (const Glib::ustring& folder)
	Removes a folder from a file chooser's list of shortcut folders.
bool	remove_shortcut_folder_uri (const Glib::ustring& uri)
	Removes a folder URI from a file chooser's list of shortcut folders.
void	select_all ()
	Selects all the files in the current folder of a file chooser.
bool	select_filename (const Glib::ustring& filename)
	Selects a filename.
bool	select_uri (const Glib::ustring& uri)
	Selects the file to by uri.
void	set_action (FileChooserAction action)
	Sets the type of operation that the chooser is performing; the user interface is adapted to suit the selected action.
bool	set_current_folder (const Glib::ustring& filename)
	Sets the current folder for chooser from a local filename.
bool	set_current_folder_uri (const Glib::ustring& uri)
	Sets the current folder for chooser from an URI.
void	set_current_name (const Glib::ustring& name)
	Sets the current name in the file selector, as if entered by the user.
void	set_do_overwrite_confirmation (bool do_overwrite_confirmation=true)
	Sets whether a file chooser in GTK_FILE_CHOOSER_ACTION_SAVE mode will present a confirmation dialog if the user types a file name that already exists.
void	set_extra_widget (Gtk::Widget& extra_widget)
	Sets an application-supplied widget to provide extra options to the user.
bool	set_filename (const Glib::ustring& filename)
	Sets filename as the current filename for the file chooser, by changing to the file's parent folder and actually selecting the file in list.
void	set_filter (const FileFilter& filter)
	Sets the current filter; only the files that pass the filter will be displayed.
void	set_local_only (bool local_only=true)
	Sets whether only local files can be selected in the file selector.
void	set_preview_widget (Gtk::Widget& preview_widget)
	Sets an application-supplied widget to use to display a custom preview of the currently selected file.
void	set_preview_widget_active (bool active=true)
	Sets whether the preview widget set by set_preview_widget() should be shown for the current filename.
void	set_select_multiple (bool select_multiple=true)
	Sets whether multiple files can be selected in the file selector.
void	set_show_hidden (bool show_hidden=true)
	Sets whether hidden files and folders are displayed in the file selector.
bool	set_uri (const Glib::ustring& uri)
	Sets the file referred to by uri as the current file for the file chooser, by changing to the URI's parent folder and actually selecting the URI in the list.
void	set_use_preview_label (bool use_label=true)
	Sets whether the file chooser should display a stock label with the name of the file that is being previewed; the default is `true`.
Glib::SignalProxy0 <FileChooserConfirmation>	signal_confirm_overwrite ()
Glib::SignalProxy0<void>	signal_current_folder_changed ()
	This signal is emitted when the current folder in a FileChooser changes.
Glib::SignalProxy0<void>	signal_file_activated ()
	This signal is emitted when the user "activates" a file in the file chooser.
Glib::SignalProxy0<void>	signal_selection_changed ()
	This signal is emitted when there is a change in the set of selected files in a GtkFileChooser.
Glib::SignalProxy0<void>	signal_update_preview ()
	This signal is emitted when the preview in a file chooser should be regenerated.
void	unselect_all ()
	Unselects all the files in the current folder of a file chooser.
void	unselect_filename (const Glib::ustring& filename)
	Unselects a currently selected filename.
void	unselect_uri (const Glib::ustring& uri)
	Unselects the file referred to by uri.
virtual	~FileChooser ()
Static Public Member Functions
static void	add_interface (GType gtype_implementer)
Related Functions
(Note that these are not member functions.)
Glib::RefPtr<Gtk::FileChooser>	wrap (GtkFileChooser* object, bool take_copy=false)
	A Glib::wrap() method for this object.

Constructor & Destructor Documentation

virtual Gtk::FileChooser::~FileChooser ( ) [virtual]

Member Function Documentation

void Gtk::FileChooser::add_filter ( const FileFilter& filter )

Adds filter to the list of filters that the user can select between.

When a filter is selected, only files that are passed by that filter are displayed.

Note that the chooser takes ownership of the filter, so you have to ref and sink it if you want to keep a reference.

Since gtkmm 2.4:

Parameters:

filter

A Gtk::FileFilter.

static void Gtk::FileChooser::add_interface ( GType gtype_implementer ) [static]

bool Gtk::FileChooser::add_shortcut_folder ( const Glib::ustring & folder )

Adds a folder to be displayed with the shortcut folders in a file chooser.

Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a "/usr/share/mydrawprogram/Clipart" folder to the volume list.

Parameters:

folder

Filename of the folder to add.

Returns:: true if the folder could be added successfully, false otherwise. In the latter case, the error will be set as appropriate.

Since gtkmm 2.4:

bool Gtk::FileChooser::add_shortcut_folder_uri ( const Glib::ustring & uri )

Adds a folder URI to be displayed with the shortcut folders in a file chooser.

Note that shortcut folders do not get saved, as they are provided by the application. For example, you can use this to add a "file:///usr/share/mydrawprogram/Clipart" folder to the volume list.

Parameters:

uri

URI of the folder to add.

Returns:: true if the folder could be added successfully, false otherwise. In the latter case, the error will be set as appropriate.

Since gtkmm 2.4:

FileChooserAction Gtk::FileChooser::get_action ( ) const

Gets the type of operation that the file chooser is performing; see set_action().

Returns:: The action that the file selector is performing

Since gtkmm 2.4:

Glib::ustring Gtk::FileChooser::get_current_folder ( ) const

Gets the current folder of chooser as a local filename.

See set_current_folder().

Returns:: The full path of the current folder, possibly empty if the current path cannot be represented as a local filename. This function may also return and empty string if the file chooser was unable to load the last folder that was requested from it; for example, as would be for calling set_current_folder() on a nonexistent folder.

Since gtkmm 2.4:

Glib::ustring Gtk::FileChooser::get_current_folder_uri ( ) const

Gets the current folder of chooser as an URI.

See set_current_folder_uri().

Note that this is the folder that the file chooser is currently displaying (e.g. "file:///home/username/Documents"), which is not the same as the currently-selected folder if the chooser is in Gtk::FILE_CHOOSER_SELECT_FOLDER mode (e.g. "file:///home/username/Documents/selected-folder/". To get the currently-selected folder in that mode, use get_uri() as the usual way to get the selection.

Returns:: The URI for the current folder.

bool Gtk::FileChooser::get_do_overwrite_confirmation ( ) const

Queries whether a file chooser is set to confirm for overwriting when the user types a file name that already exists.

Returns:: true if the file chooser will present a confirmation dialog; false otherwise.

Since gtkmm 2.8:

const Gtk::Widget* Gtk::FileChooser::get_extra_widget ( ) const

Gets the current preview widget; see set_extra_widget().

Returns:: The current extra widget, or 0

Since gtkmm 2.4:

Gtk::Widget* Gtk::FileChooser::get_extra_widget ( )

Gets the current preview widget; see set_extra_widget().

Returns:: The current extra widget, or 0

Since gtkmm 2.4:

Glib::ustring Gtk::FileChooser::get_filename ( ) const

Gets the filename for the currently selected file in the file selector.

If multiple files are selected, one of the filenames will be returned at random.

If the file chooser is in folder mode, this function returns the selected folder.

Returns:: The currently selected filename, or an empty string if no file is selected, or the selected file can't be represented with a local filename.

Glib::SListHandle<Glib::ustring> Gtk::FileChooser::get_filenames ( ) const

Lists all the selected files and subfolders in the current folder of chooser.

The returned names are full absolute paths. If files in the current folder cannot be represented as local filenames they will be ignored. (See get_uris())

Returns:: A list containing the filenames of all selected files and subfolders in the current folder.

Since gtkmm 2.4:

const FileFilter* Gtk::FileChooser::get_filter ( ) const

Gets the current filter; see set_filter().

Returns:: The current filter, or 0

Since gtkmm 2.4:

FileFilter* Gtk::FileChooser::get_filter ( )

Gets the current filter; see set_filter().

Returns:: The current filter, or 0

Since gtkmm 2.4:

bool Gtk::FileChooser::get_local_only ( ) const

Gets whether only local files can be selected in the file selector.

See set_local_only()

Returns:: true if only local files can be selected.

Since gtkmm 2.4:

Glib::ustring Gtk::FileChooser::get_preview_filename ( ) const

Gets the filename that should be previewed in a custom preview widget.

See set_preview_widget().

Returns:: The filename to preview, or an empty string if no file is selected, or if the selected file cannot be represented as a local filename.

Glib::ustring Gtk::FileChooser::get_preview_uri ( ) const

Gets the URI that should be previewed in a custom preview widget.

See set_preview_widget().

Returns:: The URI for the file to preview, or an empty string if no file is selected.

const Gtk::Widget* Gtk::FileChooser::get_preview_widget ( ) const

Gets the current preview widget; see set_preview_widget().

Returns:: The current preview widget, or 0

Since gtkmm 2.4:

Gtk::Widget* Gtk::FileChooser::get_preview_widget ( )

Gets the current preview widget; see set_preview_widget().

Returns:: The current preview widget, or 0

Since gtkmm 2.4:

bool Gtk::FileChooser::get_preview_widget_active ( ) const

Gets whether the preview widget set by set_preview_widget() should be shown for the current filename.

See set_preview_widget_active().

Returns:: true if the preview widget is active for the current filename.

Since gtkmm 2.4:

bool Gtk::FileChooser::get_select_multiple ( ) const

Gets whether multiple files can be selected in the file selector.

See set_select_multiple().

Returns:: true if multiple files can be selected.

Since gtkmm 2.4:

bool Gtk::FileChooser::get_show_hidden ( ) const

Gets whether hidden files and folders are displayed in the file selector.

See set_show_hidden().

Returns:: true if hidden files and folders are displayed.

Since gtkmm 2.6:

Glib::ustring Gtk::FileChooser::get_uri ( ) const

Gets the URI for the currently selected file in the file selector.

If multiple files are selected, one of the filenames will be returned at random.

If the file chooser is in folder mode, this function returns the selected folder.

Returns:: The currently selected URI, or an empty string if no file is selected.

Glib::SListHandle<Glib::ustring> Gtk::FileChooser::get_uris ( ) const

Lists all the selected files and subfolders in the current folder of chooser.

The returned names are full absolute URIs.

Returns:: A list containing the URIs of all selected files and subfolders in the current folder.

Since gtkmm 2.4:

bool Gtk::FileChooser::get_use_preview_label ( ) const

Gets whether a stock label should be drawn with the name of the previewed file.

See set_use_preview_label().

Returns:: true if the file chooser is set to display a label with the name of the previewed file, false otherwise.

const GtkFileChooser* Gtk::FileChooser::gobj ( ) const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gtk::FileChooserButton, Gtk::FileChooserDialog, and Gtk::FileChooserWidget.

References Glib::ValueBase::gobject_.

GtkFileChooser* Gtk::FileChooser::gobj ( ) [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gtk::FileChooserButton, Gtk::FileChooserDialog, and Gtk::FileChooserWidget.

References Glib::ValueBase::gobject_.

Glib::SListHandle<const FileFilter*> Gtk::FileChooser::list_filters ( ) const

Lists the current set of user-selectable filters; see add_filter(), remove_filter().

Returns:: A list containing the current set of user selectable filters.

Since gtkmm 2.4:

Glib::SListHandle<FileFilter*> Gtk::FileChooser::list_filters ( )

Lists the current set of user-selectable filters; see add_filter(), remove_filter().

Returns:: A list containing the current set of user selectable filters.

Since gtkmm 2.4:

Glib::SListHandle<Glib::ustring> Gtk::FileChooser::list_shortcut_folder_uris ( ) const

Queries the list of shortcut folders in the file chooser, as set by add_shortcut_folder_uri().

Returns:: A list of folder URIs

Since gtkmm 2.4:

Glib::SListHandle<Glib::ustring> Gtk::FileChooser::list_shortcut_folders ( ) const

Queries the list of shortcut folders in the file chooser, as set by add_shortcut_folder().

Since gtkmm 2.4:

Returns:: A list of folder filenames, if there are any shortcut folders..

Glib::PropertyProxy_ReadOnly<FileChooserAction> Gtk::FileChooser::property_action ( ) const