program-parameter

program-parameter

Synopsis

void                gebr_geoxml_program_parameter_set_required
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean required);
gboolean            gebr_geoxml_program_parameter_get_required
                                                        (GebrGeoXmlProgramParameter *program_parameter);
void                gebr_geoxml_program_parameter_set_keyword
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *keyword);
gchar *             gebr_geoxml_program_parameter_get_keyword
                                                        (GebrGeoXmlProgramParameter *program_parameter);
void                gebr_geoxml_program_parameter_set_be_list
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean is_list);
void                gebr_geoxml_program_parameter_set_list_separator
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *separator);
void                gebr_geoxml_program_parameter_set_first_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value,
                                                         const gchar *value);
void                gebr_geoxml_program_parameter_set_first_boolean_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value,
                                                         gboolean enabled);
gchar *             gebr_geoxml_program_parameter_get_list_separator
                                                        (GebrGeoXmlProgramParameter *program_parameter);
gchar *             gebr_geoxml_program_parameter_get_first_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value);
gboolean            gebr_geoxml_program_parameter_get_first_boolean_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value);
GebrGeoXmlPropertyValue * gebr_geoxml_program_parameter_append_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value);
int                 gebr_geoxml_program_parameter_get_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value,
                                                         GebrGeoXmlSequence **property_value,
                                                         gulong index);
glong               gebr_geoxml_program_parameter_get_values_number
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value);
void                gebr_geoxml_program_parameter_set_string_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value,
                                                         const gchar *value);
GString *           gebr_geoxml_program_parameter_get_string_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value);
gboolean            gebr_geoxml_program_parameter_is_set
                                                        (GebrGeoXmlProgramParameter *self);
GebrGeoXmlProgramParameter * gebr_geoxml_program_parameter_find_dict_parameter
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         GebrGeoXmlDocument *dict_document);
gboolean            gebr_geoxml_program_parameter_copy_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         GebrGeoXmlProgramParameter *source,
                                                         gboolean default_value);
void                gebr_geoxml_program_parameter_set_parse_list_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value,
                                                         const gchar *value);
void                gebr_geoxml_program_parameter_set_value_from_dict
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         GebrGeoXmlProgramParameter *dict_parameter);
void                gebr_geoxml_program_parameter_set_file_be_directory
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean is_directory);
gboolean            gebr_geoxml_program_parameter_get_file_be_directory
                                                        (GebrGeoXmlProgramParameter *program_parameter);
void                gebr_geoxml_program_parameter_set_file_filter
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *name,
                                                         const gchar *pattern);
void                gebr_geoxml_program_parameter_get_file_filter
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar **name,
                                                         const gchar **pattern);
void                gebr_geoxml_program_parameter_set_number_min_max
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *min,
                                                         const gchar *max);
void                gebr_geoxml_program_parameter_get_number_min_max
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar **min,
                                                         const gchar **max);
void                gebr_geoxml_program_parameter_set_range_properties
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *min,
                                                         const gchar *max,
                                                         const gchar *inc,
                                                         const gchar *digits);
void                gebr_geoxml_program_parameter_get_range_properties
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar **min,
                                                         const gchar **max,
                                                         const gchar **inc,
                                                         const gchar **digits);
gboolean            gebr_geoxml_program_parameter_get_is_list
                                                        (GebrGeoXmlProgramParameter *program_parameter);
GebrGeoXmlEnumOption * gebr_geoxml_program_parameter_append_enum_option
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *label,
                                                         const gchar *value);
int                 gebr_geoxml_program_parameter_get_enum_option
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         GebrGeoXmlSequence **enum_option,
                                                         gulong index);
glong               gebr_geoxml_program_parameter_get_enum_options_number
                                                        (GebrGeoXmlProgramParameter *program_parameter);
gboolean            gebr_geoxml_program_parameter_is_var_used
                                                        (GebrGeoXmlProgramParameter *self,
                                                         const gchar *var_name);
