gtkmm: Gtk::FileFilter Class Reference

A filter for selecting a file subset. More...

#include <gtkmm/filefilter.h>

Inheritance diagram for Gtk::FileFilter:

[legend]

Public Member Functions
	FileFilter (FileFilter && src) noexcept

FileFilter &	operator= (FileFilter && src) noexcept

	~FileFilter () noexcept override

GtkFileFilter *	gobj ()
	Provides access to the underlying C GObject. More...

const GtkFileFilter *	gobj () const
	Provides access to the underlying C GObject. More...

GtkFileFilter *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

void	set_name (const Glib::ustring & name)
	Sets a human-readable name of the filter. More...

Glib::ustring	get_name () const
	Gets the human-readable name for the filter. More...

void	add_mime_type (const Glib::ustring & mime_type)
	Adds a rule allowing a given mime type to filter. More...

void	add_pattern (const Glib::ustring & pattern)
	Adds a rule allowing a shell style glob to a filter. More...

void	add_suffix (const std::string & suffix)
	Adds a suffix match rule to a filter. More...

void	add_pixbuf_formats ()
	Adds a rule allowing image files in the formats supported by GdkPixbuf. More...

Glib::PropertyProxy< Glib::ustring >	property_name ()
	The human-readable name of the filter. More...

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_name () const
	The human-readable name of the filter. More...

Public Member Functions inherited from Gtk::Filter
	Filter (Filter && src) noexcept

Filter &	operator= (Filter && src) noexcept

	~Filter () noexcept override

GtkFilter *	gobj ()
	Provides access to the underlying C GObject. More...

const GtkFilter *	gobj () const
	Provides access to the underlying C GObject. More...

GtkFilter *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

bool	match (const Glib::RefPtr< Glib::ObjectBase > & item)
	Checks if the given item is matched by the filter or not. More...

Match	get_strictness ()
	Gets the known strictness of filters. More...

Glib::SignalProxy< void(Change)>	signal_changed ()

Public Member Functions inherited from Gtk::Buildable
	Buildable (Buildable && src) noexcept

Buildable &	operator= (Buildable && src) noexcept

	~Buildable () noexcept override

GtkBuildable *	gobj ()
	Provides access to the underlying C GObject. More...

const GtkBuildable *	gobj () const
	Provides access to the underlying C GObject. More...

Glib::ustring	get_buildable_id () const
	Gets the ID of the buildable object. More...

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< FileFilter >	create ()

Static Public Member Functions inherited from Gtk::Filter
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Static Public Member Functions inherited from Gtk::Buildable
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. More...

Protected Member Functions
	FileFilter ()

Protected Member Functions inherited from Gtk::Filter
	Filter ()

void	changed (Change change=Change::DIFFERENT)
	Notifies all users of the filter that it has changed. More...

virtual bool	match_vfunc (const Glib::RefPtr< Glib::ObjectBase > & item)

virtual Match	get_strictness_vfunc ()

Protected Member Functions inherited from Gtk::Buildable
	Buildable ()
	You should derive from this class to use it. More...

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. More...

Related Functions inherited from Gtk::Filter
Glib::RefPtr< Gtk::Filter >	wrap (GtkFilter * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gtk::Buildable
Glib::RefPtr< Gtk::Buildable >	wrap (GtkBuildable * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Additional Inherited Members
Public Types inherited from Gtk::Filter
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...

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/ *.

Filters are used by adding them to a Gtk::FileChooser. See Gtk::FileChooser::add_filter().

Constructor & Destructor Documentation

◆ FileFilter() [1/2]

Gtk::FileFilter::FileFilter ( FileFilter && src )

noexcept

◆ ~FileFilter()

Gtk::FileFilter::~FileFilter ( )

overridenoexcept

◆ FileFilter() [2/2]

Gtk::FileFilter::FileFilter ( )

protected

Member Function Documentation

◆ add_mime_type()

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.

◆ add_pattern()

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.

Parameters

pattern A shell style glob.

◆ add_pixbuf_formats()

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.

◆ add_suffix()

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.

Since gtkmm 4.4:

Parameters

suffix Filename suffix to match.

◆ create()

static Glib::RefPtr< FileFilter > Gtk::FileFilter::create ( )

static

◆ get_name()

Glib::ustring Gtk::FileFilter::get_name ( ) const

Gets the human-readable name for the filter.

See set_name().

Returns: The human-readable name of the filter.

◆ get_type()

static GType Gtk::FileFilter::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GtkFileFilter * Gtk::FileFilter::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkFileFilter * Gtk::FileFilter::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

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.

◆ operator=()

FileFilter & Gtk::FileFilter::operator= ( FileFilter && src )

noexcept

◆ property_name() [1/2]

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: ""

Returns: A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_name() [2/2]

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: ""

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ set_name()

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.

Parameters

name	The human-readable-name for the filter, or `nullptr` to remove any existing name.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::FileFilter > wrap	(	GtkFileFilter *	object,
		bool	take_copy = `false`
	)

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.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileFilter() [1/2]

◆ ~FileFilter()

◆ FileFilter() [2/2]

Member Function Documentation

◆ add_mime_type()

◆ add_pattern()

◆ add_pixbuf_formats()

◆ add_suffix()

◆ create()

◆ get_name()

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ operator=()

◆ property_name() [1/2]

◆ property_name() [2/2]

◆ set_name()

Friends And Related Function Documentation

◆ wrap()