gtkmm: Gtk::StringFilter Class Reference
Filtering by strings. More...
#include <gtkmm/stringfilter.h>
Public Types | |
enum | MatchMode { MatchMode::EXACT, MatchMode::SUBSTRING, MatchMode::PREFIX } |
Specifies how search strings are matched inside text. More... | |
Public Types inherited from Gtk::Filter | |
enum | Match { Match::SOME, Match::NONE, Match::ALL } |
Describes the known strictness of a filter. More... | |
enum | 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... | |
Public Types inherited from Glib::Object | |
typedef void(*)(gpointer data | DestroyNotify) |
Public Types inherited from sigc::trackable | |
typedef internal::func_destroy_notify | func_destroy_notify |
Public Types inherited from sigc::notifiable | |
typedef internal::func_destroy_notify | func_destroy_notify |
Public Member Functions | |
StringFilter (StringFilter&& src) noexcept | |
StringFilter& | operator= (StringFilter&& src) noexcept |
~StringFilter () noexcept override | |
GtkStringFilter* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkStringFilter* | gobj () const |
Provides access to the underlying C GObject. More... | |
GtkStringFilter* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
Glib::ustring | get_search () const |
Gets the search string set via set_search(). More... | |
void | set_search (const Glib::ustring&search) |
Sets the string to search for. More... | |
Glib::RefPtr< Expression< Glib::ustring > > | get_expression () |
Gets the expression that the string filter uses to obtain strings from items. More... | |
Glib::RefPtr< const Expression< Glib::ustring > > | get_expression () const |
Gets the expression that the string filter uses to obtain strings from items. More... | |
void | set_expression (const Glib::RefPtr< Expression< Glib::ustring >>& expression) |
Sets the expression that the string filter uses to obtain strings from items. More... | |
bool | get_ignore_case () const |
Returns whether the filter ignores case differences. More... | |
void | set_ignore_case (bool ignore_case=true) |
Sets whether the filter ignores case differences. More... | |
MatchMode | get_match_mode () const |
Returns the match mode that the filter is using. More... | |
void | set_match_mode (MatchMode mode) |
Sets the match mode for the filter. More... | |
Glib::PropertyProxy< Glib::RefPtr< Expression< Glib::ustring > > > | property_expression () |
The expression to evaluate on item to get a string to compare with. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Expression< Glib::ustring > > > | property_expression () const |
The expression to evaluate on item to get a string to compare with. More... | |
Glib::PropertyProxy< bool > | property_ignore_case () |
If matching is case sensitive. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_ignore_case () const |
If matching is case sensitive. More... | |
Glib::PropertyProxy< MatchMode > | property_match_mode () |
If exact matches are necessary or if substrings are allowed. More... | |
Glib::PropertyProxy_ReadOnly< MatchMode > | property_match_mode () const |
If exact matches are necessary or if substrings are allowed. More... | |
Glib::PropertyProxy< Glib::ustring > | property_search () |
The search term. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_search () const |
The search term. 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 Glib::Object | |
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) |
Public Member Functions inherited from Glib::ObjectBase | |
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 |
Public Member Functions inherited from sigc::trackable | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) noexcept | |
~trackable () | |
void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) noexcept |
void | remove_destroy_notify_callback (notifiable *data) const |
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< StringFilter > | create (const Glib::RefPtr< Expression< Glib::ustring >>& expression) |
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... | |
Protected Member Functions | |
StringFilter (const Glib::RefPtr< Expression< Glib::ustring >>& expression) | |
Protected Member Functions inherited from Gtk::Filter | |
Filter () | |
void | changed (Change change=Change::DIFFERENT) |
Emits the Gtk::Filter::signal_changed() signal to notify all users of the filter that the filter changed. More... | |
virtual bool | match_vfunc (const Glib::RefPtr< Glib::ObjectBase >& item) |
virtual Match | get_strictness_vfunc () |
Protected Member Functions inherited from Glib::Object | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
Protected Member Functions inherited from Glib::ObjectBase | |
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 Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gtk::StringFilter > | wrap (GtkStringFilter* 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... | |
Detailed Description
Filtering by strings.
Gtk::StringFilter determines whether to include items by looking at strings and comparing them to a fixed search term. The strings are obtained from the items by evaluating a Gtk::Expression.
Gtk::StringFilter has several different modes of comparison - it can match the whole string, just a prefix, or any substring.
Constructor & Destructor Documentation
|
noexcept |
|
overridenoexcept |
|
explicitprotected |
Member Function Documentation
|
static |
Glib::RefPtr<Expression<Glib::ustring> > Gtk::StringFilter::get_expression | ( | ) |
Gets the expression that the string filter uses to obtain strings from items.
- Returns
- A Gtk::Expression.
Glib::RefPtr<const Expression<Glib::ustring> > Gtk::StringFilter::get_expression | ( | ) | const |
Gets the expression that the string filter uses to obtain strings from items.
- Returns
- A Gtk::Expression.
bool Gtk::StringFilter::get_ignore_case | ( | ) | const |
Returns whether the filter ignores case differences.
- Returns
true
if the filter ignores case.
MatchMode Gtk::StringFilter::get_match_mode | ( | ) | const |
Returns the match mode that the filter is using.
- Returns
- The match mode of the filter.
Glib::ustring Gtk::StringFilter::get_search | ( | ) | const |
Gets the search string set via set_search().
- Returns
- The search string.
|
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.
GtkStringFilter* Gtk::StringFilter::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::RefPtr<Expression<Glib::ustring> > > Gtk::StringFilter::property_expression | ( | ) |
The expression to evaluate on item to get a string to compare with.
- 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.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Expression<Glib::ustring> > > Gtk::StringFilter::property_expression | ( | ) | const |
The expression to evaluate on item to get a string to compare with.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::StringFilter::property_ignore_case | ( | ) |
If matching is case sensitive.
Default value: true
- 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.
Glib::PropertyProxy_ReadOnly< bool > Gtk::StringFilter::property_ignore_case | ( | ) | const |
If matching is case sensitive.
Default value: true
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< MatchMode > Gtk::StringFilter::property_match_mode | ( | ) |
If exact matches are necessary or if substrings are allowed.
Default value: Gtk::StringFilter::MatchMode::SUBSTRING
- 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.
Glib::PropertyProxy_ReadOnly< MatchMode > Gtk::StringFilter::property_match_mode | ( | ) | const |
If exact matches are necessary or if substrings are allowed.
Default value: Gtk::StringFilter::MatchMode::SUBSTRING
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::StringFilter::property_search | ( | ) |
The search term.
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.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::StringFilter::property_search | ( | ) | const |
The search term.
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.
void Gtk::StringFilter::set_expression | ( | const Glib::RefPtr< Expression< Glib::ustring >>& | expression | ) |
Sets the expression that the string filter uses to obtain strings from items.
The expression must have a value type of G_TYPE_STRING.
- Parameters
-
expression A Gtk::Expression.
void Gtk::StringFilter::set_ignore_case | ( | bool | ignore_case = true | ) |
Sets whether the filter ignores case differences.
- Parameters
-
ignore_case true
to ignore case.
void Gtk::StringFilter::set_match_mode | ( | MatchMode | mode | ) |
Sets the match mode for the filter.
- Parameters
-
mode The new match mode.
void Gtk::StringFilter::set_search | ( | const Glib::ustring & | search | ) |
Sets the string to search for.
- Parameters
-
search The string to search for or nullptr
to clear the search.
Friends And Related Function Documentation
|
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.