GRASS GIS 8 Programmer's Manual
8.2.2dev(2023)-3d2c704037
|
Structure that stores option information. More...
#include <gis.h>
Data Fields | |
const char * | key |
int | type |
int | required |
int | multiple |
const char * | options |
const char ** | opts |
const char * | key_desc |
const char * | label |
const char * | description |
const char * | descriptions |
const char ** | descs |
char * | answer |
const char * | def |
char ** | answers |
struct Option * | next_opt |
const char * | gisprompt |
const char * | guisection |
const char * | guidependency |
int(* | checker )(const char *) |
int | count |
Structure that stores option information.
The descriptions member contains pairs of option and option descriptions separated by semicolon ';'. For example, when options member is set using:
the descriptions member should be set to:
"break;break lines on intersections;" "rmdupl;remove duplicates"
Parsed descriptions are stored in the same order as options.
GUI dependency is a list of options (separated by commas) to be updated if the value is changed.
Used by the G_parser() system.
char* Option::answer |
Option answer
Definition at line 555 of file gis.h.
Referenced by AS_option_to_algorithm(), check_create_export_opts(), check_create_import_opts(), G_define_standard_option(), G_open_option_file(), G_option_to_separator(), N_define_standard_option(), Rast3d_get_window_params(), Rast3d_set_window_params(), and Rast_option_to_interp_type().
int(* Option::checker) (const char *) |
const char* Option::description |
String describing option
Definition at line 552 of file gis.h.
Referenced by G_define_standard_option(), M_define_option(), N_define_standard_option(), and Rast3d_set_window_params().
const char* Option::descriptions |
';' separated pairs of option and option descriptions
Definition at line 553 of file gis.h.
Referenced by G_define_standard_option().
const char** Option::descs |
const char* Option::gisprompt |
Interactive prompt guidance
Definition at line 559 of file gis.h.
Referenced by G__uses_new_gisprompt(), G_define_standard_option(), G_open_option_file(), G_option_to_separator(), and M_define_option().
const char* Option::guisection |
GUI Layout guidance: ';' delimited hierarchical tree position
Definition at line 560 of file gis.h.
Referenced by M_define_option(), and N_define_standard_option().
const char* Option::key |
Key word used on command line
Definition at line 544 of file gis.h.
Referenced by check_create_export_opts(), check_create_import_opts(), G_define_standard_option(), G_open_option_file(), G_option_to_separator(), G_parser(), M_define_option(), N_define_standard_option(), and Rast3d_set_window_params().
const char* Option::key_desc |
one word describing the key
Definition at line 550 of file gis.h.
Referenced by G_define_standard_option(), M_define_option(), and N_define_standard_option().
const char* Option::label |
Optional short label, used in GUI as item label
Definition at line 551 of file gis.h.
Referenced by G_define_standard_option().
int Option::multiple |
Multiple entries OK
Definition at line 547 of file gis.h.
Referenced by G_define_option(), G_define_standard_option(), G_open_option_file(), M_define_option(), and Rast3d_set_window_params().
struct Option* Option::next_opt |
Pointer to next option struct
Definition at line 558 of file gis.h.
Referenced by G__uses_new_gisprompt().
const char* Option::options |
Approved values or range or NULL
Definition at line 548 of file gis.h.
Referenced by G_define_standard_option(), and N_define_standard_option().
const char** Option::opts |
int Option::required |
REQUIRED or OPTIONAL
Definition at line 546 of file gis.h.
Referenced by G_define_option(), G_define_standard_option(), G_parser(), M_define_option(), N_define_standard_option(), and Rast3d_set_window_params().
int Option::type |
Option type
Definition at line 545 of file gis.h.
Referenced by G_define_standard_option(), M_define_option(), N_define_standard_option(), and Rast3d_set_window_params().