Gio::Menu Class Reference

A simple implementation of MenuModel. More...

#include <giomm/menu.h>

Inheritance diagram for Gio::Menu:

Public Member Functions
	Menu (Menu &&src) noexcept
Menu &	operator= (Menu &&src) noexcept
	~Menu () noexcept override
GMenu *	gobj ()
	Provides access to the underlying C GObject.
const GMenu *	gobj () const
	Provides access to the underlying C GObject.
GMenu *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void	freeze ()
	Marks menu as frozen.
void	insert_item (int position, const Glib::RefPtr< const MenuItem > &item)
	Inserts item into menu.
void	prepend_item (const Glib::RefPtr< const MenuItem > &item)
	Prepends item to the start of menu.
void	append_item (const Glib::RefPtr< const MenuItem > &item)
	Appends item to the end of menu.
void	remove (int position)
	Removes an item from the menu.
void	remove_all ()
	Removes all items in the menu.
void	insert (int position, const Glib::ustring &label, const Glib::ustring &detailed_action)
	Convenience function for inserting a normal menu item into menu.
void	insert (int position, const Glib::ustring &label)
	A insert() convenience overload.
void	prepend (const Glib::ustring &label, const Glib::ustring &detailed_action)
	Convenience function for prepending a normal menu item to the start of menu.
void	prepend (const Glib::ustring &label)
	A prepend() convenience overload.
void	append (const Glib::ustring &label, const Glib::ustring &detailed_action)
	Convenience function for appending a normal menu item to the end of menu.
void	append (const Glib::ustring &label)
	A append() convenience overload.
void	insert_section (int position, const Glib::ustring &label, const Glib::RefPtr< MenuModel > &section)
	Convenience function for inserting a section menu item into menu.
void	insert_section (int position, const Glib::RefPtr< MenuModel > &section)
	A insert_section() convenience overload.
void	prepend_section (const Glib::ustring &label, const Glib::RefPtr< MenuModel > &section)
	Convenience function for prepending a section menu item to the start of menu.
void	prepend_section (const Glib::RefPtr< MenuModel > &section)
	A prepend_section() convenience overload.
void	append_section (const Glib::ustring &label, const Glib::RefPtr< MenuModel > &section)
	Convenience function for appending a section menu item to the end of menu.
void	append_section (const Glib::RefPtr< MenuModel > &section)
	A append_section() convenience overload.
void	insert_submenu (int position, const Glib::ustring &label, const Glib::RefPtr< MenuModel > &submenu)
	Convenience function for inserting a submenu menu item into menu.
void	prepend_submenu (const Glib::ustring &label, const Glib::RefPtr< MenuModel > &submenu)
	Convenience function for prepending a submenu menu item to the start of menu.
void	append_submenu (const Glib::ustring &label, const Glib::RefPtr< MenuModel > &submenu)
	Convenience function for appending a submenu menu item to the end of menu.
Public Member Functions inherited from Gio::MenuModel
	MenuModel (MenuModel &&src) noexcept
MenuModel &	operator= (MenuModel &&src) noexcept
	~MenuModel () noexcept override
GMenuModel *	gobj ()
	Provides access to the underlying C GObject.
const GMenuModel *	gobj () const
	Provides access to the underlying C GObject.
GMenuModel *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::VariantBase	get_item_attribute (int item_index, Attribute attribute, const Glib::VariantType &expected_type) const
	Queries the item at position item_index in model for the attribute specified by attribute.
Glib::RefPtr< MenuModel >	get_item_link (int item_index, Link link)
	Queries the item at position item_index in model for the link specified by link.
Glib::RefPtr< const MenuModel >	get_item_link (int item_index, Link link) const
	Queries the item at position item_index in model for the link specified by link.
bool	is_mutable () const
	Queries if model is mutable.
int	get_n_items () const
	Query the number of items in model.
Glib::RefPtr< MenuAttributeIter >	iterate_item_attributes (int item_index)
	Creates a MenuAttributeIter to iterate over the attributes of the item at position item_index in model.
Glib::RefPtr< const MenuAttributeIter >	iterate_item_attributes (int item_index) const
	Creates a MenuAttributeIter to iterate over the attributes of the item at position item_index in model.
Glib::RefPtr< MenuLinkIter >	iterate_item_links (int item_index)
	Creates a MenuLinkIter to iterate over the links of the item at position item_index in model.
Glib::RefPtr< const MenuLinkIter >	iterate_item_links (int item_index) const
	Creates a MenuLinkIter to iterate over the links of the item at position item_index in model.
void	items_changed (int position, int removed, int added)
	Requests emission of the MenuModel::signal_items_changed() signal on model.
Glib::SignalProxy< void(int, int, int)>	signal_items_changed ()
Public Member Functions inherited from Glib::Object
	Object (const Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&src) noexcept
Object &	operator= (Object &&src) noexcept
void *	get_data (const QueryQuark & key)
void	set_data (const Quark & key, void *data)
void	set_data_with_c_callback (const Quark & key, void *data, GDestroyNotify notify)
void	set_data (const Quark & key, void *data, DestroyNotify notify)
	Prefer set_data_with_c_callback() with a callback with C linkage.
