gtkmm 4.17.0
|
Filtering items. More...
#include <gtkmm/filter.h>
Public Types | |
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) |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
Protected Member Functions | |
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) |
Related Symbols | |
(Note that these are not member symbols.) | |
Glib::RefPtr< Gtk::Filter > | wrap (GtkFilter *object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
Filtering items.
A Gtk::Filter object describes the filtering to be performed by a Gtk::FilterListModel.
The model will use the filter to determine if it should include items or not by calling match() for each item and only keeping the ones that the function returns true
for.
Filters may change what items they match through their lifetime. In that case, they will emit the signal_changed() signal to notify that previous filter results are no longer valid and that items should be checked again via match().
GTK provides various pre-made filter implementations for common filtering operations. These filters often include properties that can be linked to various widgets to easily allow searches.
However, in particular for large lists or complex search methods, it is also possible to subclass Gtk::Filter and provide one's own filter.
|
noexcept |
|
overridenoexcept |
|
protected |
|
protected |
Notifies all users of the filter that it has changed.
This emits the signal_changed() signal. Users of the filter should then check items again via match().
Depending on the change parameter, not all items need to be changed, but only some. Refer to the Gtk::Filter::Change documentation for details.
This function is intended for implementers of Gtk::Filter
subclasses and should not be called from other functions.
change | How the filter changed. |
Match Gtk::Filter::get_strictness | ( | ) |
Gets the known strictness of a filter.
If the strictness is not known, [enum@.nosp@m.Gtk..nosp@m.Filte.nosp@m.rMat.nosp@m.ch.so.nosp@m.me] is returned.
This value may change after emission of the signal_changed() signal.
This function is meant purely for optimization purposes. Filters can choose to omit implementing it, but Gtk::FilterListModel
uses it.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
GtkFilter * Gtk::Filter::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gtk::Filter::match | ( | const Glib::RefPtr< Glib::ObjectBase > & | item | ) |
Checks if the given item is matched by the filter or not.
item | The item to check. |
|
protectedvirtual |
void on_my_changed(Change change)
Flags: Run Last
Emitted whenever the filter changed.
Users of the filter should then check items again via Gtk::Filter::match().
Gtk::FilterListModel
handles this signal automatically.
Depending on the change parameter, not all items need to be checked, but only some. Refer to the Gtk::Filter::Change documentation for details.
change | How the filter changed. |
|
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. |