gtkmm 4.18.0
|
Filtering by strings. More...
#include <gtkmm/stringfilter.h>
Public Types | |
enum class | MatchMode { MatchMode::EXACT , MatchMode::SUBSTRING , MatchMode::PREFIX } |
Specifies how search strings are matched inside text. More... | |
![]() | |
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. | |
static Glib::RefPtr< StringFilter > | create (const Glib::RefPtr< Expression< Glib::ustring > > &expression) |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
Protected Member Functions | |
StringFilter (const Glib::RefPtr< Expression< Glib::ustring > > &expression) | |
![]() | |
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::StringFilter > | wrap (GtkStringFilter *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. | |
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.
|
noexcept |
|
overridenoexcept |
|
explicitprotected |
|
static |
Glib::RefPtr< Expression< Glib::ustring > > Gtk::StringFilter::get_expression | ( | ) |
Gets the expression that the string filter uses to obtain strings from items.
Glib::RefPtr< const Expression< Glib::ustring > > Gtk::StringFilter::get_expression | ( | ) | const |
Gets the expression that the string filter uses to obtain strings from items.
bool Gtk::StringFilter::get_ignore_case | ( | ) | const |
Returns whether the filter ignores case differences.
MatchMode Gtk::StringFilter::get_match_mode | ( | ) | const |
Returns the match mode that the filter is using.
Glib::ustring Gtk::StringFilter::get_search | ( | ) | const |
Gets the search term.
|
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 each item to get a string to compare with.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Expression< Glib::ustring > > > Gtk::StringFilter::property_expression | ( | ) | const |
The expression to evaluate on each item to get a string to compare with.
Glib::PropertyProxy< bool > Gtk::StringFilter::property_ignore_case | ( | ) |
If matching is case sensitive.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::StringFilter::property_ignore_case | ( | ) | const |
If matching is case sensitive.
Default value: true
Glib::PropertyProxy< MatchMode > Gtk::StringFilter::property_match_mode | ( | ) |
If exact matches are necessary or if substrings are allowed.
Default value: Gtk::StringFilter::MatchMode::SUBSTRING
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
Glib::PropertyProxy< Glib::ustring > Gtk::StringFilter::property_search | ( | ) |
The search term.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::StringFilter::property_search | ( | ) | const |
The search term.
Default value: ""
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
.
expression | The expression. |
Sets whether the filter ignores case differences.
ignore_case | True to ignore case. |
Sets the match mode for the filter.
mode | The new match mode. |
void Gtk::StringFilter::set_search | ( | const Glib::ustring & | search | ) |
Sets the string to search for.
search | The string to search for. |
|
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. |