Struct ActionGroup

pub struct ActionGroup { /* private fields */ }

GActionGroup represents a group of actions.

Actions can be used to expose functionality in a structured way, either from one part of a program to another, or to the outside world. Action groups are often used together with a [type@Gio.MenuModel] that provides additional representation data for displaying the actions to the user, e.g. in a menu.

The main way to interact with the actions in a GActionGroup is to activate them with ActionGroupExt::activate_action(). Activating an action may require a [type@GLib.Variant] parameter. The required type of the parameter can be inquired with ActionGroupExt::action_parameter_type(). Actions may be disabled, see ActionGroupExt::is_action_enabled(). Activating a disabled action has no effect.

Actions may optionally have a state in the form of a [type@GLib.Variant]. The current state of an action can be inquired with ActionGroupExt::action_state(). Activating a stateful action may change its state, but it is also possible to set the state by calling ActionGroupExt::change_action_state().

As typical example, consider a text editing application which has an option to change the current font to ‘bold’. A good way to represent this would be a stateful action, with a boolean state. Activating the action would toggle the state.

Each action in the group has a unique name (which is a string). All method calls, except ActionGroupExt::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 – ActionGroupExt::is_action_enabled() but not an equivalent set_action_enabled() method.

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

Implementations of GActionGroup should provide implementations for the virtual functions ActionGroupExt::list_actions() and Gio::ActionGroup::query_action(). The other virtual functions should not be implemented — their ‘wrappers’ are actually implemented with calls to Gio::ActionGroup::query_action().

Signals

action-added

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.

Detailed

action-enabled-changed

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

Detailed

action-removed

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.

Detailed

action-state-changed

Signals that the state of the named action has changed.

Detailed

Implements

ActionGroupExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl ActionGroup

pub const NONE: Option<&'static ActionGroup> = None

Trait Implementations

impl Clone for ActionGroup

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ActionGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for ActionGroup

type ParamSpec = ParamSpecObject

type SetValue = ActionGroup

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ActionGroup>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ActionGroup

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: ActionGroupImpl> IsImplementable<T> for ActionGroup

fn interface_init(iface: &mut Interface<Self>)

Override the virtual methods of this interface for the given subclass and do other interface initialization.

fn instance_init(_instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for ActionGroup

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<OT: ObjectType> PartialEq<OT> for ActionGroup

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ActionGroup

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ActionGroup

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ActionGroup

impl IsA<ActionGroup> for Application

impl IsA<ActionGroup> for DBusActionGroup

impl IsA<ActionGroup> for RemoteActionGroup

impl IsA<ActionGroup> for SimpleActionGroup