libgnomedbmm Reference Documentation
Main Page   Namespaces   Book  

Gnome::Db::DataEntry Class Reference

Base class which provides the user with specific widgets to manipulate data. More...

Inheritance diagram for Gnome::Db::DataEntry:

Inheritance graph
[legend]
List of all members.

Public Member Functions

Gda::ValueAttribute get_attributes () const
 Retreives the parameters of the GnomeDbDataEntry widget.
bool get_expand_in_layout () const
 Used for the layout of the widget in containers.
Glib::RefPtr<const Gda::DataHandler> get_handler () const
 Fetch the GdaDataHandler the GnomeDbDataEntry is using.
Glib::RefPtr<Gda::DataHandler> get_handler ()
 Fetch the GdaDataHandler the GnomeDbDataEntry is using.
Gda::Value get_value () const
 Fetch the value held in the GnomeDbDataEntry widget.
Gda::Value get_value_orig () const
 Fetch the original value held in the GnomeDbDataEntry widget.
GType get_value_type () const
 Fetch the type of data the GnomeDbDataEntry handles.
const GnomeDbDataEntry* gobj () const
 Provides access to the underlying C GObject.
GnomeDbDataEntry* gobj ()
 Provides access to the underlying C GObject.
void grab_focus ()
bool is_contents_valid () const
void set_attributes (Gda::ValueAttribute attrs, Gda::ValueAttribute mask)
 Sets the parameters of the GnomeDbDataEntry.
void set_current_as_orig ()
 Tells that the current value in de is to be considered as the original value.
void set_editable (bool editable=true)
 Set if de can be modified or not by the user.
void set_value (const Gda::Value& value)
 Push a value into the GnomeDbDataEntry.
void set_value_default (const Gda::Value& value)
 Sets the default value for the GnomeDbDataEntry which gets displayed when the user forces the default value.
void set_value_orig (const Gda::Value& value)
 Push a value into the GnomeDbDataEntry in the same way as set_value() but also sets this value as the original value.
void set_value_type (GType type)
 Sets the type of value the GnomeDbDataEntry will handle.
Glib::SignalProxy0<void> signal_contents_activated ()
 
Prototype:
void contents_activated()

Glib::SignalProxy0<void> signal_contents_modified ()
 
Prototype:
void contents_modified()

Glib::SignalProxy0<void> signal_status_changed ()
 
Prototype:
void status_changed()

virtual ~DataEntry ()

Static Public Member Functions

static void add_interface (GType gtype_implementer)

Protected Member Functions

virtual bool expand_in_row_vfunc ()
virtual Gda::ValueAttribute get_attributes_vfunc () const
virtual GType get_value_type_vfunc ()
virtual void grab_focus_vfunc ()
virtual void on_contents_activated ()
virtual void on_contents_modified ()
virtual void on_status_changed ()
virtual void set_attributes_vfunc (Gda::ValueAttribute attributes, Gda::ValueAttribute mask)
virtual void set_editable_vfunc (bool editable)
virtual void set_value_type_vfunc (GType type)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr<Gnome::Db::DataEntrywrap (GnomeDbDataEntry* object, bool take_copy=false)
 
Parameters:
object The C instance


Detailed Description

Base class which provides the user with specific widgets to manipulate data.

This interface is inherited by widgets to enable users to manipulate data of different types. Such widgets are created by objects implementing the Gda::DataHandler interface.


Constructor & Destructor Documentation

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


Member Function Documentation

static void Gnome::Db::DataEntry::add_interface ( GType  gtype_implementer  )  [static]

virtual bool Gnome::Db::DataEntry::expand_in_row_vfunc (  )  [protected, virtual]

Gda::ValueAttribute Gnome::Db::DataEntry::get_attributes (  )  const

Retreives the parameters of the GnomeDbDataEntry widget.

Returns:
The OR'ed bits corresponding to the attributes.

virtual Gda::ValueAttribute Gnome::Db::DataEntry::get_attributes_vfunc (  )  const [protected, virtual]

bool Gnome::Db::DataEntry::get_expand_in_layout (  )  const

Used for the layout of the widget in containers.

Returns:
true if the widget should expand.

Glib::RefPtr<const Gda::DataHandler> Gnome::Db::DataEntry::get_handler (  )  const

Fetch the GdaDataHandler the GnomeDbDataEntry is using.

Returns:
The GdaDataHandler object.

Glib::RefPtr<Gda::DataHandler> Gnome::Db::DataEntry::get_handler (  ) 

Fetch the GdaDataHandler the GnomeDbDataEntry is using.

Returns:
The GdaDataHandler object.

Gda::Value Gnome::Db::DataEntry::get_value (  )  const

Fetch the value held in the GnomeDbDataEntry widget.

If the value is set to 0, the returned value is of type GDA_TYPE_0. If the value is set to default, then the returned value is of type GDA_TYPE_0 or is the default value if it has been provided to the widget (and is of the same type as the one provided by de ).

Returns:
A new GValue.

Gda::Value Gnome::Db::DataEntry::get_value_orig (  )  const

Fetch the original value held in the GnomeDbDataEntry widget.

Returns:
The GValue.

GType Gnome::Db::DataEntry::get_value_type (  )  const

Fetch the type of data the GnomeDbDataEntry handles.

Returns:
The GType type.

virtual GType Gnome::Db::DataEntry::get_value_type_vfunc (  )  [protected, virtual]

const GnomeDbDataEntry* Gnome::Db::DataEntry::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gnome::Db::EntryBoolean, Gnome::Db::EntryCombo, Gnome::Db::EntryCommonTime, Gnome::Db::EntryDate, Gnome::Db::EntryNone, Gnome::Db::EntryString, Gnome::Db::EntryTime, Gnome::Db::EntryTimestamp, and Gnome::Db::EntryWrapper.

GnomeDbDataEntry* Gnome::Db::DataEntry::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gnome::Db::EntryBoolean, Gnome::Db::EntryCombo, Gnome::Db::EntryCommonTime, Gnome::Db::EntryDate, Gnome::Db::EntryNone, Gnome::Db::EntryString, Gnome::Db::EntryTime, Gnome::Db::EntryTimestamp, and Gnome::Db::EntryWrapper.

void Gnome::Db::DataEntry::grab_focus (  ) 

virtual void Gnome::Db::DataEntry::grab_focus_vfunc (  )  [protected, virtual]

bool Gnome::Db::DataEntry::is_contents_valid (  )  const

virtual void Gnome::Db::DataEntry::on_contents_activated (  )  [protected, virtual]

virtual void Gnome::Db::DataEntry::on_contents_modified (  )  [protected, virtual]

virtual void Gnome::Db::DataEntry::on_status_changed (  )  [protected, virtual]

void Gnome::Db::DataEntry::set_attributes ( Gda::ValueAttribute  attrs,
Gda::ValueAttribute  mask 
)

Sets the parameters of the GnomeDbDataEntry.

Only the attributes corresponding to the mask are set, the other ones are ignored.

Parameters:
attrs The attributes to set (OR'ed between them).
mask The mask corresponding to the considered attributes.

virtual void Gnome::Db::DataEntry::set_attributes_vfunc ( Gda::ValueAttribute  attributes,
Gda::ValueAttribute  mask 
) [protected, virtual]

void Gnome::Db::DataEntry::set_current_as_orig (  ) 

Tells that the current value in de is to be considered as the original value.

void Gnome::Db::DataEntry::set_editable ( bool  editable = true  ) 

Set if de can be modified or not by the user.

virtual void Gnome::Db::DataEntry::set_editable_vfunc ( bool  editable  )  [protected, virtual]

Reimplemented in Gnome::Db::EntryWrapper.

void Gnome::Db::DataEntry::set_value ( const Gda::Value &  value  ) 

Push a value into the GnomeDbDataEntry.

The value parameter must either be:

void Gnome::Db::DataEntry::set_value_default ( const Gda::Value &  value  ) 

Sets the default value for the GnomeDbDataEntry which gets displayed when the user forces the default value.

If it is not set then it is set to type GDA_TYPE_0. The value parameter must either be:

void Gnome::Db::DataEntry::set_value_orig ( const Gda::Value &  value  ) 

Push a value into the GnomeDbDataEntry in the same way as set_value() but also sets this value as the original value.

void Gnome::Db::DataEntry::set_value_type ( GType  type  ) 

Sets the type of value the GnomeDbDataEntry will handle.

The type must be compatible with what the widget can handle.

virtual void Gnome::Db::DataEntry::set_value_type_vfunc ( GType  type  )  [protected, virtual]

Glib::SignalProxy0< void > Gnome::Db::DataEntry::signal_contents_activated (  ) 

Prototype:
void contents_activated()

Glib::SignalProxy0< void > Gnome::Db::DataEntry::signal_contents_modified (  ) 

Prototype:
void contents_modified()

Glib::SignalProxy0< void > Gnome::Db::DataEntry::signal_status_changed (  ) 

Prototype:
void status_changed()


Friends And Related Function Documentation

Glib::RefPtr<Gnome::Db::DataEntry> wrap ( GnomeDbDataEntry *  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