libgdamm: Gnome::Gda::Holder Class Reference

Container for a single Gda::Value. More...

Inheritance diagram for Gnome::Gda::Holder:

Collaboration diagram for Gnome::Gda::Holder:

Public Member Functions
	Holder (Holder&& src) noexcept

Holder&	operator= (Holder&& src) noexcept

virtual	~Holder () noexcept

GdaHolder*	gobj ()
	Provides access to the underlying C GObject. More...

const GdaHolder*	gobj () const
	Provides access to the underlying C GObject. More...

GdaHolder*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::RefPtr< Holder >	copy () const
	Copy constructor. More...

GType	get_g_type () const
	Get holder's type. More...

Glib::ustring	get_id () const
	Get the ID of holder. More...

Value	get_value () const
	Get the value held into the holder. More...

Glib::ustring	get_value_str (const Glib::RefPtr< DataHandler >& dh) const
	Same functionality as get_value() except that it returns the value as a string (the conversion is done using dh if not `0`, or the default data handler otherwise). More...

bool	set_value_as_value (const Value& value)
	Sets the value within the holder. More...

template<class ValueType >
bool	set_value (const ValueType& value)

bool	set_value_str (const Glib::RefPtr< DataHandler >& dh, const Glib::ustring& value)
	Same functionality as set_value() except that it uses a string representation of the value to set, which will be converted into a GValue first (using default data handler if dh is `0`). More...

bool	take_value (const Value& value)
	Sets the value within the holder. More...

Value	take_static_value (const Value& value, bool& value_changed)
	Sets the const value within the holder. More...

void	set_attribute (const Glib::ustring& attribute, const Value& value)

Value	get_attribute (const Glib::ustring& attribute) const
	Get the value associated to a named attribute. More...

Value	get_default_value () const
	Get the default value held into the holder. More...

void	set_default_value (const Value& value)
	Sets the default value within the holder. More...

bool	set_value_to_default ()
	Set holder's value to its default value. More...

bool	value_is_default () const
	Tells if holder's current value is the default one. More...

void	force_invalid ()
	Forces a holder to be invalid; to set it valid again, a new value must be assigned to it using set_value() or take_value(). More...

bool	is_valid () const
	Get the validity of holder (that is, of the value held by holder) More...

void	set_not_null (bool not_null=true)
	Sets if the holder can have a `0` value. More...

bool	get_not_null () const
	Get wether the holder can be `0` or not. More...

Glib::RefPtr< DataModel >	get_source_model (int& col)
	If set_source_model() has been used to provide a hint that holder's value should be among the values contained in a column of a data model, then this method returns which data model, and if col is not `0`, then it is set to the restricting column as well. More...

Glib::RefPtr< const DataModel >	get_source_model (int& col) const
	If set_source_model() has been used to provide a hint that holder's value should be among the values contained in a column of a data model, then this method returns which data model, and if col is not `0`, then it is set to the restricting column as well. More...

bool	set_source_model (const Glib::RefPtr< DataModel >& model, int col)
	Sets an hint that holder's values should be restricted among the values contained in the col column of the model data model. More...

void	set_bind (const Glib::RefPtr< Holder >& bind_to)
	Sets holder to change when bind_to changes (and does not make bind_to change when holder changes). More...

Glib::RefPtr< Holder >	get_bind ()
	Get the holder which makes holder change its value when the holder's value is changed. More...

Glib::RefPtr< const Holder >	get_bind () const
	Get the holder which makes holder change its value when the holder's value is changed. More...

Glib::PropertyProxy< Glib::ustring >	property_description ()
	Holder's description. More...

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_description () const
	Holder's description. More...

Glib::PropertyProxy< Glib::RefPtr< Holder > >	property_full_bind ()
	Make value holder follow other GdaHolder's changes and the other way around. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Holder > >	property_full_bind () const
	Make value holder follow other GdaHolder's changes and the other way around. More...

Glib::PropertyProxy< gulong >	property_g_type ()
	Holder's GType. More...

Glib::PropertyProxy_ReadOnly< gulong >	property_g_type () const
	Holder's GType. More...

Glib::PropertyProxy< Glib::ustring >	property_id ()
	Holder's ID. More...

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_id () const
	Holder's ID. More...

