glib/org.gtkkn.bindings.glib/OptionArg

OptionArg

enum OptionArg : Enum<OptionArg> (source)

The #GOptionArg enum values determine which type of extra argument the options expect to find. If an option expects an extra argument, it can be specified in several ways; with a short option: -x arg, with a long option: --name arg or combined in a single argument: --name=arg.

Entries

NONE

No extra argument. This is useful for simple flags or booleans.

STRING

The option takes a UTF-8 string argument.

INT

The option takes an integer argument.

CALLBACK

The option provides a callback (of type #GOptionArgFunc) to parse the extra argument.

FILENAME

The option takes a filename as argument, which will be in the GLib filename encoding rather than UTF-8.

STRING_ARRAY

The option takes a string argument, multiple uses of the option are collected into an array of strings.

FILENAME_ARRAY

The option takes a filename as argument, multiple uses of the option are collected into an array of strings.

DOUBLE

The option takes a double argument. The argument can be formatted either for the user's locale or for the "C" locale. Since 2.12

INT64

The option takes a 64-bit integer. Like %G_OPTION_ARG_INT but for larger numbers. The number can be in decimal base, or in hexadecimal (when prefixed with 0x, for example, 0xffffffff). Since 2.12

Types

Companion

object Companion

Properties

name

val name: String

nativeValue

val nativeValue: <Error class: unknown class>

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): OptionArg

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<OptionArg>

Returns an array containing the constants of this enum type, in the order they're declared.