OptionContext

---

Object Hierarchy:

Description:

Content:

Creation methods:

• public OptionContext (string? parameter_string = null)

Methods:

• 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 add_main_entries (OptionEntry[] entries, string? translation_domain)
  A convenience function which creates a main group if it doesn't exist, adds the entries to it and sets the translation domain.
• public unowned string get_description ()
  Returns the description.
• public string get_help (bool main_help, OptionGroup? group)
  Returns a formatted, translated help text for the given context.
• public bool get_help_enabled ()
  Returns whether automatic `--help` generation is turned on for this.
• public bool get_ignore_unknown_options ()
  Returns whether unknown options are ignored or not.
• public unowned OptionGroup get_main_group ()
  Returns a pointer to the main group of this .
• public bool get_strict_posix ()
  Returns whether strict POSIX code is enabled.
• public unowned string get_summary ()
  Returns the summary.
• public bool parse (ref unowned 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_description (string description)
  Adds a string to be displayed in `--help` output after the list of options.
• public void set_help_enabled (bool help_enabled)
  Enables or disables automatic generation of `--help` output.
• public void set_ignore_unknown_options (bool ignore_unknown)
  Sets whether to ignore unknown options or not.
• public void set_main_group (owned OptionGroup group)
  Sets a OptionGroup as main group of the this.
• public void set_strict_posix (bool strict_posix)
  Sets strict POSIX mode.
• public void set_summary (string summary)
  Adds a string to be displayed in `--help` output before the list of options.
• 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 gettext for translating user-visible strings.