libgda-uimm: Gnome::GdaUI::BasicForm Class Reference

BasicForm - Form widget mapping the values contained in a Gnome::Gda::Set. More...

#include <libgda-uimm/basicform.h>

Inheritance diagram for Gnome::GdaUI::BasicForm:

Public Member Functions
virtual	~BasicForm ()
GdauiBasicForm*	gobj ()
	Provides access to the underlying C GtkObject.
const GdauiBasicForm*	gobj () const
	Provides access to the underlying C GtkObject.
	BasicForm (const Glib::RefPtr< Gnome::Gda::Set >& data_set)
	Creates a new Gdaui::BasicForm widget using all the Gda::Holder objects provided in data_set.
	BasicForm (const Glib::RefPtr< Gnome::Gda::Set >& data_set, Gtk::Window* parent, const Glib::ustring& title, const Glib::ustring& header)
	Creates a new Gdaui::BasicForm widget in the same way as new() and puts it into a Gtk::Dialog widget.
Glib::RefPtr< Gnome::Gda::Set >	get_data_set ()
	Get a pointer to the Gda::Set object which is modified by form.
Glib::RefPtr< const Gnome::Gda::Set >	get_data_set () const
	Get a pointer to the Gda::Set object which is modified by form.
bool	is_valid () const
	Tells if the form can be used as-is (if all the parameters do have some valid values)
bool	has_changed () const
	Tells if the form has had at least on entry changed since form was created or set_as_reference() has been called.
void	reset ()
	Resets all the entries in the form to their original values.
void	set_as_reference ()
	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 has_changed() will return `false` (of course until any entry is changed).
void	entry_set_visible (const Glib::RefPtr< Gnome::Gda::Holder >& holder, bool show)
	Shows or hides the Gdaui::DataEntry in form which corresponds to the.
void	entry_grab_focus (const Glib::RefPtr< Gnome::Gda::Holder >& holder)
	Makes the data entry corresponding to.
void	entry_set_editable (const Glib::RefPtr< Gnome::Gda::Holder >& holder, bool editable)
	Sets the Gdaui::DataEntry in form which corresponds to the holder parameter editable or not.
void	set_entries_to_default ()
	For each entry in the form, sets it to a default value if it is possible to do so.
Gtk::Widget*	get_entry_widget (const Glib::RefPtr< Gnome::Gda::Holder >& holder)
	Get the Gdaui::DataEntry in form which corresponds to the param parameter.
const Gtk::Widget*	get_entry_widget (const Glib::RefPtr< Gnome::Gda::Holder >& holder) const
	Get the Gdaui::DataEntry in form which corresponds to the param parameter.
Gtk::Widget*	get_label_widget (const Glib::RefPtr< Gnome::Gda::Holder >& holder)
	Get the label in form which corresponds to the param parameter.
const Gtk::Widget*	get_label_widget (const Glib::RefPtr< Gnome::Gda::Holder >& holder) const
	Get the label in form which corresponds to the param parameter.
void	set_layout_from_file (const std::string& file_name, const Glib::ustring& form_name)
	Sets a form layout according an XML description contained in file_name, for the form identified by the form_name name (as an XML layout file can contain the descriptions of several forms and grids).
Gtk::Widget*	get_place_holder (const Glib::ustring& placeholder_id)
	Retreives a pointer to a place holder widget.
const Gtk::Widget*	get_place_holder (const Glib::ustring& placeholder_id) const
	Retreives a pointer to a place holder widget.
void	add_to_size_group (const Glib::RefPtr< Gtk::SizeGroup >& size_group, BasicFormPart part=BASIC_FORM_LABELS)
	Add form's widgets specified by part to size_group (the widgets can then be removed using remove_from_size_group()).
void	remove_from_size_group (const Glib::RefPtr< Gtk::SizeGroup >& size_group, BasicFormPart part=BASIC_FORM_LABELS)
	Removes form's widgets specified by part from size_group (the widgets must have been added using add_to_size_group()).
Glib::SignalProxy0< void >	signal_activated ()
Glib::SignalProxy2< void, const Glib::RefPtr < Gnome::Gda::Holder >&, bool >	signal_holder_changed ()
Glib::SignalProxy0< void >	signal_layout_changed ()
Glib::SignalProxy1< void, Gtk::Menu* >	signal_populate_popup ()
Glib::PropertyProxy_ReadOnly < bool >	property_can_expand_v () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy< bool >	property_entries_auto_default ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly < bool >	property_entries_auto_default () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy< bool >	property_headers_sensitive ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly < bool >	property_headers_sensitive () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy< bool >	property_show_actions ()
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly < bool >	property_show_actions () const
	You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Protected Member Functions
