[]Struct gio::ActionGroup

pub struct ActionGroup(_, _);

ActionGroup 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 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 ActionGroup::activate_action. Activating an action may require a glib::Variant parameter. The required type of the parameter can be inquired with ActionGroup::get_action_parameter_type. Actions may be disabled, see ActionGroup::get_action_enabled. Activating a disabled action has no effect.

Actions may optionally have a state in the form of a glib::Variant. The current state of an action can be inquired with ActionGroup::get_action_state. Activating a stateful action may change its state, but it is also possible to set the state by calling ActionGroup::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 ActionGroup::list_actions take the name of an action as an argument.

The ActionGroup 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 - ActionGroup::get_action_enabled but not an equivalent set call.

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

Implementations of ActionGroup should provide implementations for the virtual functions ActionGroup::list_actions and ActionGroup::query_action. The other virtual functions should not be implemented - their "wrappers" are actually implemented with calls to ActionGroup::query_action.

Implements

ActionGroupExt

Trait Implementations

impl Clone for ActionGroup

impl Debug for ActionGroup

impl Display for ActionGroup[src]

impl Eq for ActionGroup

impl Hash for ActionGroup

impl IsA<ActionGroup> for Application

impl IsA<ActionGroup> for RemoteActionGroup

impl IsA<ActionGroup> for SimpleActionGroup

impl Ord for ActionGroup

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

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

impl StaticType for ActionGroup

Auto Trait Implementations

impl RefUnwindSafe for ActionGroup

impl !Send for ActionGroup

impl !Sync for ActionGroup

impl Unpin for ActionGroup

impl UnwindSafe for ActionGroup

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<Super, Sub> CanDowncast<Sub> for Super where
    Sub: IsA<Super>,
    Super: IsA<Super>, 

impl<T> Cast for T where
    T: ObjectType, 

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ObjectExt for T where
    T: ObjectType, 

impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<Array>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToSendValue for T where
    T: ToValue + SetValue + Send + ?Sized

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T> ToValue for T where
    T: SetValue + ?Sized

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.