[ Compact ]
public class OptionContext
- OptionContext
- OptionContext
- add_group
- add_main_entries
- get_description
- get_help
- get_help_enabled
- get_ignore_unknown_options
- get_main_group
- get_strict_posix
- get_summary
- parse
- parse_strv
- set_description
- set_help_enabled
- set_ignore_unknown_options
- set_main_group
- set_strict_posix
- set_summary
- set_translate_func
- set_translation_domain
OptionContext
Object Hierarchy:
Description:
A `GOptionContext` struct defines which options are accepted by the commandline option parser.
The struct has only private fields and should not be directly accessed.
Namespace: GLib
Package: glib-2.0
Content:
Creation methods:
- public OptionContext (string? parameter_string = null)
Methods:
- public void set_summary (string summary)
Adds a string to be displayed in `--help` output before the list of options.
- public unowned string get_summary ()
Returns the summary.
- public void set_description (string description)
Adds a string to be displayed in `--help` output after the list of options.
- public void get_description ()
Returns the description.
- public void set_translate_func (TranslateFunc func, DestroyNotify? destroy_notify)
Sets the function which is used to translate the contexts user-visible strings, for `--help` output.
- public void set_translation_domain (string domain)
A convenience function to use
gettextfor translating user-visible strings. - public bool parse (ref string[] argv) throws OptionError
Parses the command line arguments, recognizing options which have been added to this.
- public bool parse_strv (ref string[] argv) throws OptionError
Parses the command line arguments.
- public void set_help_enabled (bool help_enabled)
Enables or disables automatic generation of `--help` output.
- public bool get_help_enabled ()
Returns whether automatic `--help` generation is turned on for this.
- public void set_ignore_unknown_options (bool ignore_unknown)
Sets whether to ignore unknown options or not.
- public bool get_ignore_unknown_options ()
Returns whether unknown options are ignored or not.
- public string get_help (bool main_help, OptionGroup? group)
Returns a formatted, translated help text for the given context.
- public void add_main_entries (OptionEntry[] entries, string? translation_domain)
A convenience function which creates a main group if it doesn't exist, adds the
entriesto it and sets the translation domain. - public void add_group (owned OptionGroup group)
Adds a OptionGroup to the this, so that parsing with this will recognize the options in the group.
- public void set_main_group (owned OptionGroup group)
Sets a OptionGroup as main group of the this.
- public unowned OptionGroup get_main_group ()
Returns a pointer to the main group of this .
- public void set_strict_posix (bool strict_posix)
- public bool get_strict_posix ()