gio/org.gtkkn.bindings.gio/Volume/VolumeImpl

VolumeImpl

data class VolumeImpl(val gioVolumePointer: <Error class: unknown class><<Error class: unknown class>>) : Volume

The VolumeImpl type represents a native instance of the Volume interface.

Constructors

VolumeImpl

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

Creates a new instance of Volume for the provided CPointer.

Properties

gioProxyPointer

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

gioVolumePointer

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

Functions

canEject

open fun canEject(): Boolean

Checks if a volume can be ejected.

canMount

open fun canMount(): Boolean

Checks if a volume can be mounted.

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

eject

open fun eject(flags: MountUnmountFlags, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_finish() with the @volume and #GAsyncResult returned in the @callback.

ejectFinish

open fun ejectFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes ejecting a volume. If any errors occurred during the operation,

ejectWithOperation

open fun ejectWithOperation(flags: MountUnmountFlags, mountOperation: MountOperation? = null, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_with_operation_finish() with the @volume and #GAsyncResult data returned in the @callback.

ejectWithOperationFinish

open fun ejectWithOperationFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes ejecting a volume. If any errors occurred during the operation,

enumerateIdentifiers

open fun enumerateIdentifiers(): List<String>

Gets the kinds of #volume-identifiers that @volume has. Use g_volume_get_identifier() to obtain the identifiers themselves.

getActivationRoot

open fun getActivationRoot(): File?

Gets the activation root for a #GVolume if it is known ahead of mount time. Returns null otherwise. If not null and if @volume is mounted, then the result of g_mount_get_root() on the #GMount object obtained from g_volume_get_mount() will always either be equal or a prefix of what this function returns. In other words, in code

getDrive

open fun getDrive(): Drive?

Gets the drive for the @volume.

getIcon

open fun getIcon(): Icon

Gets the icon for @volume.

getIdentifier

open fun getIdentifier(kind: String): String?

Gets the identifier of the given kind for @volume. See the #volume-identifiers for more information about volume identifiers.

getMount

open fun getMount(): Mount?

Gets the mount for the @volume.

getName

open fun getName(): String

Gets the name of @volume.

getSortKey

open fun getSortKey(): String?

Gets the sort key for @volume, if any.

getSymbolicIcon

open fun getSymbolicIcon(): Icon

Gets the symbolic icon for @volume.

getUuid

open fun getUuid(): String?

Gets the UUID for the @volume. The reference is typically based on the file system UUID for the volume in question and should be considered an opaque string. Returns null if there is no UUID available.

mount

open fun mount(flags: MountMountFlags, mountOperation: MountOperation? = null, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Mounts a volume. This is an asynchronous operation, and is finished by calling g_volume_mount_finish() with the @volume and #GAsyncResult returned in the @callback.

mountFinish

open fun mountFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes mounting a volume. If any errors occurred during the operation,

onChanged

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

Emitted when the volume has been changed.

onRemoved

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

This signal is emitted when the #GVolume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized.

shouldAutomount

open fun shouldAutomount(): Boolean

Returns whether the volume should be automatically mounted.

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