gchar *             gebr_geoxml_program_parameter_get_old_dict_keyword
                                                        (GebrGeoXmlProgramParameter *program_parameter);
gboolean            gebr_geoxml_program_parameter_update_old_dict_value
                                                        (GebrGeoXmlObject *param,
                                                         gpointer keys_to_canonized);
gboolean            gebr_geoxml_program_parameter_has_value
                                                        (GebrGeoXmlProgramParameter *self);

Description

Details

gebr_geoxml_program_parameter_set_required ()

void                gebr_geoxml_program_parameter_set_required
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean required);

gebr_geoxml_program_parameter_get_required ()

gboolean            gebr_geoxml_program_parameter_get_required
                                                        (GebrGeoXmlProgramParameter *program_parameter);

gebr_geoxml_program_parameter_set_keyword ()

void                gebr_geoxml_program_parameter_set_keyword
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *keyword);

gebr_geoxml_program_parameter_get_keyword ()

gchar *             gebr_geoxml_program_parameter_get_keyword
                                                        (GebrGeoXmlProgramParameter *program_parameter);

gebr_geoxml_program_parameter_set_be_list ()

void                gebr_geoxml_program_parameter_set_be_list
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean is_list);

gebr_geoxml_program_parameter_set_list_separator ()

void                gebr_geoxml_program_parameter_set_list_separator
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *separator);

gebr_geoxml_program_parameter_set_first_value ()

void                gebr_geoxml_program_parameter_set_first_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value,
                                                         const gchar *value);

gebr_geoxml_program_parameter_set_first_boolean_value ()

void                gebr_geoxml_program_parameter_set_first_boolean_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value,
                                                         gboolean enabled);

gebr_geoxml_program_parameter_get_list_separator ()

gchar *             gebr_geoxml_program_parameter_get_list_separator
                                                        (GebrGeoXmlProgramParameter *program_parameter);

gebr_geoxml_program_parameter_get_first_value ()

gchar *             gebr_geoxml_program_parameter_get_first_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value);

gebr_geoxml_program_parameter_get_first_boolean_value ()

gboolean            gebr_geoxml_program_parameter_get_first_boolean_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value);

gebr_geoxml_program_parameter_append_value ()

GebrGeoXmlPropertyValue * gebr_geoxml_program_parameter_append_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value);

gebr_geoxml_program_parameter_get_value ()

int                 gebr_geoxml_program_parameter_get_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value,
                                                         GebrGeoXmlSequence **property_value,
                                                         gulong index);

gebr_geoxml_program_parameter_get_values_number ()

glong               gebr_geoxml_program_parameter_get_values_number
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value);

gebr_geoxml_program_parameter_set_string_value ()

void                gebr_geoxml_program_parameter_set_string_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value,
                                                         const gchar *value);

If program_parameter has a list of values, call gebr_geoxml_program_parameter_set_parse_list_value(), otherwise call gebr_geoxml_program_parameter_set_first_value().

If program_parameter or value is NULL nothing is done.


gebr_geoxml_program_parameter_get_string_value ()

GString *           gebr_geoxml_program_parameter_get_string_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value);

gebr_geoxml_program_parameter_is_set ()

gboolean            gebr_geoxml_program_parameter_is_set
                                                        (GebrGeoXmlProgramParameter *self);

gebr_geoxml_program_parameter_find_dict_parameter ()

GebrGeoXmlProgramParameter * gebr_geoxml_program_parameter_find_dict_parameter
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         GebrGeoXmlDocument *dict_document);

gebr_geoxml_program_parameter_copy_value ()

gboolean            gebr_geoxml_program_parameter_copy_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         GebrGeoXmlProgramParameter *source,
                                                         gboolean default_value);

gebr_geoxml_program_parameter_set_parse_list_value ()

void                gebr_geoxml_program_parameter_set_parse_list_value
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean default_value,
                                                         const gchar *value);

gebr_geoxml_program_parameter_set_value_from_dict ()

