glib/org.gtkkn.bindings.glib/OptionGroup

OptionGroup

class OptionGroup(pointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance

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: OptionEntry

  • parameter error_func: OptionErrorFunc

  • parameter pre_parse_func: OptionParseFunc

  • parameter destroy: DestroyNotify

Constructors

Link copied to clipboard
constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val glibOptionGroupPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val handle: <Error class: unknown class>?

Functions

Link copied to clipboard
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.

Link copied to clipboard
fun free()

Frees a #GOptionGroup. Note that you must not free groups which have been added to a #GOptionContext.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
fun ref(): OptionGroup

Increments the reference count of @group by one.

Link copied to clipboard
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.

Link copied to clipboard
fun setTranslationDomain(domain: String)

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

Link copied to clipboard
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.