GeoGen Development snapshot a3
|
Go to the source code of this file.
Functions | |
void | GGen_AddBoolArg (const GGen_String &name, const GGen_String &label, const GGen_String &description, bool default_value) |
void | GGen_AddEnumArg (const GGen_String &name, const GGen_String &label, const GGen_String &description, int default_value, const GGen_String &options) |
void | GGen_AddIntArg (const GGen_String &name, const GGen_String &label, const GGen_String &description, int default_value, int min_value, int max_value, int step_size) |
int | GGen_GetArgValue (const GGen_String &name) |
Contains functions working with script arguments.
void GGen_AddBoolArg | ( | const GGen_String & | name, |
const GGen_String & | label, | ||
const GGen_String & | description, | ||
bool | default_value | ||
) |
Defines a new boolean script argument. Can be called only within script header.
name | Unique internal name. |
label | Label (name presented to users). |
description | Detailed description. |
default_value | Default value. |
void GGen_AddEnumArg | ( | const GGen_String & | name, |
const GGen_String & | label, | ||
const GGen_String & | description, | ||
int | default_value, | ||
const GGen_String & | options | ||
) |
Defines a new enumeration script argument. Can be called only within script header.
name | Unique internal name. |
label | Label (name presented to users). |
description | Detailed description. |
default_value | Default value (index of default option starting at 0). |
options | Semicolon-separated list of options. |
void GGen_AddIntArg | ( | const GGen_String & | name, |
const GGen_String & | label, | ||
const GGen_String & | description, | ||
int | default_value, | ||
int | min_value, | ||
int | max_value, | ||
int | step_size | ||
) |
Defines a new integral script argument. Can be called only within script header.
name | Unique internal name. |
label | Label (name presented to users). |
description | Detailed description. |
default_value | Default value. |
min_value | Minimum value. |
max_value | Maximum value. |
step_size | Step size (UI only - represents value change for various up/down arrows or sliders). This setting will not be enforced - user can be allowed to manually type in values between steps. |
int GGen_GetArgValue | ( | const GGen_String & | name | ) |
Returns value of one script argument. Can be called only within script body.
name | Name of the argument. |