Gtk::FileFilter Class Reference

Detailed Description
A filter for selecting a file subset.A Gtk::FileFilter can be used to restrict the files being shown in a Gtk::FileChooser. Files can be filtered based on their name (with add_pattern()), on their mime type (with add_mime_type()), or by a custom filter function (with add_custom()).
Filtering by mime types handles aliasing and subclassing of mime types; e.g. a filter for text/plain also matches a file with mime type application/rtf, since application/rtf is a subclass of text/plain. Note that Gtk::FileFilter allows wildcards for the subtype of a mime type, so you can e.g. filter for image/*.
Normally, filters are used by adding them to a Gtk::FileChooser. See Gtk::FileChooser::add_filter(). But it is also possible to manually use a filter on a file with filter().
Public Types | |
typedef sigc::slot< bool, const Info& > | SlotCustom |
For instance, bool on_custom(const Gtk::FileFilter::Info& filter_info);. | |
Public Member Functions | |
void | add_custom (FileFilterFlags needed, const SlotCustom& slot) |
void | add_mime_type (const Glib::ustring& mime_type) |
Adds a rule allowing a given mime type to filter. | |
void | add_pattern (const Glib::ustring& pattern) |
Adds a rule allowing a shell style glob to a filter. | |
void | add_pixbuf_formats () |
Adds a rule allowing image files in the formats supported by GdkPixbuf. | |
FileFilter () | |
Glib::ustring | get_name () const |
Gets the human-readable name for the filter. | |
FileFilterFlags | get_needed () const |
Gets the fields that need to be filled in for the structure passed to gtk_file_filter_filter(). | |
const GtkFileFilter* | gobj () const |
Provides access to the underlying C GtkObject. | |
GtkFileFilter* | gobj () |
Provides access to the underlying C GtkObject. | |
void | set_name (const Glib::ustring& name) |
Sets the human-readable name of the filter; this is the string that will be displayed in the file selector user interface if there is a selectable list of filters. | |
virtual | ~FileFilter () |
Related Functions | |
(Note that these are not member functions.) | |
Gtk::FileFilter* | wrap (GtkFileFilter* object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
Classes | |
class | Info |
Member Typedef Documentation
typedef sigc::slot<bool, const Info&> Gtk::FileFilter::SlotCustom |
For instance, bool on_custom(const Gtk::FileFilter::Info& filter_info);.
Constructor & Destructor Documentation
virtual Gtk::FileFilter::~FileFilter | ( | ) | [virtual] |
Gtk::FileFilter::FileFilter | ( | ) |
Member Function Documentation
void Gtk::FileFilter::add_custom | ( | FileFilterFlags | needed, | |
const SlotCustom& | slot | |||
) |
void Gtk::FileFilter::add_mime_type | ( | const Glib::ustring & | mime_type | ) |
Adds a rule allowing a given mime type to filter.
- Parameters:
-
mime_type Name of a MIME type.
void Gtk::FileFilter::add_pattern | ( | const Glib::ustring & | pattern | ) |
Adds a rule allowing a shell style glob to a filter.
- Parameters:
-
pattern A shell style glob.
void Gtk::FileFilter::add_pixbuf_formats | ( | ) |
Glib::ustring Gtk::FileFilter::get_name | ( | ) | const |
Gets the human-readable name for the filter.
See gtk_file_filter_set_name().
- Returns:
- The human-readable name of the filter, or
0
. This value is owned by GTK+ and must not be modified or freed.
FileFilterFlags Gtk::FileFilter::get_needed | ( | ) | const |
Gets the fields that need to be filled in for the structure passed to gtk_file_filter_filter().
This function will not typically be used by applications; it is intended principally for use in the implementation of Gtk::FileChooser.
- Returns:
- Bitfield of flags indicating needed fields when calling gtk_file_filter_filter()
const GtkFileFilter* Gtk::FileFilter::gobj | ( | ) | const [inline] |
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::Object.
References Glib::ValueBase::gobject_.
GtkFileFilter* Gtk::FileFilter::gobj | ( | ) | [inline] |
Provides access to the underlying C GtkObject.
Reimplemented from Gtk::Object.
References Glib::ValueBase::gobject_.
void Gtk::FileFilter::set_name | ( | const Glib::ustring & | name | ) |
Sets the human-readable name of the filter; this is the string that will be displayed in the file selector user interface if there is a selectable list of filters.
- Parameters:
-
name The human-readable-name for the filter, or 0
to remove any existing name.
Friends And Related Function Documentation
Gtk::FileFilter* wrap | ( | GtkFileFilter * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
- Parameters:
-
object The C instance. take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
- Returns:
- A C++ instance that wraps this C instance.
The documentation for this class was generated from the following file: