bg_parameter_info_s Struct Reference
[Parameter description]

Parmeter description. More...

#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 const *const * multi_names
 Names for multi option parameters (NULL terminated).
char const *const * multi_labels
 Optional labels for multi option parameters.
char const *const * multi_descriptions
 Optional descriptions (will be displayed by info buttons).
struct bg_parameter_info_s
const *const * 
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.
char ** multi_names_nc
 When allocating dynamically, use this instead of multi_names and call bg_parameter_info_set_const_ptrs at the end.
char ** multi_labels_nc
 When allocating dynamically, use this instead of multi_labels and call bg_parameter_info_set_const_ptrs at the end.
char ** multi_descriptions_nc
 When allocating dynamically, use this instead of multi_descriptions and call bg_parameter_info_set_const_ptrs at the end.
struct bg_parameter_info_s ** multi_parameters_nc
 When allocating dynamically, use this instead of multi_parameters and call bg_parameter_info_set_const_ptrs at the end.


Detailed Description

Parmeter description.

Usually, parameter infos are passed around as NULL-terminated arrays.


Field Documentation

char* bg_parameter_info_s::name

Unique name. Can contain alphanumeric characters plus underscore.

char* bg_parameter_info_s::long_name

Long name (for labels).

char* bg_parameter_info_s::opt

ultrashort name (optional for commandline). If missing, the name will be used.

char* bg_parameter_info_s::gettext_domain

First argument for bindtextdomain(). In an array, it's valid for subsequent entries too.

char* bg_parameter_info_s::gettext_directory

Second argument for bindtextdomain(). In an array, it's valid for subsequent entries too.

bg_parameter_type_t bg_parameter_info_s::type

Type.

int bg_parameter_info_s::flags

Mask of BG_PARAMETER_* defines.

bg_parameter_value_t bg_parameter_info_s::val_default

Default value.

bg_parameter_value_t bg_parameter_info_s::val_min

Minimum value (for arithmetic types).

bg_parameter_value_t bg_parameter_info_s::val_max

Maximum value (for arithmetic types).

char const* const* bg_parameter_info_s::multi_names

Names for multi option parameters (NULL terminated).

char const* const* bg_parameter_info_s::multi_labels

Optional labels for multi option parameters.

char const* const* bg_parameter_info_s::multi_descriptions

Optional descriptions (will be displayed by info buttons).

struct bg_parameter_info_s const* const* bg_parameter_info_s::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.

int bg_parameter_info_s::num_digits

Number of digits for floating point parameters.

char* bg_parameter_info_s::help_string

Help strings for tooltips or --help option.

char** bg_parameter_info_s::multi_names_nc

When allocating dynamically, use this instead of multi_names and call bg_parameter_info_set_const_ptrs at the end.

char** bg_parameter_info_s::multi_labels_nc

When allocating dynamically, use this instead of multi_labels and call bg_parameter_info_set_const_ptrs at the end.

char** bg_parameter_info_s::multi_descriptions_nc

When allocating dynamically, use this instead of multi_descriptions and call bg_parameter_info_set_const_ptrs at the end.

struct bg_parameter_info_s** bg_parameter_info_s::multi_parameters_nc [read]

When allocating dynamically, use this instead of multi_parameters and call bg_parameter_info_set_const_ptrs at the end.


The documentation for this struct was generated from the following file:
Generated on Tue Jul 28 01:06:54 2009 for gmerlin by  doxygen 1.5.4