Package org.gtk.glib

Types

CArray

typealias CArray<T> = CPointer<CPointerVar<T>>

Kotlin typealias for a C Array

CompareDataFunction

typealias CompareDataFunction = (a: VoidPointer?, b: VoidPointer?) -> Int

CopyFunction

typealias CopyFunction = (VoidPointer) -> VoidPointer

CStringList

typealias CStringList = CPointer<CPointerVar<ByteVar>>

Shorthand for C's representation of a list of strings (a pointer to a list of char pointers).

CStringPointer

typealias CStringPointer = CPointer<ByteVar>

Shorthand for C's representation of a string.

DateTime

class DateTime(pointer: GDateTime_autoptr)

kotlinx-gtk

DestroyNotify

typealias DestroyNotify = CPointer<CFunction<(gpointer?) -> Unit>>

FreeMe

interface FreeMe

gtk-kt

KeyFile

class KeyFile(structPointer: CPointer<GKeyFile>)

05 / 01 / 2022

KFunc

typealias KFunc = (VoidPointer) -> Unit

KGByteArray

class KGByteArray(struct: GByteArray_autoptr) : UnrefMe

15 / 01 / 2022

KGBytes

class KGBytes(pointer: GBytes_autoptr) : Comparable<KGBytes> , UnrefMe

KGError

open class KGError(pointer: CPointer<GError>) : Exception

kotlinx-gtk

KList

class KList(listPointer: CPointer<GList>) : FreeMe

kotlinx-gtk

OptionArg

enum OptionArg : Enum<OptionArg>

kotlinx-gtk 23 / 03 / 2021

OptionEntry

class OptionEntry(struct: CPointer<GOptionEntry>)

kotlinx-gtk 15 / 04 / 2021 TODO

OptionFlags

enum OptionFlags : Enum<OptionFlags>

kotlinx-gtk 23 / 03 / 2021

OptionGroup

class OptionGroup(optionPointer: CPointer<GOptionGroup>)

kotlinx-gtk 15 / 04 / 2021 TODO

OSInfoKey

enum OSInfoKey : Enum<OSInfoKey>

PollFD

class PollFD(pollFDPointer: CPointer<GPollFD>)

kotlinx-gtk

PtrArray

open class PtrArray(ptrArrayPointer: GPtrArray_autoptr)

18 / 12 / 2021

SList

class SList(listPointer: CPointer<GSList>) : FreeMe

kotlinx-gtk

Source

class Source(pointer: GSource_autoptr)

gtk-kt

SourceFunction

typealias SourceFunction = () -> Boolean

StringPtrArray

class StringPtrArray(ptrArrayPointer: GPtrArray_autoptr) : PtrArray

18 / 12 / 2021

UnrefMe

interface UnrefMe

gtk-kt

Variant

open class Variant(variantPointer: CPointer<GVariant>) : Comparable<Variant> , UnrefMe

kotlinx-gtk

VariantClass

enum VariantClass : Enum<VariantClass>

gtk-kt

VariantDictionary

open class VariantDictionary(variantDictPointer: CPointer<GVariantDict>) : UnrefMe

gtk-kt

VariantIter

class VariantIter(pointer: GVariantIter_autoptr) : FreeMe

gtk-kt

VariantType

sealed class VariantType

kotlinx-gtk 23 / 03 / 2021

VoidPointer

typealias VoidPointer = COpaquePointer

WrappedKList

class WrappedKList<T>(kList: KList, wrapPointer: VoidPointer.() -> T, getPointer: T.() -> VoidPointer) : FreeMe

kotlinx-gtk

WrappedSList

class WrappedSList<T>(sList: SList, wrapPointer: VoidPointer.() -> T, getPointer: T.() -> VoidPointer) : FreeMe

gtk-kt

Functions

allocateGErrorPtr

inline fun NativePlacement.allocateGErrorPtr(): CPointer<CPointerVar<GError>>

asIterable

inline fun <T : CPointed> CPointer<CPointerVar<T>>.asIterable(): Iterator<CPointer<T>>

For null terminated C arrays

asKSequence

inline fun CStringList?.asKSequence(): Sequence<String>

Null termination accepting sequence

inline fun CPointer<GList>?.asKSequence(crossinline wrap: (CPointer) -> O): Sequence<O>

inline fun CPointer<GSList>?.asKSequence(crossinline wrap: (CPointer) -> O): Sequence<O>

asSequence

fun <T : CPointed> CPointer<GList>?.asSequence(): Sequence<CPointer<T>>

fun <T : CPointed> CPointer<GSList>?.asSequence(): Sequence<CPointer<T>>

fun CPointer<gintVar>?.asSequence(length: Int): Sequence<Int>

