class: Action

[30:7] extends: object

GAction represents a single named action. The main interface to an action is that it can be activated with [method@Gio.Action.activate]. This results in the 'activate' signal being emitted. An activation has a GVariant parameter (which may be NULL). 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 [method@Gio.Action.change_state]. This call takes a [type@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. GAction is merely the interface to the concept of an action, as described above. Various implementations of actions exist, including [class@Gio.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 [method@Gio.Action.activate] and [method@Gio.Action.change_state] for type safety and for the state being enabled. Probably the only useful thing to do with a GAction is to put it inside of a [class@Gio.SimpleActionGroup].

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Action (Handle = null)

  Creates a new Action by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• activate (object parameter)

  Activates the action. @parameter must be the correct type of parameter for the action (ie: the parameter type given at construction time). If the parameter type was NULL then @parameter must also be NULL. If the

  • @parameter [type@GLib.Variant] is floating, it is consumed.
  • @p parameter is the parameter to the activation.
  • @r None.

• change_state (object value)

  Request for the state of @action to be changed to @value. The action must be stateful and @value must be of the correct type. See [method@Gio.Action.get_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 [method@Gio.Action.get_state_hint]. If the @value [type@GLib.Variant] is floating, it is consumed.

  • @p value is the new state.
  • @r None.

• get_enabled ()

  Checks if @action is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers.

• get_name ()

  Queries the name of @action.

• get_parameter_type ()

  Queries the type of the parameter that must be given when activating

  • @action. When activating the action using [method@Gio.Action.activate], the [type@GLib.Variant] given to that function must be of the type returned by this function. In the case that this function returns NULL, you must not give any [type@GLib.Variant], but NULL instead.

• get_state ()

  Queries the current state of @action. If the action is not stateful then NULL will be returned. If the action is stateful then the type of the return value is the type given by [method@Gio.Action.get_state_type]. The return value (if non-NULL) should be freed with [method@GLib.Variant.unref] when it is no longer required.

• get_state_hint ()

  Requests a hint about the valid range of values for the state of @action. If NULL 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 [type@GLib.Variant] array is returned then each item in the array is a possible value for the state. If a [type@GLib.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-NULL) should be freed with [method@GLib.Variant.unref] when it is no longer required.

• get_state_type ()

  Queries the type of the state of @action. If the action is stateful (e.g. created with [ctor@Gio.SimpleAction.new_stateful]) then this function returns the [type@GLib.VariantType] of the state. This is the type of the initial value given as the state. All calls to [method@Gio.Action.change_state] must give a [type@GLib.Variant] of this type and [method@Gio.Action.get_state] will return a [type@GLib.Variant] of the same type. If the action is not stateful (e.g. created with [ctor@Gio.SimpleAction.new]) then this function will return NULL. In that case, [method@Gio.Action.get_state] will return NULL and you must not call [method@Gio.Action.change_state].

class: ActionMeta

[224:14] static extends: object

Generated metadata helpers for Action interface surfaces.

Methods

• properties ()

  Returns property metadata for Action.

  • @r A list.