gtkmm 4.10.0
|
A filter for selecting a file subset. More...
#include <gtkmm/filefilter.h>
Public Member Functions | |
FileFilter (FileFilter && src) noexcept | |
FileFilter & | operator= (FileFilter && src) noexcept |
~FileFilter () noexcept override | |
GtkFileFilter * | gobj () |
Provides access to the underlying C GObject. | |
const GtkFileFilter * | gobj () const |
Provides access to the underlying C GObject. | |
GtkFileFilter * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | set_name (const Glib::ustring & name) |
Sets a human-readable name of the filter. | |
Glib::ustring | get_name () const |
Gets the human-readable name for the filter. | |
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_suffix (const std::string & suffix) |
Adds a suffix match rule to a filter. | |
void | add_pixbuf_formats () |
Adds a rule allowing image files in the formats supported by GdkPixbuf. | |
Glib::PropertyProxy< Glib::ustring > | property_name () |
The human-readable name of the filter. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
The human-readable name of the filter. | |
![]() | |
Filter (Filter && src) noexcept | |
Filter & | operator= (Filter && src) noexcept |
~Filter () noexcept override | |
GtkFilter * | gobj () |
Provides access to the underlying C GObject. | |
const GtkFilter * | gobj () const |
Provides access to the underlying C GObject. | |
GtkFilter * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
bool | match (const Glib::RefPtr< Glib::ObjectBase > & item) |
Checks if the given item is matched by the filter or not. | |
Match | get_strictness () |
Gets the known strictness of filters. | |
Glib::SignalProxy< void(Change)> | signal_changed () |
![]() | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (Object &&src) noexcept |
void * | get_data (const QueryQuark &key) |
void | set_data (const Quark &key, void *data) |
void | set_data (const Quark &key, void *data, DestroyNotify notify) |
void | remove_data (const QueryQuark &quark) |
void * | steal_data (const QueryQuark &quark) |
Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
![]() | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (const ObjectBase &)=delete |
void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value) |
void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot) |
void | freeze_notify () |
void | thaw_notify () |
virtual void | reference () const |
virtual void | unreference () const |
GObject * | gobj () |
const GObject * | gobj () const |
GObject * | gobj_copy () const |
![]() | |
Buildable (Buildable && src) noexcept | |
Buildable & | operator= (Buildable && src) noexcept |
~Buildable () noexcept override | |
GtkBuildable * | gobj () |
Provides access to the underlying C GObject. | |
const GtkBuildable * | gobj () const |
Provides access to the underlying C GObject. | |
Glib::ustring | get_buildable_id () const |
Gets the ID of the buildable object. | |
![]() | |
Interface () | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexcept override | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
static Glib::RefPtr< FileFilter > | create () |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
![]() | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
Protected Member Functions | |
FileFilter () | |
![]() | |
Filter () | |
void | changed (Change change=Change::DIFFERENT) |
Notifies all users of the filter that it has changed. | |
virtual bool | match_vfunc (const Glib::RefPtr< Glib::ObjectBase > & item) |
virtual Match | get_strictness_vfunc () |
![]() | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
![]() | |
ObjectBase () | |
ObjectBase (const char *custom_type_name) | |
ObjectBase (const std::type_info &custom_type_info) | |
ObjectBase (ObjectBase &&src) noexcept | |
ObjectBase & | operator= (ObjectBase &&src) noexcept |
virtual | ~ObjectBase () noexcept=0 |
void | initialize (GObject *castitem) |
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
![]() | |
Buildable () | |
You should derive from this class to use it. | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gtk::FileFilter > | wrap (GtkFileFilter * object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
![]() | |
Glib::RefPtr< Gtk::Filter > | wrap (GtkFilter * object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
![]() | |
Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable * object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
Additional Inherited Members | |
![]() | |
enum class | Match { Match::SOME , Match::NONE , Match::ALL } |
Describes the known strictness of a filter. More... | |
enum class | Change { Change::DIFFERENT , Change::LESS_STRICT , Change::MORE_STRICT } |
Describes changes in a filter in more detail and allows objects using the filter to optimize refiltering items. More... | |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
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/ *
.
Filters are used by adding them to a Gtk::FileChooser. See Gtk::FileChooser::add_filter().
|
noexcept |
|
overridenoexcept |
|
protected |
void Gtk::FileFilter::add_mime_type | ( | const Glib::ustring & | mime_type | ) |
Adds a rule allowing a given mime type to filter.
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.
Note that it depends on the platform whether pattern matching ignores case or not. On Windows, it does, on other platforms, it doesn't.
pattern | A shell style glob. |
void Gtk::FileFilter::add_pixbuf_formats | ( | ) |
Adds a rule allowing image files in the formats supported by GdkPixbuf.
This is equivalent to calling add_mime_type() for all the supported mime types.
void Gtk::FileFilter::add_suffix | ( | const std::string & | suffix | ) |
Adds a suffix match rule to a filter.
This is similar to adding a match for the pattern "*. @a suffix".
In contrast to pattern matches, suffix matches are always case-insensitive.
suffix | Filename suffix to match. |
|
static |
Glib::ustring Gtk::FileFilter::get_name | ( | ) | const |
Gets the human-readable name for the filter.
See set_name().
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GtkFileFilter * Gtk::FileFilter::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
noexcept |
Glib::PropertyProxy< Glib::ustring > Gtk::FileFilter::property_name | ( | ) |
The human-readable name of the filter.
This is the string that will be displayed in the file chooser user interface if there is a selectable list of filters.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::FileFilter::property_name | ( | ) | const |
The human-readable name of the filter.
This is the string that will be displayed in the file chooser user interface if there is a selectable list of filters.
Default value: ""
void Gtk::FileFilter::set_name | ( | const Glib::ustring & | name | ) |
Sets a human-readable name of the filter.
This is the string that will be displayed in the file chooser if there is a selectable list of filters.
name | The human-readable-name for the filter, or nullptr to remove any existing name. |
|
related |
A Glib::wrap() method for this object.
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. |