Glib::OptionEntry Class Reference
An OptionEntry defines a single option. More...Public Types | |
| enum | Flags { FLAG_HIDDEN = 1 << 0, FLAG_IN_MAIN = 1 << 1, FLAG_REVERSE = 1 << 2, FLAG_NO_ARG = 1 << 3, FLAG_FILENAME = 1 << 4, FLAG_OPTIONAL_ARG = 1 << 5, FLAG_NOALIAS = 1 << 6 } |
Public Member Functions | |
| OptionEntry () | |
| OptionEntry (const OptionEntry& src) | |
| virtual | ~OptionEntry () |
| OptionEntry& | operator= (const OptionEntry& src) |
| Glib::ustring | get_long_name () const |
| void | set_long_name (const Glib::ustring& value) |
| gchar | get_short_name () const |
| void | set_short_name (const gchar& value) |
| int | get_flags () const |
| void | set_flags (const int& value) |
| Glib::ustring | get_description () const |
| void | set_description (const Glib::ustring& value) |
| Glib::ustring | get_arg_description () const |
| void | set_arg_description (const Glib::ustring& value) |
| GOptionEntry* | gobj () |
| const GOptionEntry* | gobj () const |
Public Attributes | |
| enum Glib::OptionEntry::Flags | GOptionFlags |
Protected Attributes | |
| GOptionEntry* | gobject_ |
Detailed Description
An OptionEntry defines a single option.To have an effect, it must be added to an OptionGroup with OptionGroup::add_entry().
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.
If an option has a short name, it can be specified as -short_name in a commandline.
The description for the option is shown in the --help output.
The arg_descripton is the placeholder to use for the extra argument parsed by the option in --help output.
Member Enumeration Documentation
Constructor & Destructor Documentation
| Glib::OptionEntry::OptionEntry | ( | ) |
| Glib::OptionEntry::OptionEntry | ( | const OptionEntry& | src | ) |
| virtual Glib::OptionEntry::~OptionEntry | ( | ) | [virtual] |
Member Function Documentation
| OptionEntry& Glib::OptionEntry::operator= | ( | const OptionEntry& | src | ) |
| Glib::ustring Glib::OptionEntry::get_long_name | ( | ) | const |
| void Glib::OptionEntry::set_long_name | ( | const Glib::ustring& | value | ) |
| gchar Glib::OptionEntry::get_short_name | ( | ) | const |
| void Glib::OptionEntry::set_short_name | ( | const gchar & | value | ) |
| int Glib::OptionEntry::get_flags | ( | ) | const |
| void Glib::OptionEntry::set_flags | ( | const int & | value | ) |
| Glib::ustring Glib::OptionEntry::get_description | ( | ) | const |
| void Glib::OptionEntry::set_description | ( | const Glib::ustring& | value | ) |
| Glib::ustring Glib::OptionEntry::get_arg_description | ( | ) | const |
| void Glib::OptionEntry::set_arg_description | ( | const Glib::ustring& | value | ) |
| GOptionEntry* Glib::OptionEntry::gobj | ( | ) | [inline] |
| const GOptionEntry* Glib::OptionEntry::gobj | ( | ) | const [inline] |
Member Data Documentation
GOptionEntry* Glib::OptionEntry::gobject_ [protected] |
The documentation for this class was generated from the following file: