libgnomedbmm Reference Documentation
Main Page   Namespaces   Book  

Gnome::Db::BasicForm Class Reference
[DbWidgets]

A GUI form to present data from a Gda::ParameterList. More...

Inheritance diagram for Gnome::Db::BasicForm:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 BasicForm (const Glib::RefPtr<Gda::ParameterList>& data_set)
void entry_grab_focus (const Glib::RefPtr<const Gda::Parameter>& parameter)
void entry_set_editable (const Glib::RefPtr<const Gda::Parameter>& param, bool editable=true)
 Sets the Gnome::DbDataEntry in form which corresponds to the param parameter editable or not.
void entry_show (const Glib::RefPtr<Gda::Parameter>& param, bool show)
 Shows or hides the Gnome::DbDataEntry in form which corresponds to the param parameter.
Glib::RefPtr<const Gda::ParameterList> get_data_set () const
 Get a pointer to the Gda::ParameterList object which is modified by form.
Glib::RefPtr<Gda::ParameterList> get_data_set ()
 Get a pointer to the Gda::ParameterList object which is modified by form.
const Gtk::Widgetget_entry_widget (const Glib::RefPtr<const Gda::Parameter>& param) const
 Get the Gnome::DbDataEntry in form which corresponds to the param parameter.
Gtk::Widgetget_entry_widget (const Glib::RefPtr<const Gda::Parameter>& param)
 Get the Gnome::DbDataEntry in form which corresponds to the param parameter.
const Gtk::Widgetget_label_widget (const Glib::RefPtr<const Gda::Parameter>& param) const
 Get the label in form which corresponds to the param parameter.
Gtk::Widgetget_label_widget (const Glib::RefPtr<const Gda::Parameter>& param)
 Get the label in form which corresponds to the param parameter.
const GnomeDbBasicForm* gobj () const
 Provides access to the underlying C GtkObject.
GnomeDbBasicForm* gobj ()
 Provides access to the underlying C GtkObject.
bool has_been_changed () const
 Tells if the form has had at least on entry changed, or not.
bool is_valid () const
 Tells if the form can be used as-is (if all the parameters do have some valid values).
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_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_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_headers_sensitive ()
 You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<
Glib::RefPtr<Gda::ParameterList >> 
property_paramlist () const
 You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy< Glib::RefPtr<
Gda::ParameterList > > 
property_paramlist ()
 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.
Glib::PropertyProxy<bool> property_show_actions ()
 You rarely need to use properties because there are get_ and set_ methods for almost all of them.
void reset ()
 Resets all the entries in the form to their original values.
void set_current_as_orig ()
 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_been_changed() will return false (of course until any entry is changed).
void set_entries_auto_default (bool auto_default=true)
 Sets weather all the Gnome::DbDataEntry entries in the form must default to a default value if they are assigned a non valid value.
void set_entries_default ()
 For each entry in the form, sets it to a default value if it is possible to do so.
void show_entry_actions (bool show_actions=true)
Glib::SignalProxy0<void> signal_activated ()
 
Prototype:
void activated()

Glib::SignalProxy2< void,
const Glib::RefPtr< Gda::Parameter > &,
bool > 
signal_param_changed ()
 
Prototype:
void param_changed(const Glib::RefPtr<Gda::Parameter>& param, bool is_user_modif)

virtual ~BasicForm ()

Protected Member Functions

virtual void on_activated ()
virtual void on_param_changed (const Glib::RefPtr<Gda::Parameter>& param, bool is_user_modif)

Related Functions

(Note that these are not member functions.)

Gnome::Db::BasicFormwrap (GnomeDbBasicForm* object, bool take_copy=false)
 
Parameters:
object The C instance


Detailed Description

A GUI form to present data from a Gda::ParameterList.


Constructor & Destructor Documentation

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

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


Member Function Documentation

void Gnome::Db::BasicForm::entry_grab_focus ( const Glib::RefPtr< const Gda::Parameter > &  parameter  ) 

void Gnome::Db::BasicForm::entry_set_editable ( const Glib::RefPtr< const Gda::Parameter > &  param,
bool  editable = true 
)

Sets the Gnome::DbDataEntry in form which corresponds to the param parameter editable or not.

Parameters:
param A Gda::Parameter object.
editable Whether the Gnome::DbDataEntry should be set editable.

void Gnome::Db::BasicForm::entry_show ( const Glib::RefPtr< Gda::Parameter > &  param,
bool  show 
)

Shows or hides the Gnome::DbDataEntry in form which corresponds to the param parameter.

Parameters:
param A Gda::Parameter object.
show Whether the Gnome::DbDataEntry should be shown.

Glib::RefPtr<const Gda::ParameterList> Gnome::Db::BasicForm::get_data_set (  )  const

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

Glib::RefPtr<Gda::ParameterList> Gnome::Db::BasicForm::get_data_set (  ) 

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

const Gtk::Widget* Gnome::Db::BasicForm::get_entry_widget ( const Glib::RefPtr< const Gda::Parameter > &  param  )  const

Get the Gnome::DbDataEntry in form which corresponds to the param parameter.

Parameters:
param A Gda::Parameter object.
Returns:
The requested widget, or 0 if not found.

Gtk::Widget* Gnome::Db::BasicForm::get_entry_widget ( const Glib::RefPtr< const Gda::Parameter > &  param  ) 

Get the Gnome::DbDataEntry in form which corresponds to the param parameter.

Parameters:
param A Gda::Parameter object.
Returns:
The requested widget, or 0 if not found.

const Gtk::Widget* Gnome::Db::BasicForm::get_label_widget ( const Glib::RefPtr< const Gda::Parameter > &  param  )  const

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

Parameters:
param A Gda::Parameter object.
Returns:
The requested widget, or 0 if not found.

Gtk::Widget* Gnome::Db::BasicForm::get_label_widget ( const Glib::RefPtr< const Gda::Parameter > &  param  ) 

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

Parameters:
param A Gda::Parameter object.
Returns:
The requested widget, or 0 if not found.

const GnomeDbBasicForm* Gnome::Db::BasicForm::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::VBox.

Reimplemented in Gnome::Db::RawForm.

GnomeDbBasicForm* Gnome::Db::BasicForm::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::VBox.

Reimplemented in Gnome::Db::RawForm.

bool Gnome::Db::BasicForm::has_been_changed (  )  const

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

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

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

Returns:
true if the form is valid.

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

virtual void Gnome::Db::BasicForm::on_param_changed ( const Glib::RefPtr< Gda::Parameter > &  param,
bool  is_user_modif 
) [protected, virtual]

Glib::PropertyProxy_ReadOnly<bool> Gnome::Db::BasicForm::property_entries_auto_default (  )  const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gnome::Db::BasicForm::property_entries_auto_default (  ) 

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gnome::Db::BasicForm::property_headers_sensitive (  )  const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gnome::Db::BasicForm::property_headers_sensitive (  ) 

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gda::ParameterList> > Gnome::Db::BasicForm::property_paramlist (  )  const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy< Glib::RefPtr<Gda::ParameterList> > Gnome::Db::BasicForm::property_paramlist (  ) 

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gnome::Db::BasicForm::property_show_actions (  )  const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gnome::Db::BasicForm::property_show_actions (  ) 

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

void Gnome::Db::BasicForm::reset (  ) 

Resets all the entries in the form to their original values.

void Gnome::Db::BasicForm::set_current_as_orig (  ) 

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_been_changed() will return false (of course until any entry is changed).

void Gnome::Db::BasicForm::set_entries_auto_default ( bool  auto_default = true  ) 

Sets weather all the Gnome::DbDataEntry 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.

void Gnome::Db::BasicForm::set_entries_default (  ) 

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

void Gnome::Db::BasicForm::show_entry_actions ( bool  show_actions = true  ) 

Glib::SignalProxy0< void > Gnome::Db::BasicForm::signal_activated (  ) 

Prototype:
void activated()

Glib::SignalProxy2< void,const Glib::RefPtr<Gda::Parameter>&,bool > Gnome::Db::BasicForm::signal_param_changed (  ) 

Prototype:
void param_changed(const Glib::RefPtr<Gda::Parameter>& param, bool is_user_modif)


Friends And Related Function Documentation

Gnome::Db::BasicForm* wrap ( GnomeDbBasicForm *  object,
bool  take_copy = false 
) [related]

Parameters:
object The C instance

Parameters:
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:
Generated for libgnomedbmm by Doxygen 1.5.1 © 1997-2001