glibmm 2.82.0
|
MenuAttributeIter - A menu attribute iterator. More...
#include <giomm/menuattributeiter.h>
Public Member Functions | |
MenuAttributeIter (MenuAttributeIter &&src) noexcept | |
MenuAttributeIter & | operator= (MenuAttributeIter &&src) noexcept |
~MenuAttributeIter () noexcept override | |
GMenuAttributeIter * | gobj () |
Provides access to the underlying C GObject. | |
const GMenuAttributeIter * | gobj () const |
Provides access to the underlying C GObject. | |
GMenuAttributeIter * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
bool | get_next (Glib::ustring &out_name, Glib::VariantBase & value) |
This function combines g_menu_attribute_iter_next() with g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value(). | |
Glib::ustring | get_name () const |
Gets the name of the attribute at the current iterator position, as a string. | |
Glib::VariantBase | get_value () const |
Gets the value of the attribute at the current iterator position. | |
bool | next () |
Attempts to advance the iterator to the next (possibly first) attribute. | |
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. | |
Protected Member Functions | |
MenuAttributeIter () | |
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::MenuAttributeIter > | wrap (GMenuAttributeIter *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 Glib::Object | |
using | DestroyNotify = void(*)(gpointer data) |
MenuAttributeIter - A menu attribute iterator.
|
noexcept |
|
overridenoexcept |
|
protected |
Glib::ustring Gio::MenuAttributeIter::get_name | ( | ) | const |
Gets the name of the attribute at the current iterator position, as a string.
The iterator is not advanced.
bool Gio::MenuAttributeIter::get_next | ( | Glib::ustring & | out_name, |
Glib::VariantBase & | value | ||
) |
This function combines g_menu_attribute_iter_next() with g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value().
First the iterator is advanced to the next (possibly first) attribute. If that fails, then false
is returned and there are no other effects.
If successful, name and value are set to the name and value of the attribute that has just been advanced to. At this point, g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value() will return the same values again.
The value returned in name remains valid for as long as the iterator remains at the current position. The value returned in value must be unreffed using Glib::variant_unref() when it is no longer in use.
out_name | The type of the attribute. |
value | The attribute value. |
true
on success, or false
if there is no additional attribute. Get the GType for this class, for use with the underlying GObject type system.
Glib::VariantBase Gio::MenuAttributeIter::get_value | ( | ) | const |
Gets the value of the attribute at the current iterator position.
The iterator is not advanced.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GMenuAttributeIter * Gio::MenuAttributeIter::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gio::MenuAttributeIter::next | ( | ) |
Attempts to advance the iterator to the next (possibly first) attribute.
true
is returned on success, or false
if there are no more attributes.
You must call this function when you first acquire the iterator to advance it to the first attribute (and determine if the first attribute exists at all).
true
on success, or false
when there are no more attributes.
|
noexcept |
|
related |
A Glib::wrap() method for this object.
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. |