inline fun <T : CPointed> CPointer<CPointerVar<T>>?.asSequence(): Sequence<CPointer<T>>

For null terminated C arrays

asStablePointer

inline fun Any.asStablePointer(): COpaquePointer

Turns anything into a stable ref pointer

free

fun CPointer<GList>?.free()

fun CPointer<GSList>?.free()

inline fun gpointer.free()

inline fun CStringList.free()

freeToArray

inline fun CStringList.freeToArray(): Array<String>

Like the toArray version, except frees the pointer

inline fun CPointer<IntVar>.freeToArray(): Array<Int>

getOSInfo

fun getOSInfo(key: String): String?

gtk-kt

fun getOSInfo(key: OSInfoKey): String?

stringListFromNullTerminatedCStringListAndFree

inline fun stringListFromNullTerminatedCStringListAndFree(cList: CStringList?): List<String>

Create a list of strings from a CStringList, then free it with g_strfreev

timeoutAdd

fun timeoutAdd(interval: UInt, function: SourceFunction): UInt

toArray

inline fun <T : CPointed> CArray<T>.toArray(): Array<CPointer<T>>

Turn a NULL terminated C Array into a Kotlin Array

inline fun CStringList.toArray(): Array<String>

inline fun CPointer<IntVar>.toArray(): Array<Int>

inline fun <T : CPointed> CArray<T>.toArray(size: Int): Array<CPointer<T>>

Turn a C Array into a Kotlin Array with a known size

toCArray

fun Array<Int>.toCArray(scope: MemScope): CPointer<IntVar>

fun Array<ULong>.toCArray(scope: MemScope): CPointer<ULongVar>

toCPointerArray

fun Array<Int>.toCPointerArray(scope: MemScope): CPointer<CPointerVar<IntVar>>

fun Array<ULong>.toCPointerArray(scope: MemScope): CPointer<CPointerVar<ULongVar>>

toKArray

fun CStringList.toKArray(): Array<String>

toList

inline fun CStringList.toList(): List<String>

inline fun CArray<UIntVar>.toList(): List<UInt>

inline fun CArray<UIntVar>.toList(size: Int): List<UInt>

toNullTermCArray

fun <T, O : CPointed> Array<T>.toNullTermCArray(map: T.() -> CPointer<O>): CPointer<CPointerVarOf<CPointer<O>>>

toNullTermCStringArray

fun Array<String>.toNullTermCStringArray(): CStringList

fun Array<out String>.toNullTermCStringArray(): CStringList

fun List<String>.toNullTermCStringArray(): CStringList

toStringList

~~fun~~ CStringList?.~~toStringList~~(~~length~~: Int): List<String?>

toStringListFillNulls

~~fun~~ CStringList?.~~toStringListFillNulls~~(~~length~~: Int): List<String>

Will simply replace null with "null"

toStringListFilterNulls

fun CStringList?.toStringListFilterNulls(length: Int): List<String>

Will filter out nulls

toStringListNoNulls

~~fun~~ CStringList?.~~toStringListNoNulls~~(~~length~~: Int): List<String>

Will throw an exception on a nullable

toWrappedList

inline fun <T : CPointed, O> CArray<T>.toWrappedList(wrap: (CPointer<T>) -> O): List<O>

Turn a NULL terminated C Array into a Kotlin List, with action to wrap each index

inline fun <T : CPointed, O> CArray<T>.toWrappedList(size: Int, wrap: (CPointer<T>) -> O): List<O>

Turn a C Array into a Kotlin List with a known size, with action to wrap each index

unwrap

fun CPointer<CPointerVar<GError>>.unwrap(throwException: Boolean = true, extraMapping: Map<UInt, (CPointer<GError>) -> KGError> = mapOf()): Exception?

kotlinx-gtk 08 / 04 / 2021

use

inline fun <T : FreeMe, R> T.use(use: (T) -> R): R

inline fun <T : UnrefMe, R> T.use(use: (T) -> R): R

inline fun CPointer.use(action: (CPointer) -> O): O

Use a pointer, then the pointer will be freed afterwards

inline fun StableRef.use(action: (StableRef) -> O): O

Use a StableRef, disposing of it afterwards

usePointer

inline fun StableRef.usePointer(action: (COpaquePointer) -> O): O

Use a StableRef (as a CPointer), disposing of it afterwards

Properties

bool

val gboolean.bool: Boolean

gtk

val Boolean?.gtk: gboolean

gtk

val Boolean.gtk: gboolean

staticCompareDataFunction

val staticCompareDataFunction: GCompareDataFunc

staticCopyFunction

val staticCopyFunction: GCopyFunc

staticForeachFunction

val staticForeachFunction: GFunc