OptionFlags

class OptionFlags

Flags which modify individual options.

Fields

class OptionFlags

DEPRECATED

This flag marks the option as deprecated in the --help.

You should update the description of the option to describe what the user should do in response to the deprecation, for instance: remove the option, or replace it with another one.

Added in version 2.84.

FILENAME

For options of the CALLBACK kind, this flag indicates that the argument should be passed to the callback in the GLib filename encoding rather than UTF-8. Since 2.8

HIDDEN

The option doesn’t appear in --help output.

IN_MAIN

The option appears in the main section of the --help output, even if it is defined in a group.

NOALIAS

This flag turns off the automatic conflict resolution which prefixes long option names with groupname- if there is a conflict. This option should only be used in situations where aliasing is necessary to model some legacy commandline interface. It is not safe to use this option, unless all option groups are under your direct control. Since 2.8.

NONE

No flags.

Added in version 2.42.

NO_ARG

For options of the CALLBACK kind, this flag indicates that the callback does not take any argument (like a NONE option). Since 2.8

OPTIONAL_ARG

For options of the CALLBACK kind, this flag indicates that the argument supply is optional. If no argument is given then data of %GOptionParseFunc will be set to NULL. Since 2.8

REVERSE

For options of the NONE kind, this flag indicates that the sense of the option is reversed. i.e. False will be stored into the argument rather than True.