Glib::OptionEntry Class Reference
An OptionEntry defines a single option. More...
List of all members.
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
- Enumerator:
FLAG_HIDDEN |
|
FLAG_IN_MAIN |
|
FLAG_REVERSE |
|
FLAG_NO_ARG |
|
FLAG_FILENAME |
|
FLAG_OPTIONAL_ARG |
|
FLAG_NOALIAS |
|
Constructor & Destructor Documentation
Glib::OptionEntry::OptionEntry |
( |
|
) |
|
Glib::OptionEntry::OptionEntry |
( |
const OptionEntry& |
src |
) |
|
virtual Glib::OptionEntry::~OptionEntry |
( |
|
) |
[virtual] |
Member Function Documentation
int Glib::OptionEntry::get_flags |
( |
|
) |
const |
gchar Glib::OptionEntry::get_short_name |
( |
|
) |
const |
const GOptionEntry* Glib::OptionEntry::gobj |
( |
|
) |
const [inline] |
GOptionEntry* Glib::OptionEntry::gobj |
( |
|
) |
[inline] |
void Glib::OptionEntry::set_arg_description |
( |
const Glib::ustring& |
value |
) |
|
void Glib::OptionEntry::set_description |
( |
const Glib::ustring& |
value |
) |
|
void Glib::OptionEntry::set_flags |
( |
const int & |
value |
) |
|
void Glib::OptionEntry::set_long_name |
( |
const Glib::ustring& |
value |
) |
|
void Glib::OptionEntry::set_short_name |
( |
const gchar & |
value |
) |
|
Member Data Documentation
The documentation for this class was generated from the following file: