glibmm 2.66.5
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gio::MenuLinkIter Class Reference

MenuLinkIter - A menu link iterator. More...

#include <giomm/menulinkiter.h>

Inheritance diagram for Gio::MenuLinkIter:
Inheritance graph
[legend]

Public Member Functions

 MenuLinkIter (MenuLinkIter && src) noexcept
 
MenuLinkIteroperator= (MenuLinkIter && src) noexcept
 
 ~MenuLinkIter () noexcept override
 
GMenuLinkIter * gobj ()
 Provides access to the underlying C GObject. More...
 
const GMenuLinkIter * gobj () const
 Provides access to the underlying C GObject. More...
 
GMenuLinkIter * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::ustring get_name () const
 Gets the name of the link at the current iterator position. More...
 
bool get_next (Glib::ustring & out_link, Glib::RefPtr< MenuModel > & value)
 This function combines g_menu_link_iter_next() with g_menu_link_iter_get_name() and g_menu_link_iter_get_value(). More...
 
Glib::RefPtr< MenuModelget_value ()
 Gets the linked MenuModel at the current iterator position. More...
 
Glib::RefPtr< const MenuModelget_value () const
 Gets the linked MenuModel at the current iterator position. More...
 
bool next ()
 Attempts to advance the iterator to the next (possibly first) link. More...
 
- 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)
 
- 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)
 You probably want to use a specific property_*() accessor method instead. More...
 
void get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const
 You probably want to use a specific property_*() accessor method instead. More...
 
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. More...
 
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. More...
 
void 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. More...
 
void connect_property_changed (const Glib::ustring & property_name, sigc::slot< void > && slot)
 You can use the signal_changed() signal of the property proxy instead. More...
 
sigc::connection connect_property_changed_with_return (const Glib::ustring & property_name, const sigc::slot< void > & slot)
 You can use the signal_changed() signal of the property proxy instead. More...
 
sigc::connection connect_property_changed_with_return (const Glib::ustring & property_name, sigc::slot< void > && slot)
 You can use the signal_changed() signal of the property proxy instead. More...
 
void freeze_notify ()
 Increases the freeze count on object. More...
 
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify(). More...
 
virtual void reference () const
 Increment the reference count for this object. More...
 
virtual void unreference () const
 Decrement the reference count for this object. More...
 
GObject * gobj ()
 Provides access to the underlying C GObject. More...
 
const GObject * gobj () const
 Provides access to the underlying C GObject. More...
 
GObject * gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access. More...
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

 MenuLinkIter ()
 
- 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. More...
 
 ObjectBase (const char * custom_type_name)
 A derived constructor always overrides this choice. More...
 
 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. More...
 
 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)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gio::MenuLinkIterwrap (GMenuLinkIter * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- Public Types inherited from Glib::Object
using DestroyNotify = void(*)(gpointer data)
 

Detailed Description

MenuLinkIter - A menu link iterator.

Since glibmm 2.32:

Constructor & Destructor Documentation

◆ MenuLinkIter() [1/2]

Gio::MenuLinkIter::MenuLinkIter ( MenuLinkIter &&  src)
noexcept

◆ ~MenuLinkIter()

Gio::MenuLinkIter::~MenuLinkIter ( )
overridenoexcept

◆ MenuLinkIter() [2/2]

Gio::MenuLinkIter::MenuLinkIter ( )
protected

Member Function Documentation

◆ get_name()

Glib::ustring Gio::MenuLinkIter::get_name ( ) const

Gets the name of the link at the current iterator position.

The iterator is not advanced.

Since glibmm 2.32:
Returns
The type of the link.

◆ get_next()

bool Gio::MenuLinkIter::get_next ( Glib::ustring out_link,
Glib::RefPtr< MenuModel > &  value 
)

This function combines g_menu_link_iter_next() with g_menu_link_iter_get_name() and g_menu_link_iter_get_value().

First the iterator is advanced to the next (possibly first) link. If that fails, then false is returned and there are no other effects.

If successful, out_link and value are set to the name and MenuModel of the link that has just been advanced to. At this point, g_menu_link_iter_get_name() and g_menu_link_iter_get_value() will return the same values again.

The value returned in out_link remains valid for as long as the iterator remains at the current position. The value returned in value must be unreffed using Glib::object_unref() when it is no longer in use.

Since glibmm 2.32:
Parameters
out_linkThe name of the link.
valueThe linked MenuModel.
Returns
true on success, or false if there is no additional link.

◆ get_type()

static GType Gio::MenuLinkIter::get_type ( )
static

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

◆ get_value() [1/2]

Glib::RefPtr< MenuModel > Gio::MenuLinkIter::get_value ( )

Gets the linked MenuModel at the current iterator position.

The iterator is not advanced.

Since glibmm 2.32:
Returns
The MenuModel that is linked to.

◆ get_value() [2/2]

Glib::RefPtr< const MenuModel > Gio::MenuLinkIter::get_value ( ) const

Gets the linked MenuModel at the current iterator position.

The iterator is not advanced.

Since glibmm 2.32:
Returns
The MenuModel that is linked to.

◆ gobj() [1/2]

GMenuLinkIter * Gio::MenuLinkIter::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GMenuLinkIter * Gio::MenuLinkIter::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GMenuLinkIter * Gio::MenuLinkIter::gobj_copy ( )

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

◆ next()

bool Gio::MenuLinkIter::next ( )

Attempts to advance the iterator to the next (possibly first) link.

true is returned on success, or false if there are no more links.

You must call this function when you first acquire the iterator to advance it to the first link (and determine if the first link exists at all).

Since glibmm 2.32:
Returns
true on success, or false when there are no more links.

◆ operator=()

MenuLinkIter & Gio::MenuLinkIter::operator= ( MenuLinkIter &&  src)
noexcept

Friends And Related Function Documentation

◆ wrap()

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