Glib::PropertyProxy< Glib::ustring >	property_name ()
	Holder's name. More...

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_name () const
	Holder's name. More...

Glib::PropertyProxy< bool >	property_not_null ()
	Can the value holder be NULL?. More...

Glib::PropertyProxy_ReadOnly< bool >	property_not_null () const
	Can the value holder be NULL?. More...

Glib::PropertyProxy< Glib::RefPtr< Holder > >	property_simple_bind ()
	Make value holder follow other GdaHolder's changes. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Holder > >	property_simple_bind () const
	Make value holder follow other GdaHolder's changes. More...

Glib::PropertyProxy< int >	property_source_column ()
	Column number to use in coordination with the source-model property. More...

Glib::PropertyProxy_ReadOnly< int >	property_source_column () const
	Column number to use in coordination with the source-model property. More...

Glib::PropertyProxy< Glib::RefPtr< DataModel > >	property_source_model ()
	Data model among which the holder's value should be. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< DataModel > >	property_source_model () const
	Data model among which the holder's value should be. More...

Glib::SignalProxy0< void >	signal_changed ()

Glib::SignalProxy0< void >	signal_source_changed ()

Glib::SignalProxy1< Glib::Error, const Value& >	signal_validate_change ()

Glib::SignalProxy2< void, const Glib::ustring&, const Value& >	signal_attribute_changed ()

Public Member Functions inherited from Glib::Object
	Object (const Object &)=delete

Object &	operator= (const Object &)=delete

	Object (Object &&src) noexcept

Object &	operator= (Object &&src) noexcept

void *	get_data (const QueryQuark &key)

void	set_data (const Quark &key, void *data)

void	set_data (const Quark &key, void *data, DestroyNotify notify)

void	remove_data (const QueryQuark &quark)

void *	steal_data (const QueryQuark &quark)

Glib::RefPtr< Glib::Object >	wrap (GObject *object, bool take_copy=false)

Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete

ObjectBase &	operator= (const ObjectBase &)=delete

void	set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)

void	get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const

void	set_property (const Glib::ustring &property_name, const PropertyType &value)

void	get_property (const Glib::ustring &property_name, PropertyType &value) const

void	connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)

sigc::connection	connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)

void	freeze_notify ()

void	thaw_notify ()

virtual void	reference () const

virtual void	unreference () const

GObject *	gobj ()

const GObject *	gobj () const

GObject *	gobj_copy () const

Public Member Functions inherited from sigc::trackable
	trackable ()

	trackable (const trackable &src)

	trackable (trackable &&src) noexcept

	~trackable ()

void	add_destroy_notify_callback (void *data, func_destroy_notify func) const

void	notify_callbacks ()

trackable &	operator= (const trackable &src)

trackable &	operator= (trackable &&src) noexcept

void	remove_destroy_notify_callback (void *data) const

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< Holder >	create (GType g_type, const Glib::ustring& id)

Protected Member Functions
	Holder (GType g_type, const Glib::ustring& id)

virtual void	on_changed ()
	This is a default handler for the signal signal_changed(). More...

virtual void	on_source_changed ()
	This is a default handler for the signal signal_source_changed(). More...

Protected Member Functions inherited from Glib::Object
	Object ()

	Object (const Glib::ConstructParams &construct_params)

	Object (GObject *castitem)

virtual	~Object () noexcept

Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()

	ObjectBase (const char *custom_type_name)

	ObjectBase (const std::type_info &custom_type_info)

	ObjectBase (ObjectBase &&src) noexcept

ObjectBase &	operator= (ObjectBase &&src) noexcept

virtual	~ObjectBase () noexcept=0

void	initialize (GObject *castitem)

