gtkmm 4.18.0
|
Sort by comparing strings. More...
#include <gtkmm/stringsorter.h>
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< StringSorter > | 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 | |
StringSorter (const Glib::RefPtr< Expression< Glib::ustring > > &expression) | |
![]() | |
Sorter () | |
virtual Ordering | compare_vfunc (gpointer item1, gpointer item2) |
virtual Order | get_order_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::StringSorter > | wrap (GtkStringSorter *object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
![]() | |
Glib::RefPtr< Gtk::Sorter > | wrap (GtkSorter *object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
Additional Inherited Members | |
![]() | |
enum class | Order { Order::PARTIAL , Order::NONE , Order::TOTAL } |
Describes the type of order that a Gtk::Sorter may produce. More... | |
enum class | Change { Change::DIFFERENT , Change::INVERTED , Change::LESS_STRICT , Change::MORE_STRICT } |
Describes changes in a sorter in more detail and allows users to optimize resorting. More... | |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
Sort by comparing strings.
Gtk::StringSorter is a Gtk::Sorter that compares strings. It does the comparison in a linguistically correct way using the current locale by normalizing Unicode strings and possibly case-folding them before performing the comparison.
To obtain the strings to compare, this sorter evaluates a Gtk::Expression.
|
noexcept |
|
overridenoexcept |
|
explicitprotected |
|
static |
Collation Gtk::StringSorter::get_collation | ( | ) | const |
Glib::RefPtr< Expression< Glib::ustring > > Gtk::StringSorter::get_expression | ( | ) |
Gets the expression that is evaluated to obtain strings from items.
Gtk::Expression
. Glib::RefPtr< const Expression< Glib::ustring > > Gtk::StringSorter::get_expression | ( | ) | const |
Gets the expression that is evaluated to obtain strings from items.
Gtk::Expression
. bool Gtk::StringSorter::get_ignore_case | ( | ) | const |
Gets whether the sorter ignores case differences.
true
if self is ignoring case differences.
|
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.
GtkStringSorter * Gtk::StringSorter::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< Collation > Gtk::StringSorter::property_collation | ( | ) |
The collation method to use for sorting.
The Gtk::Collation::NONE
value is useful when the expression already returns collation keys, or strings that need to be compared byte-by-byte.
The default value, Gtk::Collation::UNICODE
, compares strings according to the Unicode collation algorithm.
Default value: Gtk::Collation::UNICODE
Glib::PropertyProxy_ReadOnly< Collation > Gtk::StringSorter::property_collation | ( | ) | const |
The collation method to use for sorting.
The Gtk::Collation::NONE
value is useful when the expression already returns collation keys, or strings that need to be compared byte-by-byte.
The default value, Gtk::Collation::UNICODE
, compares strings according to the Unicode collation algorithm.
Default value: Gtk::Collation::UNICODE
Glib::PropertyProxy< Glib::RefPtr< Expression< Glib::ustring > > > Gtk::StringSorter::property_expression | ( | ) |
The expression to evaluate on item to get a string to compare with.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Expression< Glib::ustring > > > Gtk::StringSorter::property_expression | ( | ) | const |
The expression to evaluate on item to get a string to compare with.
Glib::PropertyProxy< bool > Gtk::StringSorter::property_ignore_case | ( | ) |
If sorting is case sensitive.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::StringSorter::property_ignore_case | ( | ) | const |
If sorting is case sensitive.
Default value: true
Sets the collation method to use for sorting.
collation | The collation method. |
void Gtk::StringSorter::set_expression | ( | const Glib::RefPtr< Expression< Glib::ustring > > & | expression | ) |
Sets the expression that is evaluated to obtain strings from items.
The expression must have the type G_TYPE_STRING.
expression | A Gtk::Expression . |
Sets whether the sorter will ignore case differences.
ignore_case | true to ignore case differences. |
|
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. |