Struct gio::SimpleAction

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

A SimpleAction is the obvious simple implementation of the Action interface. This is the easiest way to create an action for purposes of adding it to a SimpleActionGroup.

See also GtkAction.

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 | Writeable

name

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

Readable | Writeable | Construct Only

parameter-type

The type of the parameter that must be given when activating the action.

Readable | Writeable | Construct Only

state

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

Readable | Writeable | Construct

state-type

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

Readable

Action

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

Signals

activate

Indicates that the action was just activated.

parameter will always be of the expected type, i.e. the parameter type specified when the action was created. If an incorrect type is given when activating the action, this signal is not emitted.

Since GLib 2.40, if no handler is connected to this signal then the default behaviour for boolean-stated actions with a None parameter type is to toggle them via the change-state signal. For stateful actions where the state type is equal to the parameter type, the default is to forward them directly to change-state. This should allow almost all users of SimpleAction to connect only one handler or the other.

change-state

Indicates that the action just received a request to change its state.

value will always be of the correct state type, i.e. the type of the initial state passed to SimpleAction::new_stateful(). If an incorrect type is given when requesting to change the state, this signal is not emitted.

If no handler is connected to this signal then the default behaviour is to call SimpleAction::set_state() to set the state to the requested value. If you connect a signal handler then no default action is taken. If the state should change then you must call SimpleAction::set_state() from the handler.

An example of a ‘change-state’ handler:

⚠️ The following code is in C ⚠️

static void
change_volume_state (GSimpleAction *action,
                     GVariant      *value,
                     gpointer       user_data)
{
  gint requested;

  requested = g_variant_get_int32 (value);

  // Volume only goes from 0 to 10
  if (0 <= requested && requested <= 10)
    g_simple_action_set_state (action, value);
}

The handler need not set the state to the requested value. It could set it to any value at all, or take some other action.

Implements

glib::ObjectExt, ActionExt

Implementations

impl SimpleAction

pub fn new_stateful( name: &str, parameter_type: Option<&VariantTy>, state: Variant ) -> SimpleAction

Creates a new stateful action.

All future state values must have the same glib::VariantType as the initial state.

If the state glib::Variant is floating, it is consumed.

name

the name of the action

parameter_type

the type of the parameter that will be passed to handlers for the activate signal, or None for no parameter

state

the initial state of the action

Returns

a new SimpleAction

pub fn set_state(&self, value: Variant)

Sets the state of the action.

This directly updates the ‘state’ property to the given value.

This should only be called by the implementor of the action. Users of the action should not attempt to directly modify the ‘state’ property. Instead, they should call ActionExt::change_state() to request the change.

If the value GVariant is floating, it is consumed.

value

the new glib::Variant for the state

pub fn set_state_hint(&self, state_hint: Option<Variant>)

Sets the state hint for the action.

See ActionExt::state_hint() for more information about action state hints.

state_hint

a glib::Variant representing the state hint

impl SimpleAction

pub fn new(name: &str, parameter_type: Option<&VariantTy>) -> SimpleAction

Creates a new action.

The created action is stateless. See new_stateful() to create an action that has state.

name

the name of the action

parameter_type

the type of parameter that will be passed to handlers for the activate signal, or None for no parameter

Returns

a new SimpleAction

pub fn set_enabled(&self, enabled: bool)

Sets the action as enabled or not.

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

This should only be called by the implementor of the action. Users of the action should not attempt to modify its enabled flag.

enabled

whether the action is enabled

pub fn connect_activate<F: Fn(&Self, Option<&Variant>) + 'static>( &self, f: F ) -> SignalHandlerId

Indicates that the action was just activated.

parameter will always be of the expected type, i.e. the parameter type specified when the action was created. If an incorrect type is given when activating the action, this signal is not emitted.

Since GLib 2.40, if no handler is connected to this signal then the default behaviour for boolean-stated actions with a None parameter type is to toggle them via the change-state signal. For stateful actions where the state type is equal to the parameter type, the default is to forward them directly to change-state. This should allow almost all users of SimpleAction to connect only one handler or the other.

parameter

the parameter to the activation, or None if it has no parameter

pub fn connect_change_state<F: Fn(&Self, Option<&Variant>) + 'static>( &self, f: F ) -> SignalHandlerId

Indicates that the action just received a request to change its state.

value will always be of the correct state type, i.e. the type of the initial state passed to new_stateful(). If an incorrect type is given when requesting to change the state, this signal is not emitted.

If no handler is connected to this signal then the default behaviour is to call set_state() to set the state to the requested value. If you connect a signal handler then no default action is taken. If the state should change then you must call set_state() from the handler.

An example of a ‘change-state’ handler:

⚠️ The following code is in C ⚠️

static void
change_volume_state (GSimpleAction *action,
                     GVariant      *value,
                     gpointer       user_data)
{
  gint requested;

  requested = g_variant_get_int32 (value);

  // Volume only goes from 0 to 10
  if (0 <= requested && requested <= 10)
    g_simple_action_set_state (action, value);
}

The handler need not set the state to the requested value. It could set it to any value at all, or take some other action.

value

the requested value for the state

Trait Implementations

impl Clone for SimpleAction

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 SimpleAction

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

Formats the value using the given formatter.

impl Display for SimpleAction

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

Formats the value using the given formatter.

impl HasParamSpec for SimpleAction

type ParamSpec = ParamSpecObject

type SetValue = SimpleAction

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SimpleAction

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 SimpleAction

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 ParentClassIs for SimpleAction

type Parent = Object

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

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 SimpleAction

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 SimpleAction

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SimpleAction

impl IsA<Action> for SimpleAction