GdauiBasicForm

GdauiBasicForm — Form widget mapping the values contained in a GdaSet

Synopsis

                    GdauiBasicForm;
                    GdauiFormLayoutSpec;
GtkWidget *         gdaui_basic_form_new                (GdaSet *data_set);
GtkWidget *         gdaui_basic_form_new_custom         (GdaSet *data_set,
                                                         const gchar *glade_file,
                                                         const gchar *root_element,
                                                         const gchar *form_prefix);
GtkWidget *         gdaui_basic_form_new_in_dialog      (GdaSet *data_set,
                                                         GtkWindow *parent,
                                                         const gchar *title,
                                                         const gchar *header);
GdaSet *            gdaui_basic_form_get_data_set       (GdauiBasicForm *form);
gboolean            gdaui_basic_form_is_valid           (GdauiBasicForm *form);
gboolean            gdaui_basic_form_has_been_changed   (GdauiBasicForm *form);
void                gdaui_basic_form_reset              (GdauiBasicForm *form);
void                gdaui_basic_form_set_current_as_orig
                                                        (GdauiBasicForm *form);
void                gdaui_basic_form_show_entry_actions (GdauiBasicForm *form,
                                                         gboolean show_actions);
void                gdaui_basic_form_entry_show         (GdauiBasicForm *form,
                                                         GdaHolder *param,
                                                         gboolean show);
void                gdaui_basic_form_entry_grab_focus   (GdauiBasicForm *form,
                                                         GdaHolder *param);
void                gdaui_basic_form_entry_set_editable (GdauiBasicForm *form,
                                                         GdaHolder *param,
                                                         gboolean editable);
void                gdaui_basic_form_set_entries_auto_default
                                                        (GdauiBasicForm *form,
                                                         gboolean auto_default);
void                gdaui_basic_form_set_entries_default
                                                        (GdauiBasicForm *form);
GtkWidget *         gdaui_basic_form_get_entry_widget   (GdauiBasicForm *form,
                                                         GdaHolder *param);
GtkWidget *         gdaui_basic_form_get_label_widget   (GdauiBasicForm *form,
                                                         GdaHolder *param);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBox
                                 +----GtkVBox
                                       +----GdauiBasicForm

Implemented Interfaces

GdauiBasicForm implements GtkBuildable, GtkOrientable and AtkImplementorIface.

Properties

  "data-layout"              gpointer              : Write
  "entries-auto-default"     gboolean              : Read / Write
  "headers-sensitive"        gboolean              : Read / Write
  "layout-spec"              gpointer              : Write
  "paramlist"                gpointer              : Read / Write
  "show-actions"             gboolean              : Read / Write

Signals

  "activated"                                      : Run First
  "param-changed"                                  : Run First

Description

Details

GdauiBasicForm

typedef struct _GdauiBasicForm GdauiBasicForm;


GdauiFormLayoutSpec

typedef struct {
#ifdef HAVE_LIBGLADE
	GladeXML *xml_object; /* one of xml_object or */
#endif
	gchar    *xml_file;   /* xml_file is required */

	gchar    *root_element; /* required */
	gchar    *form_prefix;  /* required */
} GdauiFormLayoutSpec;


gdaui_basic_form_new ()

GtkWidget *         gdaui_basic_form_new                (GdaSet *data_set);

Creates a new GdauiBasicForm 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.

data_set :

Returns :

the new widget

gdaui_basic_form_new_custom ()

GtkWidget *         gdaui_basic_form_new_custom         (GdaSet *data_set,
                                                         const gchar *glade_file,
                                                         const gchar *root_element,
                                                         const gchar *form_prefix);

Creates a new GdauiBasicForm 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.

data_set :

glade_file :

a Glade XML file name

root_element :

the name of the top-most widget in glade_file to use in the new form

form_prefix :

the prefix used to look for widgets to add entries in

Returns :

the new widget

gdaui_basic_form_new_in_dialog ()

GtkWidget *         gdaui_basic_form_new_in_dialog      (GdaSet *data_set,
                                                         GtkWindow *parent,
                                                         const gchar *title,
                                                         const gchar *header);

Creates a new GdauiBasicForm widget in the same way as gdaui_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 GdauiBasicForm widget is attached to the dialog using the user property "form".

data_set :

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

gdaui_basic_form_get_data_set ()

GdaSet *            gdaui_basic_form_get_data_set       (GdauiBasicForm *form);

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

form :

a GdauiBasicForm widget

Returns :


gdaui_basic_form_is_valid ()

gboolean            gdaui_basic_form_is_valid           (GdauiBasicForm *form);

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

form :

a GdauiBasicForm widget

Returns :

TRUE if the form is valid

gdaui_basic_form_has_been_changed ()

gboolean            gdaui_basic_form_has_been_changed   (GdauiBasicForm *form);

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

form :

a GdauiBasicForm widget

Returns :


gdaui_basic_form_reset ()

void                gdaui_basic_form_reset              (GdauiBasicForm *form);

Resets all the entries in the form to their original values

form :

a GdauiBasicForm widget

gdaui_basic_form_set_current_as_orig ()

void                gdaui_basic_form_set_current_as_orig
                                                        (GdauiBasicForm *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 gdaui_basic_form_has_been_changed() will return FALSE (of course until any entry is changed).

form :

a GdauiBasicForm widget

gdaui_basic_form_show_entry_actions ()

void                gdaui_basic_form_show_entry_actions (GdauiBasicForm *form,
                                                         gboolean show_actions);

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

form :

a GdauiBasicForm widget

show_actions :

a boolean

gdaui_basic_form_entry_show ()

void                gdaui_basic_form_entry_show         (GdauiBasicForm *form,
                                                         GdaHolder *param,
                                                         gboolean show);

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

form :

a GdauiBasicForm widget

param :

a GdaHolder object

show :


gdaui_basic_form_entry_grab_focus ()

void                gdaui_basic_form_entry_grab_focus   (GdauiBasicForm *form,
                                                         GdaHolder *param);

Makes the data entry corresponding to param grab the focus for the window it's in

form :

a GdauiBasicForm widget

param :

a GdaHolder object

gdaui_basic_form_entry_set_editable ()

void                gdaui_basic_form_entry_set_editable (GdauiBasicForm *form,
                                                         GdaHolder *param,
                                                         gboolean editable);

Sets the GdauiDataEntry in form which corresponds to the param parameter editable or not. If param is NULL, then all the parameters are concerned.

form :

a GdauiBasicForm widget

param :

a GdaHolder object; or NULL

editable :

TRUE if corresponding data entry must be editable

gdaui_basic_form_set_entries_auto_default ()

void                gdaui_basic_form_set_entries_auto_default
                                                        (GdauiBasicForm *form,
                                                         gboolean auto_default);

Sets weather all the GdauiDataEntry 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 GdauiBasicForm widget

auto_default :


gdaui_basic_form_set_entries_default ()

void                gdaui_basic_form_set_entries_default
                                                        (GdauiBasicForm *form);

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

form :

a GdauiBasicForm widget

gdaui_basic_form_get_entry_widget ()

GtkWidget *         gdaui_basic_form_get_entry_widget   (GdauiBasicForm *form,
                                                         GdaHolder *param);

Get the GdauiDataEntry in form which corresponds to the param parameter.

form :

a GdauiBasicForm widget

param :

a GdaHolder object

Returns :

the requested widget, or NULL if not found

gdaui_basic_form_get_label_widget ()

GtkWidget *         gdaui_basic_form_get_label_widget   (GdauiBasicForm *form,
                                                         GdaHolder *param);

Get the label in form which corresponds to the param parameter.

form :

a GdauiBasicForm widget

param :

a GdaHolder object

Returns :

the requested widget, or NULL if not found

Property Details

The "data-layout" property

  "data-layout"              gpointer              : Write


The "entries-auto-default" property

  "entries-auto-default"     gboolean              : Read / Write

Default value: FALSE


The "headers-sensitive" property

  "headers-sensitive"        gboolean              : Read / Write

Default value: FALSE


The "layout-spec" property

  "layout-spec"              gpointer              : Write


The "paramlist" property

  "paramlist"                gpointer              : Read / Write


The "show-actions" property

  "show-actions"             gboolean              : Read / Write

Default value: FALSE

Signal Details

The "activated" signal

void                user_function                      (GdauiBasicForm *gdauibasicform,
                                                        gpointer        user_data)           : Run First

gdauibasicform :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "param-changed" signal

void                user_function                      (GdauiBasicForm *form,
                                                        GdaHolder      *param,
                                                        gboolean        is_user_modif,
                                                        gpointer        user_data)          : Run First

Emitted when a GdaHolder changes

form :

GdauiBasicForm

param :

that changed

is_user_modif :

TRUE if the modification has been initiated by a user modification

user_data :

user data set when the signal handler was connected.