MgForm

typedef struct _MgForm MgForm;

mg_form_get_type ()

guint       mg_form_get_type                (void);

mg_form_new ()

GtkWidget*  mg_form_new                     (MgConf *conf,
                                             MgContext *context);

Creates a new MgForm widget using all the parameters provided in context. context is copied in the process.

The global layout is rendered using a table (a GtkTable), and an entry is created for each node of context.

mg_form_new_in_layout ()

GtkWidget*  mg_form_new_in_layout           (MgConf *conf,
                                             MgContext *context,
                                             GtkWidget *layout,
                                             GHashTable *box_widgets);

Creates a new MgForm widget using all the parameters provided in context. context is copied in the process.

This function is identical to mg_form_new() except that the layout is not done using a table, but using the layout widget; and each entry is packed into one of the GtkBox widgets of box_widgets (specifically each entry corresponds to a MgContextNode of context, and that context node is used a the key to box_widgets to find the box to pack the entry in).

If any of layout or box_widgets is NULL, then this function is equivalent to mg_form_new().

mg_form_new_in_dialog ()

GtkWidget*  mg_form_new_in_dialog           (MgConf *conf,
                                             MgContext *context,
                                             GtkWindow *parent,
                                             const gchar *title,
                                             const gchar *header);

Creates a new MgForm widget in the same way as mg_form_new() and puts it into a GtkDialog widget.

The MgForm widget is attached to the dialog using the user property "form".

mg_form_is_valid ()

gboolean    mg_form_is_valid                (MgForm *form);

Tells if the form can be used as-is (if all the parameters do have some valid values)

mg_form_has_been_changed ()

gboolean    mg_form_has_been_changed        (MgForm *form);

Tells if the form has had at least on entry changed, or not

mg_form_set_current_as_orig ()

void        mg_form_set_current_as_orig     (MgForm *form);

Tells form that the current values in the different entries are to be considered as the original values for all the entries; the immediate consequence is that any sub-sequent call to mg_form_has_been_changed() will return FALSE (of course until any entry is changed).

mg_form_reset ()

void        mg_form_reset                   (MgForm *form);

Resets all the entries in the form to their original values

mg_form_show_entries_actions ()

void        mg_form_show_entries_actions    (MgForm *form,
                                             gboolean show_actions);

Show or hide the actions button available at the end of each data entry in the form

mg_form_entry_show ()

void        mg_form_entry_show              (MgForm *form,
                                             MgParameter *param,
                                             gboolean show);

Shows or hides the MgDataEntry in form which corresponds to the param parameter

mg_form_entry_set_sensitive ()

void        mg_form_entry_set_sensitive     (MgForm *form,
                                             MgParameter *param,
                                             gboolean sensitive);

Shows or hides the MgDataEntry in form which corresponds to the param parameter

mg_form_set_entries_auto_default ()

void        mg_form_set_entries_auto_default
                                            (MgForm *form,
                                             gboolean auto_default);

Sets weather all the MgDataEntry entries in the form must default to a default value if they are assigned a non valid value. Depending on the real type of entry, it will provide a default value which the user does not need to modify if it is OK.

For example a date entry can by default display the current date.

mg_form_set_entries_default ()

void        mg_form_set_entries_default     (MgForm *form);

For each entry in the form, sets it to a default value if it is possible to do so.

The "param-changed" signal

void        user_function                  (MgForm  *mgform,
                                            GObject *arg1,
                                            gboolean arg2,
                                            gpointer user_data)      : Run first