package ocgtk

  1. Overview
  2. Docs
package ocgtk
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Wrappers.Action

type t = [ `action ] Gobject.obj
val from_gobject : 'a Gobject.obj -> t
val get_state_type : t -> Gvariant_type.t option

Queries the type of the state of @action.

If the action is stateful (e.g. created with g_simple_action_new_stateful()) then this function returns the #GVariantType of the state. This is the type of the initial value given as the state. All calls to g_action_change_state() must give a #GVariant of this type and g_action_get_state() will return a #GVariant of the same type.

If the action is not stateful (e.g. created with g_simple_action_new()) then this function will return %NULL. In that case, g_action_get_state() will return %NULL and you must not call g_action_change_state().

val get_state_hint : t -> Gvariant.t option

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 #GVariant array is returned then each item in the array is a possible value for the state. If a #GVariant 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 g_variant_unref() when it is no longer required.

val get_state : t -> Gvariant.t option

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 g_action_get_state_type().

The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required.

val get_parameter_type : t -> Gvariant_type.t option

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

When activating the action using g_action_activate(), the #GVariant 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 #GVariant, but %NULL instead.

val get_name : t -> string

Queries the name of @action.

val get_enabled : t -> bool

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.

val change_state : t -> Gvariant.t -> unit

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 g_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 g_action_get_state_hint().

If the @value GVariant is floating, it is consumed.

val activate : t -> Gvariant.t option -> unit

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 GVariant is floating, it is consumed.