A list model that filters its items.
More...
#include <gtkmm/filterlistmodel.h>
Inherits Object, and ListModel.
|
static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More...
|
|
static Glib::RefPtr< FilterListModel > | create (const Glib::RefPtr< Gio::ListModel >& model, const Glib::RefPtr< Filter >& filter) |
|
A list model that filters its items.
Gtk::FilterListModel is a list model that filters a given other listmodel. It hides some elements from the other model according to criteria given by a Gtk::Filter.
The model can be set up to do incremental searching, so that filtering long lists doesn't block the UI. See set_incremental() for details.
- See also
- Gio::ListModel, Gtk::Filter
- Since gtkmm 3.98:
Gtk::FilterListModel::~FilterListModel |
( |
| ) |
|
|
overridenoexcept |
Gtk::FilterListModel::FilterListModel |
( |
const Glib::RefPtr< Gio::ListModel > & |
model, |
|
|
const Glib::RefPtr< Filter >& |
filter |
|
) |
| |
|
explicitprotected |
static Glib::RefPtr<FilterListModel> Gtk::FilterListModel::create |
( |
const Glib::RefPtr< Gio::ListModel > & |
model, |
|
|
const Glib::RefPtr< Filter >& |
filter |
|
) |
| |
|
static |
Glib::RefPtr<Filter> Gtk::FilterListModel::get_filter |
( |
| ) |
|
Gets the GtkFilter
currently set on self.
- Returns
- The filter currently in use.
Glib::RefPtr<const Filter> Gtk::FilterListModel::get_filter |
( |
| ) |
const |
Gets the GtkFilter
currently set on self.
- Returns
- The filter currently in use.
bool Gtk::FilterListModel::get_incremental |
( |
| ) |
const |
Glib::RefPtr<Gio::ListModel> Gtk::FilterListModel::get_model |
( |
| ) |
|
Gets the model currently filtered or nullptr
if none.
- Returns
- The model that gets filtered.
Glib::RefPtr<const Gio::ListModel> Gtk::FilterListModel::get_model |
( |
| ) |
const |
Gets the model currently filtered or nullptr
if none.
- Returns
- The model that gets filtered.
guint Gtk::FilterListModel::get_pending |
( |
| ) |
const |
Returns the number of items that have not been filtered yet.
You can use this value to check if self is busy filtering by comparing the return value to 0 or you can compute the percentage of the filter remaining by dividing the return value by the total number of items in the underlying model:
static GType Gtk::FilterListModel::get_type |
( |
| ) |
|
|
static |
Get the GType for this class, for use with the underlying GObject type system.
GtkFilterListModel* Gtk::FilterListModel::gobj |
( |
| ) |
|
|
inline |
Provides access to the underlying C GObject.
const GtkFilterListModel* Gtk::FilterListModel::gobj |
( |
| ) |
const |
|
inline |
Provides access to the underlying C GObject.
GtkFilterListModel* Gtk::FilterListModel::gobj_copy |
( |
| ) |
|
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy< Glib::RefPtr<Filter> > Gtk::FilterListModel::property_filter |
( |
| ) |
|
The filter for this model.
- 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<Filter> > Gtk::FilterListModel::property_filter |
( |
| ) |
const |
The filter for this model.
- 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::FilterListModel::property_incremental |
( |
| ) |
|
If the model should filter items incrementally.
Default value: false
- 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::FilterListModel::property_incremental |
( |
| ) |
const |
If the model should filter items incrementally.
Default value: false
- 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::RefPtr<Gio::ListModel> > Gtk::FilterListModel::property_model |
( |
| ) |
|
The model being filtered.
- 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<Gio::ListModel> > Gtk::FilterListModel::property_model |
( |
| ) |
const |
The model being filtered.
- 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_ReadOnly< guint > Gtk::FilterListModel::property_pending |
( |
| ) |
const |
Number of items not yet filtered.
Default value: 0
- 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::FilterListModel::set_filter |
( |
const Glib::RefPtr< Filter >& |
filter | ) |
|
Sets the filter used to filter items.
- Parameters
-
void Gtk::FilterListModel::set_incremental |
( |
bool |
incremental = true | ) |
|
Sets the filter model to do an incremental sort.
When incremental filtering is enabled, the GtkFilterListModel
will not run filters immediately, but will instead queue an idle handler that incrementally filters the items and adds them to the list. This of course means that items are not instantly added to the list, but only appear incrementally.
When your filter blocks the UI while filtering, you might consider turning this on. Depending on your model and filters, this may become interesting around 10,000 to 100,000 items.
By default, incremental filtering is disabled.
See [method Gtk.FilterListModel.get_pending] for progress information about an ongoing incremental filtering operation.
- Parameters
-
incremental | true to enable incremental filtering. |
void Gtk::FilterListModel::set_model |
( |
const Glib::RefPtr< Gio::ListModel > & |
model | ) |
|
Sets the model to be filtered.
Note that GTK makes no effort to ensure that model conforms to the item type of self. It assumes that the caller knows what they are doing and have set up an appropriate filter to ensure that item types match.
- Parameters
-
model | The model to be filtered. |
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.