gtkmm: Gtk::MultiSelection Class Reference

A selection model that allows selecting multiple items. More...

#include <gtkmm/multiselection.h>

Inheritance diagram for Gtk::MultiSelection:

[legend]

Public Member Functions
	MultiSelection (MultiSelection &&src) noexcept

MultiSelection &	operator= (MultiSelection &&src) noexcept

	~MultiSelection () noexcept override

GtkMultiSelection *	gobj ()
	Provides access to the underlying C GObject.

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

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

Glib::RefPtr< Gio::ListModel >	get_model ()
	Returns the underlying model of self.

Glib::RefPtr< const Gio::ListModel >	get_model () const
	Returns the underlying model of self.

void	set_model (const Glib::RefPtr< Gio::ListModel > &model)
	Sets the model that self should wrap.

Glib::PropertyProxy_ReadOnly< GType >	property_item_type () const
	The type of items.

Glib::PropertyProxy< Glib::RefPtr< Gio::ListModel > >	property_model ()
	The list managed by this selection.

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::ListModel > >	property_model () const
	The list managed by this selection.

Glib::PropertyProxy_ReadOnly< unsigned int >	property_n_items () const
	The number of items.

Public Member Functions inherited from Gtk::SelectionModel
	SelectionModel (SelectionModel &&src) noexcept

SelectionModel &	operator= (SelectionModel &&src) noexcept

	~SelectionModel () noexcept override

GtkSelectionModel *	gobj ()
	Provides access to the underlying C GObject.

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

bool	is_selected (guint position) const
	Checks if the given item is selected.

Glib::RefPtr< const Bitset >	get_selection () const
	Gets the set containing all currently selected items in the model.

Glib::RefPtr< const Bitset >	get_selection (guint position, guint n_items) const
	Gets the set of selected items in a range.

bool	select_item (guint position, bool unselect_rest)
	Requests to select an item in the model.

bool	unselect_item (guint position)
	Requests to unselect an item in the model.

bool	select_range (guint position, guint n_items, bool unselect_rest)
	Requests to select a range of items in the model.

bool	unselect_range (guint position, guint n_items)
	Requests to unselect a range of items in the model.

bool	select_all ()
	Requests to select all items in the model.

bool	unselect_all ()
	Requests to unselect all items in the model.

bool	set_selection (const Glib::RefPtr< const Bitset > &selected, const Glib::RefPtr< const Bitset > &mask)
	Make selection changes.

Glib::SignalProxy< void(guint, guint)>	signal_selection_changed ()

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< MultiSelection >	create ()

static Glib::RefPtr< MultiSelection >	create (const Glib::RefPtr< Gio::ListModel > &model)

Static Public Member Functions inherited from Gtk::SelectionModel
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.

Protected Member Functions
	MultiSelection ()

	MultiSelection (const Glib::RefPtr< Gio::ListModel > &model)

Protected Member Functions inherited from Gtk::SelectionModel
	SelectionModel ()
	You should derive from this class to use it.

void	selection_changed (guint position, guint n_items)
	Helper function for implementations of `Gtk::SelectionModel`.

virtual bool	is_selected_vfunc (guint position) const

virtual Glib::RefPtr< const Bitset >	get_selection_vfunc (guint position, guint n_items)

virtual bool	select_item_vfunc (guint position, bool unselect_rest)

virtual bool	unselect_item_vfunc (guint position)

virtual bool	select_range_vfunc (guint position, guint n_items, bool unselect_rest)

virtual bool	unselect_range_vfunc (guint position, guint n_items)

virtual bool	select_all_vfunc ()

virtual bool	unselect_all_vfunc ()

virtual bool	set_selection_vfunc (const Glib::RefPtr< const Bitset > &selected, const Glib::RefPtr< const Bitset > &mask)

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gtk::MultiSelection >	wrap (GtkMultiSelection *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Related Symbols inherited from Gtk::SelectionModel
Glib::RefPtr< Gtk::SelectionModel >	wrap (GtkSelectionModel *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

A selection model that allows selecting multiple items.

Gtk::MultiSelection is an implementation of the Gtk::SelectionModel interface that allows selecting multiple elements.

See also: SelectionModel

Since gtkmm 3.98:

Constructor & Destructor Documentation

◆ MultiSelection() [1/3]

Gtk::MultiSelection::MultiSelection ( MultiSelection && src )

noexcept

◆ ~MultiSelection()

Gtk::MultiSelection::~MultiSelection ( )

overridenoexcept

◆ MultiSelection() [2/3]

Gtk::MultiSelection::MultiSelection ( )

protected

◆ MultiSelection() [3/3]

Gtk::MultiSelection::MultiSelection ( const Glib::RefPtr< Gio::ListModel > & model )

explicitprotected

Member Function Documentation

◆ create() [1/2]

static Glib::RefPtr< MultiSelection > Gtk::MultiSelection::create ( )

static

◆ create() [2/2]

static Glib::RefPtr< MultiSelection > Gtk::MultiSelection::create ( const Glib::RefPtr< Gio::ListModel > & model )

static

◆ get_model() [1/2]

Glib::RefPtr< Gio::ListModel > Gtk::MultiSelection::get_model ( )

Returns the underlying model of self.

Returns: The underlying model.

◆ get_model() [2/2]

Glib::RefPtr< const Gio::ListModel > Gtk::MultiSelection::get_model ( ) const

Returns the underlying model of self.

Returns: The underlying model.

◆ get_type()

static GType Gtk::MultiSelection::get_type ( )

static

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

◆ gobj() [1/2]

GtkMultiSelection * Gtk::MultiSelection::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkMultiSelection * Gtk::MultiSelection::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkMultiSelection * Gtk::MultiSelection::gobj_copy ( )

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

◆ operator=()

MultiSelection & Gtk::MultiSelection::operator= ( MultiSelection && src )

noexcept

◆ property_item_type()

Glib::PropertyProxy_ReadOnly< GType > Gtk::MultiSelection::property_item_type ( ) const

The type of items.

See Gio::ListModel::get_item_type().

Since gtkmm 4.8:

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_model() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gio::ListModel > > Gtk::MultiSelection::property_model ( )

The list managed by this selection.

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.

◆ property_model() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::ListModel > > Gtk::MultiSelection::property_model ( ) const

The list managed by this selection.

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_n_items()

Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::MultiSelection::property_n_items ( ) const

The number of items.

See Gio::ListModel::get_n_items().

Since gtkmm 4.8:

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.

◆ set_model()

void Gtk::MultiSelection::set_model ( const Glib::RefPtr< Gio::ListModel > & model )

Sets the model that self should wrap.

If model is nullptr, self will be empty.

Parameters

model A Gio::ListModel to wrap.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gtk::MultiSelection > wrap	(	GtkMultiSelection *	object,
		bool	take_copy = `false`
	)

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.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ MultiSelection() [1/3]

◆ ~MultiSelection()

◆ MultiSelection() [2/3]

◆ MultiSelection() [3/3]

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

◆ get_model() [1/2]

◆ get_model() [2/2]

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ operator=()

◆ property_item_type()

◆ property_model() [1/2]

◆ property_model() [2/2]

◆ property_n_items()

◆ set_model()

Friends And Related Symbol Documentation

◆ wrap()