| Libmergeant Reference Manual |
|---|
#define MG_FORM_TYPE #define MG_FORM (obj) #define IS_MG_FORM (obj) #define MG_FORM_CLASS (klass) struct MgForm; guint mg_form_get_type (void); GtkWidget* mg_form_new (MgConf *conf, MgContext *context); GtkWidget* mg_form_new_in_dialog (MgConf *conf, MgContext *context, GtkWindow *parent, const gchar *title, const gchar *header); gboolean mg_form_is_valid (MgForm *form); gboolean mg_form_has_been_changed (MgForm *form); void mg_form_reset (MgForm *form); void mg_form_show_entries_actions (MgForm *form, gboolean show_actions); void mg_form_show_entry (MgForm *form, MgParameter *param, gboolean show); void mg_form_set_entries_auto_default (MgForm *form, gboolean auto_default); void mg_form_set_entries_default (MgForm *form);
GObject
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBox
+----GtkVBox
+----MgForm"param-changed" void user_function (MgForm *mgform, GObject *arg1, gpointer user_data);
#define MG_FORM_CLASS(klass) G_TYPE_CHECK_CLASS_CAST (klass, mg_form_get_type (), MgFormClass)
| klass : |
|
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.
| conf : | a MgConf object |
| context : | a MgContext structure |
| Returns : | the new widget |
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".
| conf : | a MgConf object |
| context : | a MgContext structure |
| parent : | the parent window for the new dialog, or NULL |
| title : | the title of the dialog window, or NULL |
| header : | a helper text displayed at the top of the dialog, or NULL |
| Returns : | the new GtkDialog widget |
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)
| form : | a MgForm widget |
| Returns : | TRUE if the form is valid |
gboolean mg_form_has_been_changed (MgForm *form);
Tells if the form has had at least on entry changed, or not
| form : | a MgForm widget |
| Returns : |
void mg_form_reset (MgForm *form);
Resets all the entries in the form to their original values
| form : | a MgForm widget |
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
| form : | a MgForm widget |
| show_actions : |
|
void mg_form_show_entry (MgForm *form, MgParameter *param, gboolean show);
Shows or hides the MgDataEntry in form which corresponds to the param parameter
| form : | a MgForm widget |
| param : | a MgParameter object |
| show : |
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).
| form : | a MgForm widget |
| auto_default : |
void user_function (MgForm *mgform, GObject *arg1, gpointer user_data);
| mgform : | the object which received the signal. |
| arg1 : | |
| user_data : | user data set when the signal handler was connected. |
| <<< MgDbmsUpdateViewer | Data handlers >>> |