gebr-gui-param

gebr-gui-param

Synopsis

struct              GebrGuiParam;
                    GebrGuiParamPriv;
void                (*GebrGuiParameterValidatedFunc)    (GebrGuiParam *widget,
                                                         gpointer user_data);
void                (*changed_callback)                 (GebrGuiParam *widget,
                                                         gpointer user_data);
void                gebr_gui_group_validate             (GebrValidator *validator,
                                                         GebrGeoXmlParameter *parameter,
                                                         GtkWidget *icon);
gboolean            gebr_gui_param_match_completion     (GtkEntryCompletion *completion,
                                                         const gchar *key,
                                                         GtkTreeIter *iter,
                                                         gpointer user_data);
GebrGuiParam *      gebr_gui_param_new                  (GebrGeoXmlParameter *parameter,
                                                         GebrValidator *validator,
                                                         GebrMaestroInfo *info,
                                                         gboolean use_default_value,
                                                         GebrGuiCompleteVariables *complete_var,
                                                         gpointer data);
void                gebr_gui_param_reconfigure          (GebrGuiParam *parameter_widget);
void                gebr_gui_param_set_auto_submit_callback
                                                        (GebrGuiParam *parameter_widget,
                                                         changed_callback callback,
                                                         gpointer user_data);
void                gebr_gui_param_set_readonly         (GebrGuiParam *parameter_widget,
                                                         gboolean readonly);
void                gebr_gui_param_set_validated_callback
                                                        (GebrGuiParam *widget,
                                                         GebrGuiParameterValidatedFunc callback,
                                                         gpointer user_data);
void                gebr_gui_param_update               (GebrGuiParam *parameter_widget);
void                gebr_gui_param_update_list_separator
                                                        (GebrGuiParam *parameter_widget);
gboolean            gebr_gui_param_validate             (GebrGuiParam *parameter_widget);
GtkWidget *         gebr_gui_parameter_add_variables_popup
                                                        (GtkEntry *entry,
                                                         GebrGeoXmlDocument *flow,
                                                         GebrGeoXmlDocument *line,
                                                         GebrGeoXmlDocument *proj,
                                                         GebrGeoXmlParameterType type);
void                gebr_gui_parameter_set_entry_completion
                                                        (GtkEntry *entry,
                                                         GtkTreeModel *model,
                                                         GebrGeoXmlParameterType type);

Description

Details

struct GebrGuiParam

struct GebrGuiParam {
	GebrGuiParamPriv *priv;
};

GebrGuiParamPriv

typedef struct _GebrGuiParamPriv GebrGuiParamPriv;

GebrGuiParameterValidatedFunc ()

void                (*GebrGuiParameterValidatedFunc)    (GebrGuiParam *widget,
                                                         gpointer user_data);

changed_callback ()

void                (*changed_callback)                 (GebrGuiParam *widget,
                                                         gpointer user_data);

gebr_gui_group_validate ()

void                gebr_gui_group_validate             (GebrValidator *validator,
                                                         GebrGeoXmlParameter *parameter,
                                                         GtkWidget *icon);

gebr_gui_param_match_completion ()

gboolean            gebr_gui_param_match_completion     (GtkEntryCompletion *completion,
                                                         const gchar *key,
                                                         GtkTreeIter *iter,
                                                         gpointer user_data);

gebr_gui_param_new ()

GebrGuiParam *      gebr_gui_param_new                  (GebrGeoXmlParameter *parameter,
                                                         GebrValidator *validator,
                                                         GebrMaestroInfo *info,
                                                         gboolean use_default_value,
                                                         GebrGuiCompleteVariables *complete_var,
                                                         gpointer data);

gebr_gui_param_reconfigure ()

void                gebr_gui_param_reconfigure          (GebrGuiParam *parameter_widget);

gebr_gui_param_set_auto_submit_callback ()

void                gebr_gui_param_set_auto_submit_callback
                                                        (GebrGuiParam *parameter_widget,
                                                         changed_callback callback,
                                                         gpointer user_data);

gebr_gui_param_set_readonly ()

void                gebr_gui_param_set_readonly         (GebrGuiParam *parameter_widget,
                                                         gboolean readonly);

gebr_gui_param_set_validated_callback ()

void                gebr_gui_param_set_validated_callback
                                                        (GebrGuiParam *widget,
                                                         GebrGuiParameterValidatedFunc callback,
                                                         gpointer user_data);

Registers callback to be called when this parameter validates.


gebr_gui_param_update ()

void                gebr_gui_param_update               (GebrGuiParam *parameter_widget);

gebr_gui_param_update_list_separator ()

void                gebr_gui_param_update_list_separator
                                                        (GebrGuiParam *parameter_widget);

gebr_gui_param_validate ()

gboolean            gebr_gui_param_validate             (GebrGuiParam *parameter_widget);

Set tooltip errors and icons for parameter_widget. If the parameter is numeric and have minimum/maximum values, clamp the value.

parameter_widget :

The parameter widget to be validated

Returns :

TRUE if the parameter was valid, FALSE otherwise.

gebr_gui_parameter_add_variables_popup ()

GtkWidget *         gebr_gui_parameter_add_variables_popup
                                                        (GtkEntry *entry,
                                                         GebrGeoXmlDocument *flow,
                                                         GebrGeoXmlDocument *line,
                                                         GebrGeoXmlDocument *proj,
                                                         GebrGeoXmlParameterType type);

Creates a popup menu with compatible variables for entry.

Returns :

a GtkMenu

gebr_gui_parameter_set_entry_completion ()

void                gebr_gui_parameter_set_entry_completion
                                                        (GtkEntry *entry,
                                                         GtkTreeModel *model,
                                                         GebrGeoXmlParameterType type);