gio/org.gtkkn.bindings.gio/Action

Action

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.

Skipped during bindings generation

parameter action_name: action_name: Out parameter is not supported

Inheritors

ActionImpl

PropertyAction

SimpleAction

Types

ActionImpl

class ActionImpl(gioActionPointer: <Error class: unknown class><<Error class: unknown class>>) : Action

The ActionImpl type represents a native instance of the Action interface.

Companion

object Companion

Properties

enabled

open val enabled: Boolean

If @action is currently enabled.

gioActionPointer

abstract val gioActionPointer: <Error class: unknown class><<Error class: unknown class>>

gioProxyPointer

abstract val gioProxyPointer: <Error class: unknown class><<Error class: unknown class>>

name

open val name: String

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

parameterType

open val parameterType: <Error class: unknown class>?

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

state

open val state: <Error class: unknown class>?

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

stateType

open val stateType: <Error class: unknown class>?

The type@GLib.VariantType of the state that the action has, or NULL if the action is stateless. This is immutable.

Functions

activate

open fun activate(parameter: <Error class: unknown class>? = null)

Activates the action.

changeState

open fun changeState(value: <Error class: unknown class>)

Request for the state of @action to be changed to @value.

connect

open fun connect(connection: IoStream, proxyAddress: ProxyAddress, cancellable: Cancellable? = null): <Error class: unknown class><IoStream>

Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload.

connectAsync

open fun connectAsync(connection: IoStream, proxyAddress: ProxyAddress, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Asynchronous version of g_proxy_connect().

connectFinish

open fun connectFinish(result: AsyncResult): <Error class: unknown class><IoStream>

See g_proxy_connect().

getEnabled

open fun getEnabled(): Boolean

Checks if @action is currently enabled.

getName

open fun getName(): String

Queries the name of @action.

getParameterType

open fun getParameterType(): <Error class: unknown class>?

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

getState

open fun getState(): <Error class: unknown class>?

Queries the current state of @action.

getStateHint

open fun getStateHint(): <Error class: unknown class>?

Requests a hint about the valid range of values for the state of

getStateType

open fun getStateType(): <Error class: unknown class>?

Queries the type of the state of @action.

supportsHostname

open fun supportsHostname(): Boolean

Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return false if @proxy is implementing such a protocol. When false is returned, the caller should resolve the destination hostname first, and then pass a #GProxyAddress containing the stringified IP address to g_proxy_connect() or g_proxy_connect_async().