#include <parameter.h>
Data Fields | |
char * | name |
Unique name. Can contain alphanumeric characters plus underscore. | |
char * | long_name |
Long name (for labels). | |
char * | opt |
ultrashort name (optional for commandline). If missing, the name will be used. | |
char * | gettext_domain |
First argument for bindtextdomain(). In an array, it's valid for subsequent entries too. | |
char * | gettext_directory |
Second argument for bindtextdomain(). In an array, it's valid for subsequent entries too. | |
bg_parameter_type_t | type |
Type. | |
int | flags |
Mask of BG_PARAMETER_* defines. | |
bg_parameter_value_t | val_default |
Default value. | |
bg_parameter_value_t | val_min |
Minimum value (for arithmetic types). | |
bg_parameter_value_t | val_max |
Maximum value (for arithmetic types). | |
char ** | multi_names |
Names for multi option parameters (NULL terminated). | |
char ** | multi_labels |
Optional labels for multi option parameters. | |
char ** | multi_descriptions |
Optional descriptions (will be displayed by info buttons). | |
struct bg_parameter_info_s ** | multi_parameters |
Parameters for each option. The name members of these MUST be unique with respect to the rest of the parameters passed to the same set_parameter func. | |
int | num_digits |
Number of digits for floating point parameters. | |
char * | help_string |
Help strings for tooltips or --help option. |
Usually, parameter infos are passed around as NULL-terminated arrays.
Unique name. Can contain alphanumeric characters plus underscore.
Long name (for labels).
char* bg_parameter_info_t::opt |
ultrashort name (optional for commandline). If missing, the name will be used.
First argument for bindtextdomain(). In an array, it's valid for subsequent entries too.
Second argument for bindtextdomain(). In an array, it's valid for subsequent entries too.
Mask of BG_PARAMETER_* defines.
Default value.
Minimum value (for arithmetic types).
Maximum value (for arithmetic types).
Names for multi option parameters (NULL terminated).
Optional labels for multi option parameters.
Optional descriptions (will be displayed by info buttons).
struct bg_parameter_info_s** bg_parameter_info_t::multi_parameters [read] |
Parameters for each option. The name members of these MUST be unique with respect to the rest of the parameters passed to the same set_parameter func.
Number of digits for floating point parameters.
Help strings for tooltips or --help option.