gtkmm: Gtk::MultiSorter Class Reference

Combining multiple sorters. More...

#include <gtkmm/multisorter.h>

Inheritance diagram for Gtk::MultiSorter:

Public Member Functions

 MultiSorter (MultiSorter&& src) noexcept
 
MultiSorteroperator= (MultiSorter&& src) noexcept
 
 ~MultiSorter () noexcept override
 
GtkMultiSorter* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkMultiSorter* gobj () const
 Provides access to the underlying C GObject. More...

 
GtkMultiSorter* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
void append (const Glib::RefPtr< Sorter >& sorter)
 Add sorter to self to use for sorting at the end. More...

 
void remove (guint position)
 Removes the sorter at the given position from the list of sorter used by self. More...

 
- Public Member Functions inherited from Gtk::Sorter
 Sorter (Sorter&& src) noexcept
 
Sorteroperator= (Sorter&& src) noexcept
 
 ~Sorter () noexcept override
 
GtkSorter* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkSorter* gobj () const
 Provides access to the underlying C GObject. More...

 
GtkSorter* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
Ordering compare (gpointer item1, gpointer item2)
 Compares two given items according to the sort order implemented by the sorter. More...

 
Order get_order () const
 Gets the order that self conforms to. More...

 
void changed (Change change)
 Emits the Gtk::Sorter::signal_changed() signal to notify all users of the sorter that it has changed. More...

 
Glib::SignalProxy< void(Change)> signal_changed ()
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (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::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (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 ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *data) const
 
- Public Member Functions inherited from Gio::ListModel
 ListModel (ListModel &&src) noexcept
 
ListModeloperator= (ListModel &&src) noexcept
 
 ~ListModel () noexcept override
 
GListModel * gobj ()
 
const GListModel * gobj () const
 
GType get_item_type () const
 
guint get_n_items () const
 
Glib::RefPtr< Glib::ObjectBaseget_object (guint position)
 
Glib::RefPtr< const Glib::ObjectBaseget_object (guint position) const
 
Glib::SignalProxy< void(guint, guint, guint)> signal_items_changed ()
 
Glib::RefPtr< Gio::ListModelwrap (GListModel *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 
 Interface (Interface &&src) noexcept
 
Interfaceoperator= (Interface &&src) noexcept
 
 Interface (const Glib::Interface_Class &interface_class)
 
 Interface (GObject *castitem)
 
 ~Interface () noexcept override
 
 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
GObject * gobj ()
 
const GObject * gobj () const
 
- Public Member Functions inherited from Gtk::Buildable
 Buildable (Buildable&& src) noexcept
 
Buildableoperator= (Buildable&& src) noexcept
 
 ~Buildable () noexcept override
 
GtkBuildable* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkBuildable* gobj () const
 Provides access to the underlying C GObject. More...

 
Glib::ustring get_buildable_id () const
 Gets the ID of the buildable object. More...

 

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< MultiSortercreate ()
 
- Static Public Member Functions inherited from Gtk::Sorter
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gio::ListModel
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 
- Static Public Member Functions inherited from Gtk::Buildable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 

Protected Member Functions

 MultiSorter ()
 
- Protected Member Functions inherited from Gtk::Sorter
 Sorter ()
 
virtual Ordering compare_vfunc (gpointer item1, gpointer item2)
 
virtual Order get_order_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
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 
- Protected Member Functions inherited from Gio::ListModel
 ListModel ()
 
void items_changed (guint position, guint removed, guint added)
 
virtual GType get_item_type_vfunc ()
 
virtual guint get_n_items_vfunc ()
 
virtual gpointer get_item_vfunc (guint position)
 
- Protected Member Functions inherited from Gtk::Buildable
 Buildable ()
 You should derive from this class to use it. More...

 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::MultiSorterwrap (GtkMultiSorter* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Additional Inherited Members

- Public Types inherited from Gtk::Sorter
enum  Order {

  Order::PARTIAL,

  Order::NONE,

  Order::TOTAL

}
 Describes the type of order that a Gtk::Sorter may describe. More...

 
enum  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...

 
- 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
 

Detailed Description

Combining multiple sorters.

Gtk::MultiSorter combines multiple sorters by trying them in turn. If the first sorter compares two items as equal, the second is tried next, and so on.

Since gtkmm 3.98:

Constructor & Destructor Documentation

Gtk::MultiSorter::MultiSorter ( MultiSorter&&  src)
noexcept
Gtk::MultiSorter::~MultiSorter ( )
overridenoexcept
Gtk::MultiSorter::MultiSorter ( )
protected

Member Function Documentation

void Gtk::MultiSorter::append ( const Glib::RefPtr< Sorter >&  sorter)

Add sorter to self to use for sorting at the end.

self will consult all existing sorters before it will sort with the given sorter.

Parameters
sorterA sorter to add.
static Glib::RefPtr<MultiSorter> Gtk::MultiSorter::create ( )
static
static GType Gtk::MultiSorter::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

GtkMultiSorter* Gtk::MultiSorter::gobj ( )
inline

Provides access to the underlying C GObject.

const GtkMultiSorter* Gtk::MultiSorter::gobj ( ) const
inline

Provides access to the underlying C GObject.

GtkMultiSorter* Gtk::MultiSorter::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

MultiSorter& Gtk::MultiSorter::operator= ( MultiSorter&&  src)
noexcept
void Gtk::MultiSorter::remove ( guint  position)

Removes the sorter at the given position from the list of sorter used by self.

If position is larger than the number of sorters, nothing happens.

Parameters
positionPosition of sorter to remove.

Friends And Related Function Documentation

Glib::RefPtr< Gtk::MultiSorter > wrap ( GtkMultiSorter *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse 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.