glib/org.gtkkn.bindings.glib/OptionGroup

OptionGroup

class OptionGroup(val glibOptionGroupPointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance(source)

A GOptionGroup struct defines the options in a single group. The struct has only private fields and should not be directly accessed.

All options in a group share the same translation function. Libraries which need to parse commandline options are expected to provide a function for getting a GOptionGroup holding their options, which the application can then add to its #GOptionContext.

Skipped during bindings generation

parameter entries: Array parameter of type OptionEntry is not supported
parameter error_func: OptionErrorFunc
parameter pre_parse_func: OptionParseFunc
parameter destroy: DestroyNotify

Constructors

OptionGroup

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

Types

Companion

object Companion

Properties

glibOptionGroupPointer

val glibOptionGroupPointer: <Error class: unknown class><<Error class: unknown class>>

handle

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

Functions

addCleaner

open override fun addCleaner(cleaner: <Error class: unknown class>): Boolean

Registers a cleaner to be executed when this proxy object is garbage collected.

equals

open operator override fun equals(other: Any?): Boolean

Compare two proxy instances for equality. This will compare both the type of the instances, and their memory addresses.

free

fun free()

This is deprecated since version 2.44.

getSimpleNameWithHandle

open fun getSimpleNameWithHandle(): String

hashCode

open override fun hashCode(): Int

ref

fun ref(): OptionGroup

Increments the reference count of @group by one.

removeCleaner

open override fun removeCleaner(cleaner: <Error class: unknown class>): Boolean

Removes a previously registered cleaner from this proxy object.

setTranslateFunc

fun setTranslateFunc(func: TranslateFunc?)

Sets the function which is used to translate user-visible strings, for --help output. Different groups can use different #GTranslateFuncs. If @func is null, strings are not translated.

setTranslationDomain

fun setTranslationDomain(domain: String)

A convenience function to use gettext() for translating user-visible strings.

unref

fun unref()

Decrements the reference count of @group by one. If the reference count drops to 0, the @group will be freed. and all memory allocated by the @group is released.