parameter

parameter

Synopsis

#define             GEBR_GEOXML_PARAMETER               (super)
typedef             GebrGeoXmlParameter;
enum                GebrGeoXmlParameterType;
GebrGeoXmlParameters* gebr_geoxml_parameter_get_parameters
                                                        (GebrGeoXmlParameter *parameter);
gboolean            gebr_geoxml_parameter_set_type      (GebrGeoXmlParameter *parameter,
                                                         GebrGeoXmlParameterType type);
int                 gebr_geoxml_parameter_set_be_reference
                                                        (GebrGeoXmlParameter *parameter,
                                                         GebrGeoXmlParameter *reference);
GebrGeoXmlParameterType gebr_geoxml_parameter_get_type  (GebrGeoXmlParameter *parameter);
const gchar*        gebr_geoxml_parameter_get_type_name (GebrGeoXmlParameter *parameter);
gboolean            gebr_geoxml_parameter_get_is_reference
                                                        (GebrGeoXmlParameter *parameter);
GebrGeoXmlParameter* gebr_geoxml_parameter_get_referencee
                                                        (GebrGeoXmlParameter *parameter_reference);
gboolean            gebr_geoxml_parameter_get_is_program_parameter
                                                        (GebrGeoXmlParameter *parameter);
void                gebr_geoxml_parameter_set_label     (GebrGeoXmlParameter *parameter,
                                                         const gchar *label);
const gchar*        gebr_geoxml_parameter_get_label     (GebrGeoXmlParameter *parameter);
gboolean            gebr_geoxml_parameter_get_is_in_group
                                                        (GebrGeoXmlParameter *parameter);
GebrGeoXmlParameterGroup* gebr_geoxml_parameter_get_group
                                                        (GebrGeoXmlParameter *parameter);
void                gebr_geoxml_parameter_reset         (GebrGeoXmlParameter *parameter,
                                                         gboolean recursive);

Description

A longer description goes here.

Details

GEBR_GEOXML_PARAMETER()

#define GEBR_GEOXML_PARAMETER(super) ((GebrGeoXmlParameter*)(super))

GebrGeoXmlParameter

typedef struct gebr_geoxml_parameter GebrGeoXmlParameter;

enum GebrGeoXmlParameterType

typedef enum {
	/**
	 * In case of error.
	 */
	GEBR_GEOXML_PARAMETER_TYPE_UNKNOWN = 0,
	/**
	 * A parameter able to store a string on it.
	 */
	GEBR_GEOXML_PARAMETER_TYPE_STRING,
	/**
	 * A parameter able to store an integer number on it.
	 */
	GEBR_GEOXML_PARAMETER_TYPE_INT,
	/**
	 * A parameter able to store a file/directory path on it.
	 */
	GEBR_GEOXML_PARAMETER_TYPE_FILE,
	/**
	 * A parameter able to store the state of a flag on it.
	 */
	GEBR_GEOXML_PARAMETER_TYPE_FLAG,
	/**
	 * A parameter able to store a floating point number on it.
	 */
	GEBR_GEOXML_PARAMETER_TYPE_FLOAT,
	/**
	 * A parameter able to store a number with maximum and minimum values on it.
	 */
	GEBR_GEOXML_PARAMETER_TYPE_RANGE,
	/**
	 * A parameter able to store a value in a list options.
	 */
	GEBR_GEOXML_PARAMETER_TYPE_ENUM,
	/**
	 * A sequence of parameters.
	 */
	GEBR_GEOXML_PARAMETER_TYPE_GROUP,
	/**
	 * A reference to other parameter. If the referenced parameter is a program parameter,
	 * then this parameter will only have its value as a difference.
	 */
	GEBR_GEOXML_PARAMETER_TYPE_REFERENCE,
} GebrGeoXmlParameterType;

gebr_geoxml_parameter_get_parameters ()

GebrGeoXmlParameters* gebr_geoxml_parameter_get_parameters
                                                        (GebrGeoXmlParameter *parameter);

gebr_geoxml_parameter_set_type ()

gboolean            gebr_geoxml_parameter_set_type      (GebrGeoXmlParameter *parameter,
                                                         GebrGeoXmlParameterType type);

gebr_geoxml_parameter_set_be_reference ()

int                 gebr_geoxml_parameter_set_be_reference
                                                        (GebrGeoXmlParameter *parameter,
                                                         GebrGeoXmlParameter *reference);

gebr_geoxml_parameter_get_type ()

GebrGeoXmlParameterType gebr_geoxml_parameter_get_type  (GebrGeoXmlParameter *parameter);

gebr_geoxml_parameter_get_type_name ()

const gchar*        gebr_geoxml_parameter_get_type_name (GebrGeoXmlParameter *parameter);

gebr_geoxml_parameter_get_is_reference ()

gboolean            gebr_geoxml_parameter_get_is_reference
                                                        (GebrGeoXmlParameter *parameter);

gebr_geoxml_parameter_get_referencee ()

GebrGeoXmlParameter* gebr_geoxml_parameter_get_referencee
                                                        (GebrGeoXmlParameter *parameter_reference);

gebr_geoxml_parameter_get_is_program_parameter ()

gboolean            gebr_geoxml_parameter_get_is_program_parameter
                                                        (GebrGeoXmlParameter *parameter);

gebr_geoxml_parameter_set_label ()

void                gebr_geoxml_parameter_set_label     (GebrGeoXmlParameter *parameter,
                                                         const gchar *label);

gebr_geoxml_parameter_get_label ()

const gchar*        gebr_geoxml_parameter_get_label     (GebrGeoXmlParameter *parameter);

gebr_geoxml_parameter_get_is_in_group ()

gboolean            gebr_geoxml_parameter_get_is_in_group
                                                        (GebrGeoXmlParameter *parameter);

gebr_geoxml_parameter_get_group ()

GebrGeoXmlParameterGroup* gebr_geoxml_parameter_get_group
                                                        (GebrGeoXmlParameter *parameter);

gebr_geoxml_parameter_reset ()

void                gebr_geoxml_parameter_reset         (GebrGeoXmlParameter *parameter,
                                                         gboolean recursive);