void	remove_data (const QueryQuark &quark)
void *	steal_data (const QueryQuark &quark)
Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete
ObjectBase &	operator= (const ObjectBase &)=delete
void	set_property_value (const Glib::ustring & property_name, const Glib::ValueBase & value)
	You probably want to use a specific property_*() accessor method instead.
void	get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const
	You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
void	set_property (const Glib::ustring & property_name, const PropertyType & value)
	You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
void	get_property (const Glib::ustring & property_name, PropertyType & value) const
	You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
PropertyType	get_property (const Glib::ustring & property_name) const
	You probably want to use a specific property_*() accessor method instead.
sigc::connection	connect_property_changed (const Glib::ustring & property_name, const sigc::slot< void()> &slot)
	You can use the signal_changed() signal of the property proxy instead.
sigc::connection	connect_property_changed (const Glib::ustring & property_name, sigc::slot< void()> &&slot)
	You can use the signal_changed() signal of the property proxy instead.
void	freeze_notify ()
	Increases the freeze count on object.
void	thaw_notify ()
	Reverts the effect of a previous call to freeze_notify().
virtual void	reference () const
	Increment the reference count for this object.
virtual void	unreference () const
	Decrement the reference count for this object.
GObject *	gobj ()
	Provides access to the underlying C GObject.
const GObject *	gobj () const
	Provides access to the underlying C GObject.
GObject *	gobj_copy () const
	Give a ref-ed copy to someone. Use for direct struct access.

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

Protected Member Functions
	Menu ()
