glib/org.gtkkn.bindings.glib/OptionEntry

OptionEntry

class OptionEntry(pointer: <Error class: unknown class><<Error class: unknown class>>) : Record

A GOptionEntry struct defines a single option. To have an effect, they must be added to a #GOptionGroup with g_option_context_add_main_entries() or g_option_group_add_entries().

Skipped during bindings generation

field arg_data: gpointer

Constructors

OptionEntry

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

Types

Companion

object Companion : RecordCompanion<OptionEntry, <Error class: unknown class>>

Properties

arg

var arg: OptionArg

The type of the option, as a #GOptionArg

argDescription

val argDescription: String?

The placeholder to use for the extra argument parsed by the option in --help output. The @arg_description is translated using the @translate_func of the group, see g_option_group_set_translation_domain().

description

val description: String?

the description for the option in --help output. The @description is translated using the @translate_func of the group, see g_option_group_set_translation_domain().

flags

var flags: Int

Flags from #GOptionFlags

glibOptionEntryPointer

val glibOptionEntryPointer: <Error class: unknown class><<Error class: unknown class>>

longName

val longName: String?

The long name of an option can be used to specify it in a commandline as --long_name. Every option must have a long name. To resolve conflicts if multiple option groups contain the same long name, it is also possible to specify the option as --groupname-long_name.

shortName

var shortName: Char

If an option has a short name, it can be specified -short_name in a commandline. @short_name must be a printable ASCII character different from '-', or zero if the option has no short name.