glibmm 2.34.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

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

ActionGroup - a group of actions. More...

`#include <giomm/actiongroup.h>`

Inheritance diagram for Gio::ActionGroup:
[legend]

## Public Member Functions
virtual | ~ActionGroup ()
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.
Glib::VariantBase | get_action_state (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 | 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::SignalProxy1< void, const Glib::ustring& > | signal_action_added ()
Glib::SignalProxy2< void, const Glib::ustring&, bool > | signal_action_enabled_changed ()
Glib::SignalProxy1< void, const Glib::ustring& > | signal_action_removed ()
Glib::SignalProxy2< void, const Glib::ustring&, const Glib::VariantBase& > | signal_action_state_changed ()
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 (const Glib::Interface_Class& interface_class)
| Called by constructors of derived classes.
| Interface (GObject* castitem)
| Called by constructors of derived classes.
virtual | ~Interface ()
GObject* | gobj ()
const GObject* | gobj () const
Public Member Functions inherited from Glib::ObjectBase
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, but this is necessary when using the reduced API.
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, but this is necessary when using the reduced API.
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 (const trackable &src)
trackable & | operator= (const trackable &src)
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const
void | remove_destroy_notify_callback (void *data) const
void | notify_callbacks ()

## Static Public Member Functions
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 ()
| 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().

## Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gio::ActionGroup > | wrap (GActionGroup* object, bool take_copy=false)
| A Glib::wrap() method for this object.

## Additional Inherited Members
Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify | func_destroy_notify

## Detailed Description

ActionGroup - a group of actions.

ActionGroup represents a group of actions.

Each action in the group has a unique name (which is a string). All method calls, except list_actions() take the name of an action as an argument.

The GActionGroup API is meant to be the 'public' API to the action group. The calls here are exactly the interaction that 'external forces' (eg: UI, incoming D-Bus messages, etc.) are supposed to have with actions. 'Internal' APIs (ie: ones meant only to be accessed by the action group implementation) are found on subclasses. This is why you will find – for example – get_action_enabled() but not an equivalent `set()` call.

Signals are emitted on the action group in response to state changes on individual actions.

## Constructor & Destructor Documentation

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

You should derive from this class to use it.

virtual Gio::ActionGroup::~ActionGroup | ( |  | ) |
| virtual

Reimplemented in Gio::DBus::ActionGroup.

## Member Function Documentation

void Gio::ActionGroup::action_added | ( | const Glib::ustring& | action_name | ) |

Emits the ActionGroup::signal_action_added() signal on action_group.

This function should only be called by ActionGroup implementations.

Since glibmm 2.28:

Parameters

  action_name | The name of an action in the group.

void Gio::ActionGroup::action_enabled_changed | ( | const Glib::ustring& | action_name,
|  | bool | enabled
| ) |  |

Emits the ActionGroup::signal_action_enabled_changed() signal on action_group.

This function should only be called by ActionGroup implementations.

Since glibmm 2.28:

Parameters

  action_name | The name of an action in the group.
  enabled | Whether or not the action is now enabled.

void Gio::ActionGroup::action_removed | ( | const Glib::ustring& | action_name | ) |

Emits the ActionGroup::signal_action_removed() signal on action_group.

This function should only be called by ActionGroup implementations.

Since glibmm 2.28:

Parameters

  action_name | The name of an action in the group.

void Gio::ActionGroup::action_state_changed | ( | const Glib::ustring& | action_name,
|  | const Glib::VariantBase& | state
| ) |  |

Emits the ActionGroup::signal_action_state_changed() signal on action_group.

This function should only be called by ActionGroup implementations.

Since glibmm 2.28:

Parameters

  action_name | The name of an action in the group.
  state | The new state of the named action.

void Gio::ActionGroup::activate_action | ( | const Glib::ustring& | action_name,
|  | const Glib::VariantBase& | parameter
| ) |  |

Activate the named action within action_group.

If the action is expecting a parameter, then the correct type of parameter must be given as . If the action is expecting no parameters then must be `0`. See g_action_group_get_action_parameter_type().

Since glibmm 2.28:

Parameters

  action_name | The name of the action to activate.
  parameter | Parameters to the activation.

virtual void Gio::ActionGroup::activate_action_vfunc | ( | const Glib::ustring& | name,
|  | const Glib::VariantBase& | parameter
| ) |  |
| virtual

static void Gio::ActionGroup::add_interface | ( | GType | gtype_implementer | ) |
| static

void Gio::ActionGroup::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.

The action must be stateful and value must be of the correct type. See g_action_group_get_action_state_type().

This call merely requests a change. The action may refuse to change its state or may change its state to something other than value. See g_action_group_get_action_state_hint().

If the value GVariant is floating, it is consumed.

Since glibmm 2.28:

Parameters

  action_name | The name of the action to request the change on.
  value | The new state.

virtual void Gio::ActionGroup::change_action_state_vfunc | ( | const Glib::ustring& | name,
|  | const Glib::VariantBase& | value
| ) |  |
| virtual

bool Gio::ActionGroup::get_action_enabled | ( | const Glib::ustring& | action_name | ) | const

Checks if the named action within action_group is currently enabled.

An action must be enabled in order to be activated or in order to have its state changed from outside callers.

Since glibmm 2.28:

Parameters

  action_name | The name of the action to query.

Returns
  Whether or not the action is currently enabled.

virtual bool Gio::ActionGroup::get_action_enabled_vfunc | ( | const Glib::ustring& | name | ) | const
| virtual

Glib::VariantType Gio::ActionGroup::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.

When activating the action using g_action_group_activate_action(), the Variant given to that function must be of the type returned by this function.

In the case that this function returns `0`, you must not give any Variant, but `0` instead.

The parameter type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different parameter type.

Since glibmm 2.28:

Parameters

  action_name | The name of the action to query.

Returns
  The parameter type.

virtual Glib::VariantType Gio::ActionGroup::get_action_parameter_type_vfunc | ( | const Glib::ustring& | name | ) | const
| virtual

Glib::VariantBase Gio::ActionGroup::get_action_state | ( | const Glib::ustring& | action_name | ) | const

Queries the current state of the named action within action_group.

If the action is not stateful then `0` will be returned. If the action is stateful then the type of the return value is the type given by g_action_group_get_action_state_type().

The return value (if non-`0`) should be freed with Glib::variant_unref() when it is no longer required.

Since glibmm 2.28:

Parameters

  action_name | The name of the action to query.

Returns
  The current state of the action.

Glib::VariantContainerBase Gio::ActionGroup::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.

If `0` is returned it either means that the action is not stateful or that there is no hint about the valid range of values for the state of the action.

If a Variant array is returned then each item in the array is a possible value for the state. If a Variant pair (ie: two-tuple) is returned then the tuple specifies the inclusive lower and upper bound of valid values for the state.

In any case, the information is merely a hint. It may be possible to have a state value outside of the hinted range and setting a value within the range may fail.

The return value (if non-`0`) should be freed with Glib::variant_unref() when it is no longer required.

Since glibmm 2.28:

Parameters

  action_name | The name of the action to query.

Returns
  The state range hint.

virtual Glib::VariantBase Gio::ActionGroup::get_action_state_hint_vfunc | ( | const Glib::ustring& | name | ) | const
| virtual

Glib::VariantType Gio::ActionGroup::get_action_state_type | ( | const Glib::ustring& | action_name | ) | const

Queries the type of the state of the named action within action_group.

If the action is stateful then this function returns the VariantType of the state. All calls to g_action_group_change_action_state() must give a Variant of this type and g_action_group_get_action_state() will return a Variant of the same type.

If the action is not stateful then this function will return `0`. In that case, g_action_group_get_action_state() will return `0` and you must not call g_action_group_change_action_state().

The state type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different state type.

Since glibmm 2.28:

Parameters

  action_name | The name of the action to query.

Returns
  The state type, if the action is stateful.

virtual Glib::VariantType Gio::ActionGroup::get_action_state_type_vfunc | ( | const Glib::ustring& | name | ) | const
| virtual

virtual Glib::VariantBase Gio::ActionGroup::get_action_state_vfunc | ( | const Glib::ustring& | name | ) | const
| virtual

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

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

GActionGroup* Gio::ActionGroup::gobj | ( |  | ) |
| inline

Provides access to the underlying C GObject.

const GActionGroup* Gio::ActionGroup::gobj | ( |  | ) | const
| inline

Provides access to the underlying C GObject.

bool Gio::ActionGroup::has_action | ( | const Glib::ustring& | action_name | ) | const

Checks if the named action exists within action_group.

Since glibmm 2.28:

Parameters

  action_name | The name of the action to check for.

Returns
  Whether the named action exists.

virtual bool Gio::ActionGroup::has_action_vfunc | ( | const Glib::ustring& | name | ) | const
| virtual

std::vector<Glib::ustring> Gio::ActionGroup::list_actions | ( |  | ) | const

Lists the actions contained within action_group.

The caller is responsible for freeing the list with Glib::strfreev() when it is no longer required.

Since glibmm 2.28:

Returns
  A `0`-terminated array of the names of the actions in the groupb.

virtual std::vector<Glib::ustring> Gio::ActionGroup::list_actions_vfunc | ( |  | ) | const
| virtual

virtual void Gio::ActionGroup::on_action_added | ( | const Glib::ustring& | action_name | ) |
| protected virtual

This is a default handler for the signal signal_action_added().

virtual void Gio::ActionGroup::on_action_enabled_changed | ( | const Glib::ustring& | action_name,
|  | bool | enabled
| ) |  |
| protected virtual

This is a default handler for the signal signal_action_enabled_changed().

virtual void Gio::ActionGroup::on_action_removed | ( | const Glib::ustring& | action_name | ) |
| protected virtual

This is a default handler for the signal signal_action_removed().

virtual void Gio::ActionGroup::on_action_state_changed | ( | const Glib::ustring& | action_name,
|  | const Glib::VariantBase& | value
| ) |  |
| protected virtual

This is a default handler for the signal signal_action_state_changed().

bool Gio::ActionGroup::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.

This function acquires the information available from g_action_group_has_action(), g_action_group_get_action_enabled(), g_action_group_get_action_parameter_type(), g_action_group_get_action_state_type(), g_action_group_get_action_state_hint() and g_action_group_get_action_state() with a single function call.

This provides two main benefits.

The first is the improvement in efficiency that comes with not having to perform repeated lookups of the action in order to discover different things about it. The second is that implementing ActionGroup can now be done by only overriding this one virtual function.

The interface provides a default implementation of this function that calls the individual functions, as required, to fetch the information. The interface also provides default implementations of those functions that call this function. All implementations, therefore, must override either this function or all of the others.

If the action exists, `true` is returned and any of the requested fields (as indicated by having a non-`0` reference passed in) are filled. If the action doesn't exist, `false` is returned and the fields may or may not have been modified.

Since glibmm 2.32:

Parameters

  action_name | The name of an action in the group.
  enabled | If the action is presently enabled.
  parameter_type | The parameter type, or `0` if none needed.
  state_type | The state type, or `0` if stateless.
  state_hint | The state hint, or `0` if none.
  state | The current state, or `0` if stateless.

Returns
  `true` if the action exists, else `false`.

bool Gio::ActionGroup::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 Gio::ActionGroup::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 Gio::ActionGroup::query_action | ( | const Glib::ustring& | action_name,
|  | bool & | enabled,
|  | Glib::VariantType& | parameter_type,
|  | Glib::VariantBase& | state_hint
| ) |  |

A query_action() convenience overload.

bool Gio::ActionGroup::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 Gio::ActionGroup::query_action | ( | const Glib::ustring& | action_name,
|  | bool & | enabled,
|  | Glib::VariantBase& | state_hint,
|  | Glib::VariantType& | state_type
| ) |  |

A query_action() convenience overload.

bool Gio::ActionGroup::query_action | ( | const Glib::ustring& | action_name,
|  | bool & | enabled,
|  | Glib::VariantBase& | state_hint,
|  | Glib::VariantBase& | state
| ) |  |

A query_action() convenience overload.

bool Gio::ActionGroup::query_action | ( | const Glib::ustring& | action_name,
|  | bool & | enabled,
|  | Glib::VariantBase& | state_hint
| ) |  |

A query_action() convenience overload.

Glib::SignalProxy1< void,const Glib::ustring& > Gio::ActionGroup::signal_action_added | ( |  | ) |

Slot Prototype:
  `void on_my_action_added(const Glib::ustring& action_name)`

Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible.

Since glibmm 2.28:

Parameters

  action_name | The name of the action in action_group.

Glib::SignalProxy2< void,const Glib::ustring&,bool > Gio::ActionGroup::signal_action_enabled_changed | ( |  | ) |

Slot Prototype:
  `void on_my_action_enabled_changed(const Glib::ustring& action_name, bool enabled)`

Signals that the enabled status of the named action has changed.

Since glibmm 2.28:

Parameters

  action_name | The name of the action in action_group.
  enabled | Whether the action is enabled or not.

Glib::SignalProxy1< void,const Glib::ustring& > Gio::ActionGroup::signal_action_removed | ( |  | ) |

Slot Prototype:
  `void on_my_action_removed(const Glib::ustring& action_name)`

Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.

Since glibmm 2.28:

Parameters

  action_name | The name of the action in action_group.

Glib::SignalProxy2< void,const Glib::ustring&,const Glib::VariantBase& > Gio::ActionGroup::signal_action_state_changed | ( |  | ) |

Slot Prototype:
  `void on_my_action_state_changed(const Glib::ustring& action_name, const Glib::VariantBase& value)`

Signals that the state of the named action has changed.

Since glibmm 2.28:

Parameters

  action_name | The name of the action in action_group.
  value | The new value of the state.

## Friends And Related Function Documentation

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