Protected Member Functions inherited from Gio::MenuModel
	MenuModel ()
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 ()
	This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor.
	ObjectBase (const char *custom_type_name)
	A derived constructor always overrides this choice.
	ObjectBase (const std::type_info &custom_type_info)
	This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually.
	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< Gio::Menu >	wrap (GMenu *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gio::MenuModel
Glib::RefPtr< Gio::MenuModel >	wrap (GMenuModel *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Glib::Object
Glib::RefPtr< Glib::Object >	wrap (GObject *object, bool take_copy=false)

Additional Inherited Members
Public Types inherited from Gio::MenuModel
enum class	Attribute {   Attribute::ACTION ,   Attribute::LABEL ,   Attribute::TARGET ,   Attribute::ACTION_NAMESPACE ,   Attribute::ICON }
	Attributes in Gio::MenuModel::get_item_attribute(). More...
enum class	Link {   Link::SECTION ,   Link::SUBMENU }
	Link types in Gio::MenuModel::get_item_link(). More...
Public Types inherited from Glib::Object
using	DestroyNotify = void(*)(gpointer data)

Detailed Description

A simple implementation of MenuModel.

You populate a Menu by adding MenuItem instances to it.

There are some convenience methods to allow you to directly add items (avoiding MenuItem) for the common cases. To add a regular item, use insert(). To add a section, use insert_section(). To add a submenu, use insert_submenu().

Since glibmm 2.32:

Constructor & Destructor Documentation

Menu() [1/2]

Gio::Menu::Menu ( Menu &&  src )

noexcept

~Menu()

Gio::Menu::~Menu ( )

overridenoexcept

Menu() [2/2]

Gio::Menu::Menu ( )

protected

Member Function Documentation

append() [1/2]

void Gio::Menu::append

(

const Glib::ustring &

label

)

A append() convenience overload.

append() [2/2]

void Gio::Menu::append	(	const Glib::ustring &	label,
		const Glib::ustring &	detailed_action
	)

Convenience function for appending a normal menu item to the end of menu.

Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative.

Since glibmm 2.32:

Parameters

label	The section label, or nullptr.
detailed_action	The detailed action string, or nullptr.

append_item()

void Gio::Menu::append_item

(

const Glib::RefPtr< const MenuItem > &

item

)

Appends item to the end of menu.

See g_menu_insert_item() for more information.

Since glibmm 2.32:

Parameters

item	A MenuItem to append.

append_section() [1/2]

void Gio::Menu::append_section

(

const Glib::RefPtr< MenuModel > &

section

)

A append_section() convenience overload.

append_section() [2/2]

void Gio::Menu::append_section	(	const Glib::ustring &	label,
		const Glib::RefPtr< MenuModel > &	section
	)

Convenience function for appending a section menu item to the end of menu.

Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative.

Since glibmm 2.32:

Parameters

label	The section label, or nullptr.
section	A MenuModel with the items of the section.

append_submenu()

void Gio::Menu::append_submenu	(	const Glib::ustring &	label,
		const Glib::RefPtr< MenuModel > &	submenu
	)

Convenience function for appending a submenu menu item to the end of menu.

Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative.

Since glibmm 2.32:

Parameters

label	The section label, or nullptr.
submenu	A MenuModel with the items of the submenu.

create()

static Glib::RefPtr< Menu > Gio::Menu::create ( )

static

freeze()

void Gio::Menu::freeze

(

)

Marks menu as frozen.

After the menu is frozen, it is an error to attempt to make any changes to it. In effect this means that the Menu API must no longer be used.

This function causes g_menu_model_is_mutable() to begin returning false, which has some positive performance implications.

Since glibmm 2.32:

get_type()

static GType Gio::Menu::get_type ( )

static

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

gobj() [1/2]

GMenu * Gio::Menu::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

const GMenu * Gio::Menu::gobj ( ) const

inline

Provides access to the underlying C GObject.

gobj_copy()

GMenu * Gio::Menu::gobj_copy

(

)

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

insert() [1/2]

void Gio::Menu::insert	(	int	position,
		const Glib::ustring &	label
	)

A insert() convenience overload.

insert() [2/2]

void Gio::Menu::insert	(	int	position,
		const Glib::ustring &	label,
		const Glib::ustring &	detailed_action
	)

Convenience function for inserting a normal menu item into menu.

Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative.

Since glibmm 2.32:

Parameters

position	The position at which to insert the item.
label	The section label, or nullptr.
detailed_action	The detailed action string, or nullptr.

insert_item()

void Gio::Menu::insert_item	(	int	position,
		const Glib::RefPtr< const MenuItem > &	item
	)

Inserts item into menu.

The "insertion" is actually done by copying all of the attribute and link values of item and using them to form a new item within menu. As such, item itself is not really inserted, but rather, a menu item that is exactly the same as the one presently described by item.

This means that item is essentially useless after the insertion occurs. Any changes you make to it are ignored unless it is inserted again (at which point its updated values will be copied).

You should probably just free item once you're done.

There are many convenience functions to take care of common cases. See g_menu_insert(), g_menu_insert_section() and g_menu_insert_submenu() as well as "prepend" and "append" variants of each of these functions.

Since glibmm 2.32:

Parameters

position	The position at which to insert the item.
item	The MenuItem to insert.

insert_section() [1/2]

void Gio::Menu::insert_section	(	int	position,
		const Glib::RefPtr< MenuModel > &	section
	)

A insert_section() convenience overload.

insert_section() [2/2]

void Gio::Menu::insert_section	(	int	position,
		const Glib::ustring &	label,
		const Glib::RefPtr< MenuModel > &	section
	)

Convenience function for inserting a section menu item into menu.

Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative.

Since glibmm 2.32:

Parameters

position	The position at which to insert the item.
label	The section label, or nullptr.
section	A MenuModel with the items of the section.

insert_submenu()

void Gio::Menu::insert_submenu	(	int	position,
		const Glib::ustring &	label,
		const Glib::RefPtr< MenuModel > &	submenu
	)

Convenience function for inserting a submenu menu item into menu.

Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative.

Since glibmm 2.32:

Parameters

position	The position at which to insert the item.
label	The section label, or nullptr.
submenu	A MenuModel with the items of the submenu.

operator=()

Menu & Gio::Menu::operator= ( Menu &&  src )

noexcept

prepend() [1/2]

void Gio::Menu::prepend

(

const Glib::ustring &

label

)

A prepend() convenience overload.

prepend() [2/2]

void Gio::Menu::prepend	(	const Glib::ustring &	label,
		const Glib::ustring &	detailed_action
	)

Convenience function for prepending a normal menu item to the start of menu.

Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative.

Since glibmm 2.32:

Parameters

label	The section label, or nullptr.
detailed_action	The detailed action string, or nullptr.

prepend_item()

void Gio::Menu::prepend_item

(

const Glib::RefPtr< const MenuItem > &

item

)

Prepends item to the start of menu.

See g_menu_insert_item() for more information.

Since glibmm 2.32:

Parameters

item	A MenuItem to prepend.

prepend_section() [1/2]

void Gio::Menu::prepend_section

(

const Glib::RefPtr< MenuModel > &

section

)

A prepend_section() convenience overload.

prepend_section() [2/2]

void Gio::Menu::prepend_section	(	const Glib::ustring &	label,
		const Glib::RefPtr< MenuModel > &	section
	)

Convenience function for prepending a section menu item to the start of menu.

Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative.

Since glibmm 2.32:

Parameters

label	The section label, or nullptr.
section	A MenuModel with the items of the section.

prepend_submenu()

void Gio::Menu::prepend_submenu	(	const Glib::ustring &	label,
		const Glib::RefPtr< MenuModel > &	submenu
	)

Convenience function for prepending a submenu menu item to the start of menu.

Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative.

Since glibmm 2.32:

Parameters

label	The section label, or nullptr.
submenu	A MenuModel with the items of the submenu.

remove()

void Gio::Menu::remove

(

int

position

)

Removes an item from the menu.

position gives the index of the item to remove.

It is an error if position is not in range the range from 0 to one less than the number of items in the menu.

It is not possible to remove items by identity since items are added to the menu simply by copying their links and attributes (ie: identity of the item itself is not preserved).

Since glibmm 2.32:

Parameters

position

The position of the item to remove.

remove_all()

void Gio::Menu::remove_all

(

)

Removes all items in the menu.

Since glibmm 2.38:

Friends And Related Symbol Documentation

wrap()

Glib::RefPtr< Gio::Menu > wrap ( GMenu *  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.