void                gebr_geoxml_program_parameter_set_value_from_dict
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         GebrGeoXmlProgramParameter *dict_parameter);

gebr_geoxml_program_parameter_set_file_be_directory ()

void                gebr_geoxml_program_parameter_set_file_be_directory
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         gboolean is_directory);

gebr_geoxml_program_parameter_get_file_be_directory ()

gboolean            gebr_geoxml_program_parameter_get_file_be_directory
                                                        (GebrGeoXmlProgramParameter *program_parameter);

gebr_geoxml_program_parameter_set_file_filter ()

void                gebr_geoxml_program_parameter_set_file_filter
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *name,
                                                         const gchar *pattern);

gebr_geoxml_program_parameter_get_file_filter ()

void                gebr_geoxml_program_parameter_get_file_filter
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar **name,
                                                         const gchar **pattern);

gebr_geoxml_program_parameter_set_number_min_max ()

void                gebr_geoxml_program_parameter_set_number_min_max
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *min,
                                                         const gchar *max);

gebr_geoxml_program_parameter_get_number_min_max ()

void                gebr_geoxml_program_parameter_get_number_min_max
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar **min,
                                                         const gchar **max);

Get the minimum and maximum values for integer, float and range parameters type. If there is no minimum or maximum value, returns an empty string.

min :

return location for the minimum value, or NULL. [out]

max :

return location for the maximum value, or NULL. [out]

gebr_geoxml_program_parameter_set_range_properties ()

void                gebr_geoxml_program_parameter_set_range_properties
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *min,
                                                         const gchar *max,
                                                         const gchar *inc,
                                                         const gchar *digits);

gebr_geoxml_program_parameter_get_range_properties ()

void                gebr_geoxml_program_parameter_get_range_properties
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar **min,
                                                         const gchar **max,
                                                         const gchar **inc,
                                                         const gchar **digits);

gebr_geoxml_program_parameter_get_is_list ()

gboolean            gebr_geoxml_program_parameter_get_is_list
                                                        (GebrGeoXmlProgramParameter *program_parameter);

gebr_geoxml_program_parameter_append_enum_option ()

GebrGeoXmlEnumOption * gebr_geoxml_program_parameter_append_enum_option
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         const gchar *label,
                                                         const gchar *value);

gebr_geoxml_program_parameter_get_enum_option ()

int                 gebr_geoxml_program_parameter_get_enum_option
                                                        (GebrGeoXmlProgramParameter *program_parameter,
                                                         GebrGeoXmlSequence **enum_option,
                                                         gulong index);

gebr_geoxml_program_parameter_get_enum_options_number ()

glong               gebr_geoxml_program_parameter_get_enum_options_number
                                                        (GebrGeoXmlProgramParameter *program_parameter);

gebr_geoxml_program_parameter_is_var_used ()

gboolean            gebr_geoxml_program_parameter_is_var_used
                                                        (GebrGeoXmlProgramParameter *self,
                                                         const gchar *var_name);

gebr_geoxml_program_parameter_get_old_dict_keyword ()

gchar *             gebr_geoxml_program_parameter_get_old_dict_keyword
                                                        (GebrGeoXmlProgramParameter *program_parameter);

program_parameter :

The parameter to query the dict keyword.

Returns :

the program parameter dict keyword, NULL if it does not exists.

gebr_geoxml_program_parameter_update_old_dict_value ()

gboolean            gebr_geoxml_program_parameter_update_old_dict_value
                                                        (GebrGeoXmlObject *param,
                                                         gpointer keys_to_canonized);

This function updates a program parameter to use a canonized dict var, insted of the old dict var.

Returs TRUE if everythin goes fine.

param :

The parameter to be updated.

keys_to_canonized :

A GHashTable with orininal dict key => canonized dict key.

gebr_geoxml_program_parameter_has_value ()

gboolean            gebr_geoxml_program_parameter_has_value
                                                        (GebrGeoXmlProgramParameter *self);

Returns :

TRUE if self has a non-empty value.