OptionContext

A glib.option_context.OptionContext struct defines which options are accepted by the commandline option parser. The struct has only private fields and should not be directly accessed.

Destructor

A destructor is present on this object, but not explicitly documented in the source.

Members

Functions

addGroup
void addGroup(glib.option_group.OptionGroup group)

Adds a #GOptionGroup to the context, so that parsing with context will recognize the options in the group. Note that this will take ownership of the group and thus the group should not be freed.

addMainEntries
void addMainEntries(glib.types.OptionEntry[] entries, string translationDomain)

A convenience function which creates a main group if it doesn't exist, adds the entries to it and sets the translation domain.

getDescription
string getDescription()

Returns the description. See glib.option_context.OptionContext.setDescription.

getHelp
string getHelp(bool mainHelp, glib.option_group.OptionGroup group)

Returns a formatted, translated help text for the given context. To obtain the text produced by --help, call g_option_context_get_help (context, TRUE, NULL). To obtain the text produced by --help-all, call g_option_context_get_help (context, FALSE, NULL). To obtain the help text for an option group, call g_option_context_get_help (context, FALSE, group).

getHelpEnabled
bool getHelpEnabled()

Returns whether automatic --help generation is turned on for context. See glib.option_context.OptionContext.setHelpEnabled.

getIgnoreUnknownOptions
bool getIgnoreUnknownOptions()

Returns whether unknown options are ignored or not. See glib.option_context.OptionContext.setIgnoreUnknownOptions.

getMainGroup
glib.option_group.OptionGroup getMainGroup()

Returns a pointer to the main group of context.

getStrictPosix
bool getStrictPosix()

Returns whether strict POSIX code is enabled.

getSummary
string getSummary()

Returns the summary. See glib.option_context.OptionContext.setSummary.

setDescription
void setDescription(string description)

Adds a string to be displayed in --help output after the list of options. This text often includes a bug reporting address.

setHelpEnabled
void setHelpEnabled(bool helpEnabled)

Enables or disables automatic generation of --help output. By default, glib.option_context.OptionContext.parse recognizes --help, -h, -?, --help-all and --help-groupname and creates suitable output to stdout.

setIgnoreUnknownOptions
void setIgnoreUnknownOptions(bool ignoreUnknown)

Sets whether to ignore unknown options or not. If an argument is ignored, it is left in the argv array after parsing. By default, glib.option_context.OptionContext.parse treats unknown options as error.

setMainGroup
void setMainGroup(glib.option_group.OptionGroup group)

Sets a #GOptionGroup as main group of the context. This has the same effect as calling glib.option_context.OptionContext.addGroup, the only difference is that the options in the main group are treated differently when generating --help output.

setStrictPosix
void setStrictPosix(bool strictPosix)

Sets strict POSIX mode.

setSummary
void setSummary(string summary)

Adds a string to be displayed in --help output before the list of options. This is typically a summary of the program functionality.

setTranslateFunc
void setTranslateFunc(glib.types.TranslateFunc func)

Sets the function which is used to translate the contexts user-visible strings, for --help output. If func is null, strings are not translated.

setTranslationDomain
void setTranslationDomain(string domain)

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