OptionEntry#

class OptionEntry(*args, **kwargs)#

A GOptionEntry struct defines a single option. To have an effect, they must be added to a OptionGroup with add_main_entries() or add_entries().

Fields#

class OptionEntry

arg#: The type of the option, as a OptionArg

arg_data#

If the arg type is CALLBACK, then arg_data must point to a GOptionArgFunc callback function, which will be called to handle the extra argument. Otherwise, arg_data is a pointer to a location to store the value, the required type of the location depends on the arg type:

NONE: bool

STRING: str

INT: int

FILENAME: str

STRING_ARRAY: list[str]

FILENAME_ARRAY: list[str]

DOUBLE: float

If arg type is STRING or FILENAME, the location will contain a newly allocated string if the option was given. That string needs to be freed by the callee using free(). Likewise if arg type is STRING_ARRAY or FILENAME_ARRAY, the data should be freed using strfreev().

arg_description#: 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 set_translation_domain().

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

flags#: Flags from GOptionFlags

long_name#: 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.

short_name#: 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.