virtual void	on_activated ()
virtual void	on_holder_changed (const Glib::RefPtr< Gnome::Gda::Holder >& holder, bool is_user_modified)
virtual void	on_layout_changed ()
Related Functions
(Note that these are not member functions.)
Gnome::GdaUI::BasicForm*	wrap (GdauiBasicForm* object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

BasicForm - Form widget mapping the values contained in a Gnome::Gda::Set.

The BasicForm widget is a form containing an entry for each Gnome::Gda::Holder object contained in a Gnome::Gda::Set (specified when the form is created). A typical usage is when the user is requested to enter a value which will be used in a statement (without any error checking for clarity):

TODO: Translate and include example from C API docs.

The default layout within a BasicForm is a vertical column: all the data entry widgets are aligned in a single column. This behaviour can be changed using the set_layout_from_file() method or setting the xml-layout property.

XML Layout Definitions

The BasicForm class parses textual descriptions of XML layout which which can be described by the following DTD.

 <!ELEMENT gdaui_layouts (gdaui_form | gdaui_grid)>
 <!ELEMENT gdaui_form (gdaui_section | gdaui_column | gdaui_notebook)*>
 <!ATTLIST gdaui_form
         name CDATA #REQUIRED
         container (columns|rows|hpaned|vpaned) #IMPLIED>
 <!ELEMENT gdaui_section (gdaui_section | gdaui_column | gdaui_notebook)*>
 <!ATTLIST gdaui_section
         title CDATA #IMPLIED >
 <!ELEMENT gdaui_notebook (gdaui_section | gdaui_column | gdaui_notebook)*>
 <!ELEMENT gdaui_column (gdaui_entry | gdaui_placeholder)*>
 <!ELEMENT gdaui_entry EMPTY>
 <!ATTLIST gdaui_entry
         name CDATA #REQUIRED
         editable (true|false) #IMPLIED
 label CDATA #IMPLIED
         plugin CDATA #IMPLIED>
 <!ELEMENT gdaui_placeholder EMPTY>
 <!ATTLIST gdaui_placeholder
         id CDATA #REQUIRED
         label CDATA #IMPLIED>

Example 1. A BasicForm layout example

 <?xml version="1.0" encoding="UTF-8"?>
 <gdaui_layouts>
   <gdaui_form name="customers" container="hpaned">
     <gdaui_section title="Summary">
       <gdaui_column>
         <gdaui_entry name="id" editable="no"/>
         <gdaui_entry name="name"/>
         <gdaui_entry name="comments" plugin="text"/>
         <gdaui_entry name="total_orders" label="Total ordered" plugin="number:NB_DECIMALS=2;CURRENCY=€"/>
       </gdaui_column>
     </gdaui_section>
     <gdaui_section title="Photo">
       <gdaui_column>
         <gdaui_entry name="photo" plugin="picture"/>
       </gdaui_column>
     </gdaui_section>
   </gdaui_form>
 </gdaui_layouts>

Constructor & Destructor Documentation

virtual Gnome::GdaUI::BasicForm::~BasicForm ( ) [virtual]

Gnome::GdaUI::BasicForm::BasicForm ( const Glib::RefPtr< Gnome::Gda::Set > & data_set ) [explicit]

Creates a new Gdaui::BasicForm widget using all the Gda::Holder objects provided in data_set.

The global layout is rendered using a table (a Gtk::Table), and an entry is created for each node of data_set.

Since libgda-uimm 4.2:

Parameters:

data_set A Gda::Set structure.

Returns:: The new widget.

Gnome::GdaUI::BasicForm::BasicForm	(	const Glib::RefPtr< Gnome::Gda::Set > &	data_set,
		Gtk::Window *	parent,
		const Glib::ustring &	title,
		const Glib::ustring &	header
	)		`[explicit]`

Creates a new Gdaui::BasicForm widget in the same way as new() and puts it into a Gtk::Dialog widget.

The returned dialog has the "Ok" and "Cancel" buttons which respectively return GTK_RESPONSE_ACCEPT and GTK_RESPONSE_REJECT.

The Gdaui::BasicForm widget is attached to the dialog using the user property "form".

Since libgda-uimm 4.2:

Parameters:

data_set	A Gda::Set object.
parent	The parent window for the new dialog, or `0`.
title	The title of the dialog window, or `0`.
header	A helper text displayed at the top of the dialog, or `0`.

Returns:: The new Gtk::Dialog widget.

Member Function Documentation

void Gnome::GdaUI::BasicForm::add_to_size_group	(	const Glib::RefPtr< Gtk::SizeGroup > &	size_group,
		BasicFormPart	part = `BASIC_FORM_LABELS`
	)

Add form's widgets specified by part to size_group (the widgets can then be removed using remove_from_size_group()).

Since libgda-uimm 4.2:

Parameters:

size_group	A Gtk::SizeGroup object.
part	Specifies which widgets in form are concerned.

void Gnome::GdaUI::BasicForm::entry_grab_focus ( const Glib::RefPtr< Gnome::Gda::Holder > & holder )

Makes the data entry corresponding to.

Parameters:

grab	the focus for the window it's in

Since libgda-uimm 4.2:

Parameters:

param A Gda::Holder object.

void Gnome::GdaUI::BasicForm::entry_set_editable	(	const Glib::RefPtr< Gnome::Gda::Holder > &	holder,
		bool	editable
	)

Sets the Gdaui::DataEntry in form which corresponds to the holder parameter editable or not.

If holder is 0, then all the parameters are concerned.

Since libgda-uimm 4.2:

Parameters:

holder	A Gda::Holder object; or `0`.
editable	`true` if corresponding data entry must be editable.

void Gnome::GdaUI::BasicForm::entry_set_visible	(	const Glib::RefPtr< Gnome::Gda::Holder > &	holder,
		bool	show
	)

Shows or hides the Gdaui::DataEntry in form which corresponds to the.

Parameters:

parameter

Since libgda-uimm 4.2:

Parameters:

param	A Gda::Holder object.
show	Set to `true` to show the data entry, and to `false` to hide it.

Glib::RefPtr<Gnome::Gda::Set> Gnome::GdaUI::BasicForm::get_data_set ( )

Get a pointer to the Gda::Set object which is modified by form.

Since libgda-uimm 4.2:

Returns:: A pointer to the Gda::Set.

Glib::RefPtr<const Gnome::Gda::Set> Gnome::GdaUI::BasicForm::get_data_set ( ) const

Get a pointer to the Gda::Set object which is modified by form.

Since libgda-uimm 4.2:

Returns:: A pointer to the Gda::Set.

const Gtk::Widget* Gnome::GdaUI::BasicForm::get_entry_widget ( const Glib::RefPtr< Gnome::Gda::Holder > & holder ) const

Get the Gdaui::DataEntry in form which corresponds to the param parameter.

Since libgda-uimm 4.2:

Parameters:

param A Gda::Holder object.

Returns:: The requested widget, or 0 if not found.

Gtk::Widget* Gnome::GdaUI::BasicForm::get_entry_widget ( const Glib::RefPtr< Gnome::Gda::Holder > & holder )

Get the Gdaui::DataEntry in form which corresponds to the param parameter.

Since libgda-uimm 4.2:

Parameters:

param A Gda::Holder object.

Returns:: The requested widget, or 0 if not found.

Gtk::Widget* Gnome::GdaUI::BasicForm::get_label_widget ( const Glib::RefPtr< Gnome::Gda::Holder > & holder )

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

Since libgda-uimm 4.2:

Parameters:

param A Gda::Holder object.

Returns:: The requested widget, or 0 if not found.

const Gtk::Widget* Gnome::GdaUI::BasicForm::get_label_widget ( const Glib::RefPtr< Gnome::Gda::Holder > & holder ) const

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

Since libgda-uimm 4.2:

Parameters:

param A Gda::Holder object.

Returns:: The requested widget, or 0 if not found.

Gtk::Widget* Gnome::GdaUI::BasicForm::get_place_holder ( const Glib::ustring & placeholder_id )

Retreives a pointer to a place holder widget.

This feature is only available if a specific layout has been defined for form using set_layout_from_file().

Since libgda-uimm 4.2:

Parameters:

placeholder_id The name of the requested place holder.

Returns:: A pointer to the requested place holder, or 0 if not found.

const Gtk::Widget* Gnome::GdaUI::BasicForm::get_place_holder ( const Glib::ustring & placeholder_id ) const

Retreives a pointer to a place holder widget.

This feature is only available if a specific layout has been defined for form using set_layout_from_file().

Since libgda-uimm 4.2:

Parameters:

placeholder_id The name of the requested place holder.

Returns:: A pointer to the requested place holder, or 0 if not found.

const GdauiBasicForm* Gnome::GdaUI::BasicForm::gobj ( ) const [inline]

Provides access to the underlying C GtkObject.

Reimplemented in Gnome::GdaUI::RawForm.

GdauiBasicForm* Gnome::GdaUI::BasicForm::gobj ( ) [inline]

Provides access to the underlying C GtkObject.

Reimplemented in Gnome::GdaUI::RawForm.

bool Gnome::GdaUI::BasicForm::has_changed ( ) const

Tells if the form has had at least on entry changed since form was created or set_as_reference() has been called.

Since libgda-uimm 4.2:

Returns:: true if one entry has changed at least.

bool Gnome::GdaUI::BasicForm::is_valid ( ) const

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

Since libgda-uimm 4.2:

Returns:: true if the form is valid.

virtual void Gnome::GdaUI::BasicForm::on_activated ( ) [protected, virtual]

virtual void Gnome::GdaUI::BasicForm::on_holder_changed	(	const Glib::RefPtr< Gnome::Gda::Holder > &	holder,
		bool	is_user_modified
	)		`[protected, virtual]`

virtual void Gnome::GdaUI::BasicForm::on_layout_changed ( ) [protected, virtual]

Glib::PropertyProxy_ReadOnly<bool> Gnome::GdaUI::BasicForm::property_can_expand_v ( ) const