void	initialize_move (GObject castitem, Glib::ObjectBase previous_wrapper)

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gnome::Gda::Holder >	wrap (GdaHolder* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Additional Inherited Members
Public Types inherited from Glib::Object
typedef void(*	DestroyNotify) (gpointer data)

Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify	func_destroy_notify

Detailed Description

Container for a single Gda::Value.

The GdaHolder is a container for a single Gda::Value value. It also specifies various attributes of the contained value (default value, ...)

Constructor & Destructor Documentation

Gnome::Gda::Holder::Holder ( Holder&& src )

noexcept

virtual Gnome::Gda::Holder::~Holder ( )

virtualnoexcept

Gnome::Gda::Holder::Holder	(	GType	g_type,
		const Glib::ustring &	id
	)

protected

Member Function Documentation

Glib::RefPtr<Holder> Gnome::Gda::Holder::copy ( ) const

Copy constructor.

Note: if orig is set with a static value (see take_static_value()) its copy will have a fresh new allocated GValue, so that user should free it when done.

Returns: A new Gda::Holder object.

static Glib::RefPtr<Holder> Gnome::Gda::Holder::create	(	GType	g_type,
		const Glib::ustring &	id
	)

static

void Gnome::Gda::Holder::force_invalid ( )

Forces a holder to be invalid; to set it valid again, a new value must be assigned to it using set_value() or take_value().

holder's value is set to 0.

Value Gnome::Gda::Holder::get_attribute ( const Glib::ustring & attribute ) const

Get the value associated to a named attribute.

Attributes can have any name, but Libgda proposes some default names, see this section.

Parameters

attribute Attribute name as a string.

Returns: A read-only Value, or 0 if not attribute named attribute has been set for holder.

Glib::RefPtr<Holder> Gnome::Gda::Holder::get_bind ( )

Get the holder which makes holder change its value when the holder's value is changed.

Returns: The Gda::Holder or 0.

Glib::RefPtr<const Holder> Gnome::Gda::Holder::get_bind ( ) const

Get the holder which makes holder change its value when the holder's value is changed.

Returns: The Gda::Holder or 0.

Value Gnome::Gda::Holder::get_default_value ( ) const

Get the default value held into the holder.

WARNING: the default value does not need to be of the same type as the one required by holder.

Returns: The default value.

GType Gnome::Gda::Holder::get_g_type ( ) const

Get holder's type.

Returns: The data type.

Glib::ustring Gnome::Gda::Holder::get_id ( ) const

Get the ID of holder.

The ID can be set using holder's "id" property

Returns: The ID (don't modify the string).

bool Gnome::Gda::Holder::get_not_null ( ) const

Get wether the holder can be 0 or not.

Returns: true if the holder cannot be 0.

Glib::RefPtr<DataModel> Gnome::Gda::Holder::get_source_model ( int & col )

If set_source_model() has been used to provide a hint that holder's value should be among the values contained in a column of a data model, then this method returns which data model, and if col is not 0, then it is set to the restricting column as well.

Otherwise, this method returns 0, and if col is not 0, then it is set to 0.

Parameters

col	A place to store the column in the model sourcing the holder, or `0`.

Returns: A pointer to a Gda::DataModel, or 0.

Glib::RefPtr<const DataModel> Gnome::Gda::Holder::get_source_model ( int & col ) const

Otherwise, this method returns 0, and if col is not 0, then it is set to 0.

Parameters

col	A place to store the column in the model sourcing the holder, or `0`.

Returns: A pointer to a Gda::DataModel, or 0.

static GType Gnome::Gda::Holder::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

Value Gnome::Gda::Holder::get_value ( ) const

Get the value held into the holder.

If holder is set to use its default value and that default value is not of the same type as holder, then 0 is returned.

If holder is set to 0, then the returned value is a Gda::TYPE_NULL GValue.

Returns: The value, or 0.

Glib::ustring Gnome::Gda::Holder::get_value_str ( const Glib::RefPtr< DataHandler >& dh ) const

Same functionality as get_value() except that it returns the value as a string (the conversion is done using dh if not 0, or the default data handler otherwise).

Parameters

dh	A Gda::DataHandler to use, or `0`.

Returns: The value, or 0.

GdaHolder* Gnome::Gda::Holder::gobj ( )

inline

Provides access to the underlying C GObject.

const GdaHolder* Gnome::Gda::Holder::gobj ( ) const

inline

Provides access to the underlying C GObject.

GdaHolder* Gnome::Gda::Holder::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool Gnome::Gda::Holder::is_valid ( ) const

Get the validity of holder (that is, of the value held by holder)

Returns: true if holder's value can safely be used.

virtual void Gnome::Gda::Holder::on_changed ( )

protectedvirtual

This is a default handler for the signal signal_changed().

virtual void Gnome::Gda::Holder::on_source_changed ( )

protectedvirtual

This is a default handler for the signal signal_source_changed().

Holder& Gnome::Gda::Holder::operator= ( Holder&& src )

noexcept

Glib::PropertyProxy< Glib::ustring > Gnome::Gda::Holder::property_description ( )

Holder's description.

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

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gnome::Gda::Holder::property_description ( ) const

Holder's description.

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

Glib::PropertyProxy< Glib::RefPtr<Holder> > Gnome::Gda::Holder::property_full_bind ( )

Make value holder follow other GdaHolder's changes and the other way around.

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

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Holder> > Gnome::Gda::Holder::property_full_bind ( ) const

Make value holder follow other GdaHolder's changes and the other way around.

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

Glib::PropertyProxy< gulong > Gnome::Gda::Holder::property_g_type ( )

Holder's GType.

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

Glib::PropertyProxy_ReadOnly< gulong > Gnome::Gda::Holder::property_g_type ( ) const

Holder's GType.

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

Glib::PropertyProxy< Glib::ustring > Gnome::Gda::Holder::property_id ( )

Holder's ID.

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

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gnome::Gda::Holder::property_id ( ) const

Holder's ID.

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

Glib::PropertyProxy< Glib::ustring > Gnome::Gda::Holder::property_name ( )

Holder's name.

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

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gnome::Gda::Holder::property_name ( ) const

Holder's name.

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

Glib::PropertyProxy< bool > Gnome::Gda::Holder::property_not_null ( )

Can the value holder be NULL?.

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

Glib::PropertyProxy_ReadOnly< bool > Gnome::Gda::Holder::property_not_null ( ) const

Can the value holder be NULL?.

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

Glib::PropertyProxy< Glib::RefPtr<Holder> > Gnome::Gda::Holder::property_simple_bind ( )

Make value holder follow other GdaHolder's changes.

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

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Holder> > Gnome::Gda::Holder::property_simple_bind ( ) const

Make value holder follow other GdaHolder's changes.

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

Glib::PropertyProxy< int > Gnome::Gda::Holder::property_source_column ( )

Column number to use in coordination with the source-model property.

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

Glib::PropertyProxy_ReadOnly< int > Gnome::Gda::Holder::property_source_column ( ) const

Column number to use in coordination with the source-model property.

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

Glib::PropertyProxy< Glib::RefPtr<DataModel> > Gnome::Gda::Holder::property_source_model ( )

Data model among which the holder's value should be.

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

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<DataModel> > Gnome::Gda::Holder::property_source_model ( ) const

Data model among which the holder's value should be.

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

void Gnome::Gda::Holder::set_attribute	(	const Glib::ustring &	attribute,
		const Value&	value
	)

void Gnome::Gda::Holder::set_bind ( const Glib::RefPtr< Holder >& bind_to )

Sets holder to change when bind_to changes (and does not make bind_to change when holder changes).

For the operation to succeed, the GType of holder and bind_to must be the same, with the exception that any of them can have a Gda::TYPE_NULL type (in this situation, the GType of the two Gda::Holder objects involved is set to match the other when any of them sets its type to something different than GDA_TYPE_NULL).

If bind_to is 0, then holder will not be bound anymore.

Parameters

bind_to A Gda::Holder or 0.

Returns: true if no error occurred.

void Gnome::Gda::Holder::set_default_value ( const Value& value )

Sets the default value within the holder.

If value is 0 then holder won't have a default value anymore. To set a default value to 0, then pass a Value created using gda_value_new_null().

NOTE: the default value does not need to be of the same type as the one required by holder.

Parameters

value A value to set the holder's default value, or 0.

void Gnome::Gda::Holder::set_not_null ( bool not_null = true )

Sets if the holder can have a 0 value.

If not_null is true, then that won't be allowed

Parameters

not_null true if holder should not accept 0 values.

bool Gnome::Gda::Holder::set_source_model	(	const Glib::RefPtr< DataModel >&	model,
		int	col
	)

Sets an hint that holder's values should be restricted among the values contained in the col column of the model data model.

Note that this is just a hint, meaning this policy is not enforced by holder's implementation.

Parameters

model	A Gda::DataModel object or `0`.
col	The reference column in model.

Returns: true if no error occurred.

template <class ValueType >

bool Gnome::Gda::Holder::set_value ( const ValueType & value )

bool Gnome::Gda::Holder::set_value_as_value ( const Value& value )

Sets the value within the holder.

If holder is an alias for another holder, then the value is also set for that other holder.

On success, the action of any call to force_invalid() is cancelled as soon as this method is called (even if holder's value does not actually change)

If the value is not different from the one already contained within holder, then holder is not changed and no signal is emitted.

Note: the value argument is treated the same way if it is 0 or if it is a Gda::TYPE_NULL value; if holder can't accept the value value, then this method returns false, and holder will be left in an invalid state.; before the change is accepted by holder, the "validate-change" signal will be emitted (the value of which can prevent the change from happening) which can be connected to to have a greater control of which values holder can have, or implement some business rules.

Parameters

value A value to set the holder to, or 0.

Returns: true if value has been set.

bool Gnome::Gda::Holder::set_value_str	(	const Glib::RefPtr< DataHandler >&	dh,
		const Glib::ustring &	value
	)

Same functionality as set_value() except that it uses a string representation of the value to set, which will be converted into a GValue first (using default data handler if dh is 0).

Note: if value is 0 or is the "<tt>0</tt>" string, then holder's value is set to 0.; if holder can't accept the value value, then this method returns false, and holder will be left in an invalid state.

Parameters

dh	A Gda::DataHandler to use, or `0`.
value	A value to set the holder to, as a string.

Returns: true if value has been set.

bool Gnome::Gda::Holder::set_value_to_default ( )

Set holder's value to its default value.

Returns: true if holder has got a default value.

Glib::SignalProxy2< void,const Glib::ustring&,const Value& > Gnome::Gda::Holder::signal_attribute_changed ( )

Slot Prototype:: void on_my_attribute_changed(const Glib::ustring& attr_name, const Value& value)

Glib::SignalProxy0< void > Gnome::Gda::Holder::signal_changed ( )

Slot Prototype:: void on_my_changed()

Glib::SignalProxy0< void > Gnome::Gda::Holder::signal_source_changed ( )

Slot Prototype:: void on_my_source_changed()

Glib::SignalProxy1< Glib::Error,const Value& > Gnome::Gda::Holder::signal_validate_change ( )

Slot Prototype:: Glib::Error on_my_validate_change(const Value& value)

Value Gnome::Gda::Holder::take_static_value	(	const Value&	value,
		bool &	value_changed
	)

Sets the const value within the holder.

If holder is an alias for another holder, then the value is also set for that other holder.

The value will not be freed, and user should take care of it, either for its freeing or for its correct value at the moment of query.

If the value is not different from the one already contained within holder, then holder is not changed and no signal is emitted.

Note: if holder can't accept the value value, then this method returns 0, and holder will be left in an invalid state.; before the change is accepted by holder, the "validate-change" signal will be emitted (the value of which can prevent the change from happening) which can be connected to to have a greater control of which values holder can have, or implement some business rules.

Parameters

value	A const value to set the holder to.
value_changed	A boolean set with `true` if the value changes, `false` elsewhere.

Returns: 0 if an error occurred or if the previous GValue was 0 itself. It returns the static GValue user set previously, so that he can free it.

bool Gnome::Gda::Holder::take_value ( const Value& value )

Sets the value within the holder.

If holder is an alias for another holder, then the value is also set for that other holder.

On success, the action of any call to force_invalid() is cancelled as soon as this method is called (even if holder's value does not actually change).

If the value is not different from the one already contained within holder, then holder is not changed and no signal is emitted.

Note: if holder can't accept the value value, then this method returns false, and holder will be left in an invalid state.; before the change is accepted by holder, the "validate-change" signal will be emitted (the value of which can prevent the change from happening) which can be connected to to have a greater control of which values holder can have, or implement some business rules.; if user previously set this holder with take_static_value() the GValue stored internally will be forgiven and replaced by the value. User should then take care of the 'old' static GValue.

Parameters

value A value to set the holder to.

Returns: true if value has been set.

bool Gnome::Gda::Holder::value_is_default ( ) const

Tells if holder's current value is the default one.

Returns: true if holder holder's current value is the default one.

Friends And Related Function Documentation

Glib::RefPtr< Gnome::Gda::Holder > wrap	(	GdaHolder *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
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:

libgdamm/holder.h

libgdamm: Gnome::Gda::Holder Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation