gio/org.gtkkn.bindings.gio/SimpleAction

SimpleAction

open class SimpleAction(val gioSimpleActionPointer: <Error class: unknown class><<Error class: unknown class>>) : Action(source)

A GSimpleAction is the obvious simple implementation of the iface@Gio.Action interface. This is the easiest way to create an action for purposes of adding it to a class@Gio.SimpleActionGroup.

Skipped during bindings generation

method enabled: Property has no getter
method name: Property has no getter nor setter
method parameter-type: Property has no getter nor setter
method state: Property has no getter
method state-type: Property has no getter nor setter

Constructors

SimpleAction

constructor(name: String, parameterType: <Error class: unknown class>? = null)

Creates a new action.

constructor(name: String, parameterType: <Error class: unknown class>? = null, state: <Error class: unknown class>)

Creates a new stateful action.

constructor(gioSimpleActionPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

enabled

open val enabled: Boolean

If @action is currently enabled.

gioActionPointer

open override val gioActionPointer: <Error class: unknown class><<Error class: unknown class>>

gioProxyPointer

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

gioSimpleActionPointer

val gioSimpleActionPointer: <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().

emitActivate

fun emitActivate(parameter: <Error class: unknown class>?)

Emits the "activate" signal. See onActivate.

emitChangeState

fun emitChangeState(value: <Error class: unknown class>?)

Emits the "change-state" signal. See onChangeState.

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.

onActivate

fun onActivate( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>?) -> Unit): <Error class: unknown class>

Indicates that the action was just activated.

onChangeState

fun onChangeState( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>?) -> Unit): <Error class: unknown class>

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

setEnabled

open fun setEnabled(enabled: Boolean)

Sets the action as enabled or not.

setState

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

Sets the state of the action.

setStateHint

open fun setStateHint(stateHint: <Error class: unknown class>? = null)

Sets the state hint for the 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().