Struct gio::Action

#[repr(transparent)]
pub struct Action { /* private fields */ }

Action represents a single named action.

The main interface to an action is that it can be activated with ActionExt::activate(). This results in the ‘activate’ signal being emitted. An activation has a glib::Variant parameter (which may be None). The correct type for the parameter is determined by a static parameter type (which is given at construction time).

An action may optionally have a state, in which case the state may be set with ActionExt::change_state(). This call takes a glib::Variant. The correct type for the state is determined by a static state type (which is given at construction time).

The state may have a hint associated with it, specifying its valid range.

Action is merely the interface to the concept of an action, as described above. Various implementations of actions exist, including SimpleAction.

In all cases, the implementing class is responsible for storing the name of the action, the parameter type, the enabled state, the optional state type and the state and emitting the appropriate signals when these change. The implementor is responsible for filtering calls to ActionExt::activate() and ActionExt::change_state() for type safety and for the state being enabled.

Probably the only useful thing to do with a Action is to put it inside of a SimpleActionGroup.

Properties

enabled

If action is currently enabled.

If the action is disabled then calls to ActionExt::activate() and ActionExt::change_state() have no effect.

Readable

name

The name of the action. This is mostly meaningful for identifying the action once it has been added to a ActionGroup. It is immutable.

Readable

parameter-type

The type of the parameter that must be given when activating the action. This is immutable, and may be None if no parameter is needed when activating the action.

Readable

state

The state of the action, or None if the action is stateless.

Readable

state-type

The glib::VariantType of the state that the action has, or None if the action is stateless. This is immutable.

Readable

Implements

ActionExt

Implementations

impl Action

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

pub fn name_is_valid(action_name: &str) -> bool

Checks if action_name is valid.

action_name is valid if it consists only of alphanumeric characters, plus ‘-’ and ‘.’. The empty string is not a valid action name.

It is an error to call this function with a non-utf8 action_name. action_name must not be None.

action_name

a potential action name

Returns

true if action_name is valid

pub fn parse_detailed_name( detailed_name: &str ) -> Result<(GString, Option<Variant>), Error>

Parses a detailed action name into its separate name and target components.

Detailed action names can have three formats.

The first format is used to represent an action name with no target value and consists of just an action name containing no whitespace nor the characters :, ( or ). For example: app.action.

The second format is used to represent an action with a target value that is a non-empty string consisting only of alphanumerics, plus - and .. In that case, the action name and target value are separated by a double colon (::). For example: app.action::target.

The third format is used to represent an action with any type of target value, including strings. The target value follows the action name, surrounded in parens. For example: app.action(42). The target value is parsed using g_variant_parse(). If a tuple-typed value is desired, it must be specified in the same way, resulting in two sets of parens, for example: app.action((1,2,3)). A string target can be specified this way as well: app.action('target'). For strings, this third format must be used if target value is empty or contains characters other than alphanumerics, - and ..

If this function returns true, a non-None value is guaranteed to be returned in action_name (if a pointer is passed in). A None value may still be returned in target_value, as the detailed_name may not contain a target.

If returned, the glib::Variant in target_value is guaranteed to not be floating.

detailed_name

a detailed action name

Returns

true if successful, else false with error set

action_name

the action name

target_value

the target value, or None for no target

pub fn print_detailed_name( action_name: &str, target_value: Option<&Variant> ) -> GString

Formats a detailed action name from action_name and target_value.

It is an error to call this function with an invalid action name.

This function is the opposite of parse_detailed_name(). It will produce a string that can be parsed back to the action_name and target_value by that function.

See that function for the types of strings that will be printed by this function.

action_name

a valid action name

target_value

a glib::Variant target value, or None

Returns

a detailed format string

Trait Implementations

impl Clone for Action

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Action

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

Formats the value using the given formatter.

impl Display for Action

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

Formats the value using the given formatter.

impl HasParamSpec for Action

type ParamSpec = ParamSpecObject

type SetValue = Action

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Action

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

Feeds this value into the given Hasher.

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 Ord for Action

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

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

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for Action

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Action

impl IsA<Action> for PropertyAction

impl IsA<Action> for SimpleAction