glibmm 2.66.10

Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Symbols | List of all members
Gio::DBus::ActionGroup Class Reference

ActionGroup - A D-Bus Gio::ActionGroup implementation. More...

`#include <giomm/dbusactiongroup.h>`

Inheritance diagram for Gio::DBus::ActionGroup:
[legend]

## Public Member Functions
| ActionGroup (ActionGroup && src) noexcept
ActionGroup & | operator= (ActionGroup && src) noexcept
| ~ActionGroup () noexcept override
GDBusActionGroup * | gobj ()
| Provides access to the underlying C GObject.
const GDBusActionGroup * | gobj () const
| Provides access to the underlying C GObject.
GDBusActionGroup * | gobj_copy ()
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
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 (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
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.
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.
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.
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.
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.
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.
Public Member Functions inherited from sigc::trackable
| trackable () noexcept
| trackable (const trackable &src) noexcept
| trackable (trackable &&src)
| ~trackable ()
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const
void | notify_callbacks ()
trackable & | operator= (const trackable &src)
trackable & | operator= (trackable &&src)
void | remove_destroy_notify_callback (void *data) const
Public Member Functions inherited from Gio::ActionGroup
| ActionGroup (ActionGroup && src) noexcept
ActionGroup & | operator= (ActionGroup && src) noexcept
| ~ActionGroup () noexcept override
GActionGroup * | gobj ()
| Provides access to the underlying C GObject.
const GActionGroup * | gobj () const
| Provides access to the underlying C GObject.
bool | has_action (const Glib::ustring & action_name) const
| Checks if the named action exists within action_group.
std::vector< Glib::ustring > | list_actions () const
| Lists the actions contained within action_group.
bool | query_action (const Glib::ustring & action_name, bool & enabled, Glib::VariantType & parameter_type, Glib::VariantBase & state_hint, Glib::VariantType & state_type, Glib::VariantBase & state)
| Queries all aspects of the named action within an action_group.
bool | query_action (const Glib::ustring & action_name, bool & enabled, Glib::VariantType & parameter_type, Glib::VariantBase & state_hint, Glib::VariantType & state_type)
| A query_action() convenience overload.
bool | query_action (const Glib::ustring & action_name, bool & enabled, Glib::VariantType & parameter_type, Glib::VariantBase & state_hint, Glib::VariantBase & state)
| A query_action() convenience overload.
bool | query_action (const Glib::ustring & action_name, bool & enabled, Glib::VariantType & parameter_type, Glib::VariantBase & state_hint)
| A query_action() convenience overload.
bool | query_action (const Glib::ustring & action_name, bool & enabled, Glib::VariantBase & state_hint, Glib::VariantType & state_type, Glib::VariantBase & state)
| A query_action() convenience overload.
bool | query_action (const Glib::ustring & action_name, bool & enabled, Glib::VariantBase & state_hint, Glib::VariantType & state_type)
| A query_action() convenience overload.
bool | query_action (const Glib::ustring & action_name, bool & enabled, Glib::VariantBase & state_hint, Glib::VariantBase & state)
| A query_action() convenience overload.
bool | query_action (const Glib::ustring & action_name, bool & enabled, Glib::VariantBase & state_hint)
| A query_action() convenience overload.
bool | get_action_enabled (const Glib::ustring & action_name) const
| Checks if the named action within action_group is currently enabled.
Glib::VariantType | get_action_parameter_type (const Glib::ustring & action_name) const
| Queries the type of the parameter that must be given when activating the named action within action_group.
Glib::VariantType | get_action_state_type (const Glib::ustring & action_name) const
| Queries the type of the state of the named action within action_group.
Glib::VariantContainerBase | get_action_state_hint (const Glib::ustring & action_name) const
| Requests a hint about the valid range of values for the state of the named action within action_group.
template<typename T_Value>
void | get_action_state_hint (const Glib::ustring & action_name, T_Value & value) const
| Requests a hint about the valid range of values for the state of the named action within the action group.
Glib::VariantContainerBase | get_action_state_hint_variant (const Glib::ustring & action_name) const
| Requests a hint about the valid range of values for the state of the named action within action_group.
Glib::VariantBase | get_action_state (const Glib::ustring & action_name) const
| Queries the current state of the named action within action_group.
template<typename T_Value>
void | get_action_state (const Glib::ustring & action_name, T_Value & value) const
| Queries the current state of the named action within the action group.
Glib::VariantBase | get_action_state_variant (const Glib::ustring & action_name) const
| Queries the current state of the named action within action_group.
void | change_action_state (const Glib::ustring & action_name, const Glib::VariantBase & value)
| Request for the state of the named action within action_group to be changed to value.
void | activate_action (const Glib::ustring & action_name, const Glib::VariantBase & parameter)
| Activate the named action within action_group.
void | activate_action (const Glib::ustring & action_name)
| A activate_action() convenience overload.
void | action_added (const Glib::ustring & action_name)
| Emits the ActionGroup::signal_action_added() signal on action_group.
void | action_removed (const Glib::ustring & action_name)
| Emits the ActionGroup::signal_action_removed() signal on action_group.
void | action_enabled_changed (const Glib::ustring & action_name, bool enabled)
| Emits the ActionGroup::signal_action_enabled_changed() signal on action_group.
void | action_state_changed (const Glib::ustring & action_name, const Glib::VariantBase & state)
| Emits the ActionGroup::signal_action_state_changed() signal on action_group.
Glib::SignalProxy< void, const Glib::ustring & > | signal_action_added ()
Glib::SignalProxyDetailedAnyType< void, const Glib::ustring & > | signal_action_added (const Glib::ustring & action_name)
Glib::SignalProxy< void, const Glib::ustring &, bool > | signal_action_enabled_changed ()
Glib::SignalProxyDetailedAnyType< void, const Glib::ustring &, bool > | signal_action_enabled_changed (const Glib::ustring & action_name)
Glib::SignalProxy< void, const Glib::ustring & > | signal_action_removed ()
Glib::SignalProxyDetailedAnyType< void, const Glib::ustring & > | signal_action_removed (const Glib::ustring & action_name)
Glib::SignalProxy< void, const Glib::ustring &, const Glib::VariantBase & > | signal_action_state_changed ()
Glib::SignalProxyDetailedAnyType< void, const Glib::ustring &, const Glib::VariantBase & > | signal_action_state_changed (const Glib::ustring & action_name)
virtual bool | has_action_vfunc (const Glib::ustring & name) const
virtual std::vector< Glib::ustring > | list_actions_vfunc () const
virtual bool | get_action_enabled_vfunc (const Glib::ustring & name) const
virtual Glib::VariantType | get_action_parameter_type_vfunc (const Glib::ustring & name) const
virtual Glib::VariantType | get_action_state_type_vfunc (const Glib::ustring & name) const
virtual Glib::VariantBase | get_action_state_hint_vfunc (const Glib::ustring & name) const
virtual Glib::VariantBase | get_action_state_vfunc (const Glib::ustring & name) const
virtual void | change_action_state_vfunc (const Glib::ustring & name, const Glib::VariantBase & value)
virtual void | activate_action_vfunc (const Glib::ustring & name, const Glib::VariantBase & parameter)
Public Member Functions inherited from Glib::Interface
| Interface ()
| A Default constructor.
| Interface (Interface && src) noexcept
Interface & | operator= (Interface && src) noexcept
| Interface (const Glib::Interface_Class & interface_class)
| Called by constructors of derived classes.
| Interface (GObject * castitem)
| Called by constructors of derived classes.
| ~Interface () noexcept override
| Interface (const Interface &)=delete
Interface & | operator= (const Interface &)=delete
GObject * | gobj ()
const GObject * | gobj () const
Public Member Functions inherited from Gio::RemoteActionGroup
| RemoteActionGroup (RemoteActionGroup && src) noexcept
RemoteActionGroup & | operator= (RemoteActionGroup && src) noexcept
| ~RemoteActionGroup () noexcept override
GRemoteActionGroup * | gobj ()
| Provides access to the underlying C GObject.
const GRemoteActionGroup * | gobj () const
| Provides access to the underlying C GObject.
void | activate_action (const Glib::ustring & action_name, const Glib::VariantBase & parameter, const Glib::VariantBase & platform_data)
| Activates the remote action.
void | change_action_state (const Glib::ustring & action_name, const Glib::VariantBase & value, const Glib::VariantBase & platform_data)
| Changes the state of a remote action.
virtual void | activate_action_vfunc (const Glib::ustring & action_name, const Glib::VariantBase & parameter, const Glib::VariantBase & platform_data)
virtual void | change_action_state_vfunc (const Glib::ustring & action_name, const Glib::VariantBase & value, const Glib::VariantBase & platform_data)

## 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< ActionGroup > | get (const Glib::RefPtr< Connection > & connection, const Glib::ustring & bus_name, const Glib::ustring & object_path)
| Obtains a DBusActionGroup for the action group which is exported at the given bus_name and object_path.
Static Public Member Functions inherited from Gio::ActionGroup
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.
Static Public Member Functions inherited from Gio::RemoteActionGroup
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
| ActionGroup ()
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)
Protected Member Functions inherited from Gio::ActionGroup
| ActionGroup ()
| You should derive from this class to use it.
virtual void | on_action_added (const Glib::ustring & action_name)
| This is a default handler for the signal signal_action_added().
virtual void | on_action_enabled_changed (const Glib::ustring & action_name, bool enabled)
| This is a default handler for the signal signal_action_enabled_changed().
virtual void | on_action_removed (const Glib::ustring & action_name)
| This is a default handler for the signal signal_action_removed().
virtual void | on_action_state_changed (const Glib::ustring & action_name, const Glib::VariantBase & value)
| This is a default handler for the signal signal_action_state_changed().
Protected Member Functions inherited from Gio::RemoteActionGroup
| RemoteActionGroup ()
| You should derive from this class to use it.

## Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gio::DBus::ActionGroup > | wrap (GDBusActionGroup * 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)
Related Symbols inherited from Gio::ActionGroup
Glib::RefPtr< Gio::ActionGroup > | wrap (GActionGroup * object, bool take_copy=false)
| A Glib::wrap() method for this object.
Related Symbols inherited from Gio::RemoteActionGroup
Glib::RefPtr< Gio::RemoteActionGroup > | wrap (GRemoteActionGroup * object, bool take_copy=false)
| A Glib::wrap() method for this object.

## Additional Inherited Members
Public Types inherited from Glib::Object
using | DestroyNotify = void (*)(gpointer data)
Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify | func_destroy_notify

## Detailed Description

ActionGroup - A D-Bus Gio::ActionGroup implementation.

ActionGroup is an implementation of the Gio::ActionGroup interface that can be used as a proxy for an action group that is exported over D-Bus with Gio::DBus::Connection::export_action_group().

Since glibmm 2.32

## Constructor & Destructor Documentation

## ◆ ActionGroup() [1/2]

Gio::DBus::ActionGroup::ActionGroup | ( | ActionGroup && | src | ) |
| noexcept

## ◆ ~ActionGroup()

Gio::DBus::ActionGroup::~ActionGroup | ( |  | ) |
| override noexcept

## ◆ ActionGroup() [2/2]

Gio::DBus::ActionGroup::ActionGroup | ( |  | ) |
| protected

## Member Function Documentation

## ◆ get()

Glib::RefPtr< ActionGroup > Gio::DBus::ActionGroup::get | ( | const Glib::RefPtr< Connection > & | connection,
|  | const Glib::ustring & | bus_name,
|  | const Glib::ustring & | object_path )
| static

Obtains a DBusActionGroup for the action group which is exported at the given bus_name and object_path.

The thread default main context is taken at the time of this call. All signals on the menu model (and any linked models) are reported with respect to this context. All calls on the returned menu model (and linked models) must also originate from this same context, with the thread default main context unchanged.

This call is non-blocking. The returned action group may or may not already be filled in. The correct thing to do is connect the signals for the action group to monitor for changes and then to call g_action_group_list_actions() to get the initial list.

Since glibmm 2.32

Parameters

  connection | A DBusConnection.
  bus_name | The bus name which exports the action group or nullptr if connection is not a message bus connection.
  object_path | The object path at which the action group is exported.

Returns
  A DBusActionGroup.

## ◆ get_type()

GType Gio::DBus::ActionGroup::get_type | ( |  | ) |
| static

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

## ◆ gobj() [1/2]

GDBusActionGroup * Gio::DBus::ActionGroup::gobj | ( |  | ) |
| inline

Provides access to the underlying C GObject.

## ◆ gobj() [2/2]

const GDBusActionGroup * Gio::DBus::ActionGroup::gobj | ( |  | ) | const
| inline

Provides access to the underlying C GObject.

## ◆ gobj_copy()

GDBusActionGroup * Gio::DBus::ActionGroup::gobj_copy | ( |  | ) |

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

## ◆ operator=()

ActionGroup & Gio::DBus::ActionGroup::operator= | ( | ActionGroup && | src | ) |
| noexcept

## Friends And Related Symbol Documentation

## ◆ wrap()

Glib::RefPtr< Gio::DBus::ActionGroup > wrap | ( | GDBusActionGroup * | 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.