Synopsis

struct GnomeDbBasicForm

struct GnomeDbBasicForm;

struct GnomeDbBasicFormClass

struct GnomeDbBasicFormClass {

	GtkVBoxClass          parent_class;

	/* signals */
        void       (*param_changed)         (GnomeDbBasicForm *form, GdaParameter *param, gboolean is_user_modif);
};

struct GnomeDbBasicFormPriv

struct GnomeDbBasicFormPriv;

gnome_db_basic_form_new ()

GtkWidget*  gnome_db_basic_form_new         (GdaParameterList *data_set);

Creates a new GnomeDbBasicForm widget using all the parameters provided in paramlist.

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

gnome_db_basic_form_new_custom ()

GtkWidget*  gnome_db_basic_form_new_custom  (GdaParameterList *data_set,
                                             const gchar *glade_file,
                                             const gchar *root_element,
                                             const gchar *form_prefix);

Creates a new GnomeDbBasicForm widget using all the parameters provided in paramlist.

The layout is specified in the glade_file specification, and an entry is created for each node of paramlist.

gnome_db_basic_form_set_current_as_orig ()

void        gnome_db_basic_form_set_current_as_orig
                                            (GnomeDbBasicForm *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 gnome_db_basic_form_has_been_changed() will return FALSE (of course until any entry is changed).

gnome_db_basic_form_is_valid ()

gboolean    gnome_db_basic_form_is_valid    (GnomeDbBasicForm *form);

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

gnome_db_basic_form_get_data_set ()

GdaParameterList* gnome_db_basic_form_get_data_set
                                            (GnomeDbBasicForm *form);

Get a pointer to the GdaParameterList object which is modified by form

gnome_db_basic_form_has_been_changed ()

gboolean    gnome_db_basic_form_has_been_changed
                                            (GnomeDbBasicForm *form);

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

gnome_db_basic_form_show_entries_actions ()

void        gnome_db_basic_form_show_entries_actions
                                            (GnomeDbBasicForm *form,
                                             gboolean show_actions);

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

gnome_db_basic_form_reset ()

void        gnome_db_basic_form_reset       (GnomeDbBasicForm *form);

Resets all the entries in the form to their original values

gnome_db_basic_form_entry_show ()

void        gnome_db_basic_form_entry_show  (GnomeDbBasicForm *form,
                                             GdaParameter *param,
                                             gboolean show);

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

gnome_db_basic_form_entry_set_sensitive ()

void        gnome_db_basic_form_entry_set_sensitive
                                            (GnomeDbBasicForm *form,
                                             GdaParameter *param,
                                             gboolean sensitive);

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

gnome_db_basic_form_set_entries_auto_default ()

void        gnome_db_basic_form_set_entries_auto_default
                                            (GnomeDbBasicForm *form,
                                             gboolean auto_default);

Sets weather all the GnomeDbDataEntry 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.

gnome_db_basic_form_set_entries_default ()

void        gnome_db_basic_form_set_entries_default
                                            (GnomeDbBasicForm *form);

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

gnome_db_basic_form_new_in_dialog ()

GtkWidget*  gnome_db_basic_form_new_in_dialog
                                            (GdaParameterList *data_set,
                                             GtkWindow *parent,
                                             const gchar *title,
                                             const gchar *header);

Creates a new GnomeDbBasicForm widget in the same way as gnome_db_basic_form_new() and puts it into a GtkDialog widget. The returned dialog has the "Ok" and "Cancel" buttons which respectively return GTK_RESPONSE_ACCEPT and GTK_RESPONSE_REJECT.

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

The "param-changed" signal

void        user_function                  (GnomeDbBasicForm *dbbasicform,
                                            GObject *arg1,
                                            gboolean arg2,
                                            gpointer user_data);