#include <parameter.h>
Inheritance diagram for Gnome::Gda::Parameter:
Public Types | |
typedef Glib::SListHandle< Glib::RefPtr<EntityField >> | ListHandleEntityField |
Public Member Functions | |
virtual | ~Parameter () |
GdaParameter* | gobj () |
Provides access to the underlying C GObject. | |
const GdaParameter* | gobj () const |
Provides access to the underlying C GObject. | |
GdaParameter* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
Value | get_value () const |
Glib::ustring | get_alphanum_name () const |
Get a new string containing a "clean" version of param 's name: chars which are not among [0-9A-Za-z] are replaced with '_'. | |
GType | get_g_type () const |
Get the requested data type for param . | |
void | set_value (const Value& value) |
bool | set_value (const Glib::ustring& value) |
Same function as set_value() except that the value is provided as a string, and may return false if the string did not represent a correct value for the data type of the parameter. | |
void | declare_invalid () |
Forces a parameter to be invalid; to set it valid again, a new value must be assigned to it using set_value(). | |
bool | is_valid () const |
Get the validity of param (that is, of the value held by param ). | |
Value | get_default_value () const |
void | set_default_value (const Value& value) |
bool | get_exists_default_value () |
void | set_exists_default_value (bool default_value_exists=true) |
Tells if param has default unspecified value. | |
void | set_not_null (bool not_null=true) |
Sets if the parameter can have a 0 value. | |
bool | get_not_null () const |
Get wether the parameter can be 0 or not. | |
bool | restrict_values (const Glib::RefPtr<DataModel>& model, int col, std::auto_ptr<Glib::Error>& error) |
Sets a limit on the possible values for the param parameter: the value must be among the values contained in the col column of the model data model. | |
bool | has_restrict_values () const |
bool | has_restrict_values (Glib::RefPtr<DataModel>& model, int& col) const |
void | bind_to_param (const Glib::RefPtr<Parameter>& bind_to) |
Sets param to change when bind_to changes (and does not make bind_to change when param changes). | |
Glib::RefPtr<Parameter> | get_bind_param () |
Get the parameter which makes param change its value when the param's value is changed. | |
Glib::RefPtr<const Parameter> | get_bind_param () const |
Get the parameter which makes param change its value when the param's value is changed. | |
Glib::ustring | get_value_str () const |
Glib::SignalProxy0<void> | signal_restrict_changed () |
Static Public Member Functions | |
static Glib::RefPtr<Parameter> | create () |
static Glib::RefPtr<Parameter> | create (const Glib::ustring& name, bool value) |
static Glib::RefPtr<Parameter> | create (const Glib::ustring& name, const Glib::ustring& value) |
Protected Member Functions | |
Parameter () | |
Parameter (const Glib::ustring& name, const Value& value) | |
Parameter (const Glib::ustring& name, bool value) | |
Parameter (const Glib::ustring& name, const Glib::ustring& value) | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr<Gnome::Gda::Parameter> | wrap (GdaParameter* object, bool take_copy=false) |
virtual Gnome::Gda::Parameter::~Parameter | ( | ) | [virtual] |
Gnome::Gda::Parameter::Parameter | ( | ) | [protected] |
Gnome::Gda::Parameter::Parameter | ( | const Glib::ustring & | name, | |
const Value& | value | |||
) | [protected] |
Gnome::Gda::Parameter::Parameter | ( | const Glib::ustring & | name, | |
bool | value | |||
) | [protected] |
Gnome::Gda::Parameter::Parameter | ( | const Glib::ustring & | name, | |
const Glib::ustring & | value | |||
) | [protected] |
void Gnome::Gda::Parameter::bind_to_param | ( | const Glib::RefPtr<Parameter>& | bind_to | ) |
Sets param to change when bind_to changes (and does not make bind_to change when param changes).
bind_to | A Gda::Parameter or 0 . |
static Glib::RefPtr<Parameter> Gnome::Gda::Parameter::create | ( | const Glib::ustring & | name, | |
const Glib::ustring & | value | |||
) | [static] |
static Glib::RefPtr<Parameter> Gnome::Gda::Parameter::create | ( | const Glib::ustring & | name, | |
bool | value | |||
) | [static] |
static Glib::RefPtr<Parameter> Gnome::Gda::Parameter::create | ( | ) | [static] |
Reimplemented from Gnome::Gda::Object.
void Gnome::Gda::Parameter::declare_invalid | ( | ) |
Forces a parameter to be invalid; to set it valid again, a new value must be assigned to it using set_value().
Glib::ustring Gnome::Gda::Parameter::get_alphanum_name | ( | ) | const |
Get a new string containing a "clean" version of param 's name: chars which are not among [0-9A-Za-z] are replaced with '_'.
Glib::RefPtr<const Parameter> Gnome::Gda::Parameter::get_bind_param | ( | ) | const |
Get the parameter which makes param change its value when the param's value is changed.
0
. Glib::RefPtr<Parameter> Gnome::Gda::Parameter::get_bind_param | ( | ) |
Get the parameter which makes param change its value when the param's value is changed.
0
. Value Gnome::Gda::Parameter::get_default_value | ( | ) | const |
bool Gnome::Gda::Parameter::get_exists_default_value | ( | ) |
true
if param has a default value (which may be unspecified). GType Gnome::Gda::Parameter::get_g_type | ( | ) | const |
Get the requested data type for param .
bool Gnome::Gda::Parameter::get_not_null | ( | ) | const |
Get wether the parameter can be 0
or not.
true
if the parameter cannot be 0
. Value Gnome::Gda::Parameter::get_value | ( | ) | const |
Glib::ustring Gnome::Gda::Parameter::get_value_str | ( | ) | const |
const GdaParameter* Gnome::Gda::Parameter::gobj | ( | ) | const [inline] |
GdaParameter* Gnome::Gda::Parameter::gobj | ( | ) | [inline] |
GdaParameter* Gnome::Gda::Parameter::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Reimplemented from Gnome::Gda::Object.
bool Gnome::Gda::Parameter::has_restrict_values | ( | Glib::RefPtr<DataModel>& | model, | |
int & | col | |||
) | const |
bool Gnome::Gda::Parameter::has_restrict_values | ( | ) | const |
bool Gnome::Gda::Parameter::is_valid | ( | ) | const |
Get the validity of param (that is, of the value held by param ).
true
if param 's value can safely be used. bool Gnome::Gda::Parameter::restrict_values | ( | const Glib::RefPtr<DataModel>& | model, | |
int | col, | |||
std::auto_ptr< Glib::Error > & | error | |||
) |
Sets a limit on the possible values for the param parameter: the value must be among the values contained in the col column of the model data model.
model | A Gda::DataModel object or 0 . | |
col | The reference column in model . | |
error | Location to store error, or 0 . |
true
if no error occurred. void Gnome::Gda::Parameter::set_default_value | ( | const Value& | value | ) |
void Gnome::Gda::Parameter::set_exists_default_value | ( | bool | default_value_exists = true |
) |
Tells if param has default unspecified value.
This function is usefull if one wants to inform that param has a default value but does not know what that default value actually is.
void Gnome::Gda::Parameter::set_not_null | ( | bool | not_null = true |
) |
Sets if the parameter can have a 0
value.
If not_null is true
, then that won't be allowed
bool Gnome::Gda::Parameter::set_value | ( | const Glib::ustring & | value | ) |
Same function as set_value() except that the value is provided as a string, and may return false
if the string did not represent a correct value for the data type of the parameter.
value | A value to set the parameter to, as a string. |
true
if no error occurred. void Gnome::Gda::Parameter::set_value | ( | const Value& | value | ) |
Glib::SignalProxy0< void > Gnome::Gda::Parameter::signal_restrict_changed | ( | ) |
void restrict_changed()
Glib::RefPtr<Gnome::Gda::Parameter> wrap | ( | GdaParameter * | object, | |
bool | take_copy = false | |||
) | [related] |
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. |