Gtk::EnumList Class Reference

A Gio::ListModel representing values of a given enum. More...

#include <gtkmm/enumlist.h>

Inheritance diagram for Gtk::EnumList:

Public Member Functions
	EnumList (EnumList && src) noexcept
EnumList &	operator= (EnumList && src) noexcept
	~EnumList () noexcept override
GtkEnumList *	gobj ()
	Provides access to the underlying C GObject.
const GtkEnumList *	gobj () const
	Provides access to the underlying C GObject.
GtkEnumList *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GType	get_enum_type () const
	Gets the type of the enum represented by self.
unsigned int	find (int value) const
	Finds the position of a given enum value in this EnumList.
Glib::PropertyProxy_ReadOnly< GType >	property_enum_type () const
	The type of the enum represented by the model.
Glib::PropertyProxy_ReadOnly< GType >	property_item_type () const
	The type of the items.
Glib::PropertyProxy_ReadOnly< unsigned int >	property_n_items () const
	The number of items.

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< EnumList >	create (GType enum_type)
	Creates a new Gtk::EnumList for enum_type.

Protected Member Functions
	EnumList (GType enum_type)

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

Detailed Description

A Gio::ListModel representing values of a given enum.

Gtk::EnumList contains objects of type Gtk::EnumListItem.

A simple way to use a Gtk::EnumList is to populate a Gtk::DropDown widget using the short name (or "nick") of the values of an enumeration type:

GType enum_type = Glib::Value<Gtk::Justification>::value_type(); // an example
Glib::RefPtr<Gtk::EnumList> enum_list = Gtk::EnumList::create(enum_type);
Glib::RefPtr<Gtk::PropertyExpression> expression =
  Gtk::PropertyExpression::create(Gtk::EnumListItem::get_type(), "nick");
Gtk::DropDown* drop_down = Gtk::make_managed<Gtk::DropDown>(enum_list, expression);

All variables in the code snippet can be declared auto. The full types are shown to make it clear what they are.

See also

Gio::ListModel

Since gtkmm 4.24

Constructor & Destructor Documentation

EnumList() [1/2]

Gtk::EnumList::EnumList ( EnumList && src )

noexcept

~EnumList()

Gtk::EnumList::~EnumList ( )

overridenoexcept

EnumList() [2/2]

Gtk::EnumList::EnumList ( GType enum_type )

explicitprotected

Member Function Documentation

create()

Glib::RefPtr< EnumList > Gtk::EnumList::create ( GType enum_type )

static

Creates a new Gtk::EnumList for enum_type.

Since gtkmm 4.24

Parameters

enum_type

The type of the enum to construct the model from.

Returns

The newly created Gtk::EnumList.

find()

unsigned int Gtk::EnumList::find

(

int

value

)

const

Finds the position of a given enum value in this EnumList.

If the value is not found, GTK_INVALID_LIST_POSITION is returned.

Since gtkmm 4.24

Parameters

value

An enum value. If the enum is an enum class, use static_cast<int>(value) to convert the value to an int.

Returns

The position of the value.

get_enum_type()

GType Gtk::EnumList::get_enum_type

(

)

const

Gets the type of the enum represented by self.

Since gtkmm 4.24

Returns

The enum type.

get_type()

GType Gtk::EnumList::get_type ( )

static

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

gobj() [1/2]

GtkEnumList * Gtk::EnumList::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

const GtkEnumList * Gtk::EnumList::gobj ( ) const

inline

Provides access to the underlying C GObject.

gobj_copy()

GtkEnumList * Gtk::EnumList::gobj_copy

(

)

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

operator=()

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

noexcept

property_enum_type()

Glib::PropertyProxy_ReadOnly< GType > Gtk::EnumList::property_enum_type

(

)

const

The type of the enum represented by the model.

Since gtkmm 4.24

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_item_type()

Glib::PropertyProxy_ReadOnly< GType > Gtk::EnumList::property_item_type

(

)

const

The type of the items.

See Gio::ListModel::get_item_type().

Since gtkmm 4.24

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::EnumList::property_n_items

(

)

const

The number of items.

See Gio::ListModel::get_n_items().

Since gtkmm 4.24

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.

Friends And Related Symbol Documentation

wrap()

Glib::RefPtr< Gtk::EnumList > wrap ( GtkEnumList * object, bool take_copy = false )

related

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.