libgdamm Reference Documentation |
Public Member Functions | |
void | add_field (const Glib::RefPtr<EntityField>& field) |
Add field to iface's fields (at the end of the list). | |
void | add_field_before (const Glib::RefPtr<EntityField>& field, const Glib::RefPtr<EntityField>& field_before) |
Add field to iface's fields, before field_before if it is not 0 , or at the end if field_before is 0 . | |
Glib::RefPtr<const EntityField> | get_field_by_index (int index) const |
Glib::RefPtr<EntityField> | get_field_by_index (int index) |
Glib::RefPtr<const EntityField> | get_field_by_name (const Glib::ustring& name) const |
Get a Gda::EntityField using its name. | |
Glib::RefPtr<EntityField> | get_field_by_name (const Glib::ustring& name) |
Get a Gda::EntityField using its name. | |
Glib::RefPtr<const EntityField> | get_field_by_xml_id (const Glib::ustring& xml_id) const |
Glib::RefPtr<EntityField> | get_field_by_xml_id (const Glib::ustring& xml_id) |
int | get_field_index (const Glib::RefPtr<const EntityField>& field) const |
Get the position of the field in the given entity. | |
Glib::SListHandle < Glib::RefPtr< const EntityField > > | get_fields () const |
Get a new list containing all the Gda::EntityField objects held within the object implementing the Gda::Entity interface. | |
Glib::SListHandle <Glib::RefPtr<EntityField>> | get_fields () |
Get a new list containing all the Gda::EntityField objects held within the object implementing the Gda::Entity interface. | |
int | get_n_fields () const |
Get the number of fields in iface. | |
const GdaEntity* | gobj () const |
Provides access to the underlying C GObject. | |
GdaEntity* | gobj () |
Provides access to the underlying C GObject. | |
bool | has_field (const Glib::RefPtr<const EntityField>& field) const |
Tells if field belongs to the iface entity. | |
bool | is_writable () const |
Tells if the real entity (the corresponding DBMS object) represented by iface can be written to. | |
void | remove_field (const Glib::RefPtr<EntityField>& field) |
void | swap_fields (const Glib::RefPtr<EntityField>& field1, const Glib::RefPtr<EntityField>& field2) |
virtual | ~Entity () |
Static Public Member Functions | |
static void | add_interface (GType gtype_implementer) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr<Gnome::Gda::Entity> | wrap (GdaEntity* object, bool take_copy=false) |
A Glib::wrap() method for this object. |
virtual Gnome::Gda::Entity::~Entity | ( | ) | [virtual] |
void Gnome::Gda::Entity::add_field | ( | const Glib::RefPtr<EntityField>& | field | ) |
Add field to iface's fields (at the end of the list).
field | An object implementing the Gda::EntityField interface to add. |
void Gnome::Gda::Entity::add_field_before | ( | const Glib::RefPtr<EntityField>& | field, | |
const Glib::RefPtr<EntityField>& | field_before | |||
) |
Add field to iface's fields, before field_before if it is not 0
, or at the end if field_before is 0
.
field | An object implementing the Gda::EntityField interface to add. | |
field_before | An object implementing the Gda::EntityField interface before which field will be added, or 0 . |
static void Gnome::Gda::Entity::add_interface | ( | GType | gtype_implementer | ) | [static] |
Glib::RefPtr<const EntityField> Gnome::Gda::Entity::get_field_by_index | ( | int | index | ) | const |
0
if the index is out of bounds. Glib::RefPtr<EntityField> Gnome::Gda::Entity::get_field_by_index | ( | int | index | ) |
0
if the index is out of bounds. Glib::RefPtr<const EntityField> Gnome::Gda::Entity::get_field_by_name | ( | const Glib::ustring & | name | ) | const |
Get a Gda::EntityField using its name.
The notion of "field name" is the string returned by Gda::EntityField::get_name() on each of the fields composing iface. However, if that definition does not return any field, then each particular implementation of iface may try to give an extra definition to the notion of "field name".
For instance, in the case of the Gda::Query object, the Gda::EntityField::get_name() is used as a first try to find a field, and if that fails, then the object tries to find fields from their SQL naming.
In the case where there can be more than one field with the same name (depending on iface's implementation), then the returned value is 0
.
0
if the field cannot be found, or if more than one field has been found. Glib::RefPtr<EntityField> Gnome::Gda::Entity::get_field_by_name | ( | const Glib::ustring & | name | ) |
Get a Gda::EntityField using its name.
The notion of "field name" is the string returned by Gda::EntityField::get_name() on each of the fields composing iface. However, if that definition does not return any field, then each particular implementation of iface may try to give an extra definition to the notion of "field name".
For instance, in the case of the Gda::Query object, the Gda::EntityField::get_name() is used as a first try to find a field, and if that fails, then the object tries to find fields from their SQL naming.
In the case where there can be more than one field with the same name (depending on iface's implementation), then the returned value is 0
.
0
if the field cannot be found, or if more than one field has been found. Glib::RefPtr<const EntityField> Gnome::Gda::Entity::get_field_by_xml_id | ( | const Glib::ustring & | xml_id | ) | const |
Glib::RefPtr<EntityField> Gnome::Gda::Entity::get_field_by_xml_id | ( | const Glib::ustring & | xml_id | ) |
int Gnome::Gda::Entity::get_field_index | ( | const Glib::RefPtr<const EntityField>& | field | ) | const |
Get the position of the field in the given entity.
Positions start at 0. field MUST be a visible field.
field | An object implementing the Gda::EntityField interface. |
Glib::SListHandle<Glib::RefPtr<const EntityField>> Gnome::Gda::Entity::get_fields | ( | ) | const |
Get a new list containing all the Gda::EntityField objects held within the object implementing the Gda::Entity interface.
The returned list nodes are in the order in which the fields are within the entity.
Glib::SListHandle<Glib::RefPtr<EntityField>> Gnome::Gda::Entity::get_fields | ( | ) |
Get a new list containing all the Gda::EntityField objects held within the object implementing the Gda::Entity interface.
The returned list nodes are in the order in which the fields are within the entity.
int Gnome::Gda::Entity::get_n_fields | ( | ) | const |
Get the number of fields in iface.
const GdaEntity* Gnome::Gda::Entity::gobj | ( | ) | const [inline] |
Provides access to the underlying C GObject.
Reimplemented from Glib::Interface.
Reimplemented in Gnome::Gda::DictTable, and Gnome::Gda::Query.
GdaEntity* Gnome::Gda::Entity::gobj | ( | ) | [inline] |
Provides access to the underlying C GObject.
Reimplemented from Glib::Interface.
Reimplemented in Gnome::Gda::DictTable, and Gnome::Gda::Query.
bool Gnome::Gda::Entity::has_field | ( | const Glib::RefPtr<const EntityField>& | field | ) | const |
Tells if field belongs to the iface entity.
field | An object implementing the Gda::EntityField interface. |
true
if field belongs to the iface entity. bool Gnome::Gda::Entity::is_writable | ( | ) | const |
Tells if the real entity (the corresponding DBMS object) represented by iface can be written to.
true
if it is possible to write to iface. void Gnome::Gda::Entity::remove_field | ( | const Glib::RefPtr<EntityField>& | field | ) |
field | An object implementing the Gda::EntityField interface to remove. |
void Gnome::Gda::Entity::swap_fields | ( | const Glib::RefPtr<EntityField>& | field1, | |
const Glib::RefPtr<EntityField>& | field2 | |||
) |
field1 | An object implementing the Gda::EntityField interface. | |
field2 | An object implementing the Gda::EntityField interface. |
Glib::RefPtr<Gnome::Gda::Entity> wrap | ( | GdaEntity * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
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. |