libgdamm  4.99.7
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gnome::Gda::DataAccessWrapper Class Reference

Offers random access on top of a cursor-only access data model. More...

Inheritance diagram for Gnome::Gda::DataAccessWrapper:
Inheritance graph
[legend]
Collaboration diagram for Gnome::Gda::DataAccessWrapper:
Collaboration graph
[legend]

Public Member Functions

virtual ~DataAccessWrapper ()
 
GdaDataAccessWrapper* gobj ()
 Provides access to the underlying C GObject. More...
 
const GdaDataAccessWrapper* gobj () const
 Provides access to the underlying C GObject. More...
 
GdaDataAccessWrapper* 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::PropertyProxy_ReadOnly
< Glib::RefPtr< DataModel > > 
property_model () const
 Data model being wrapped. More...
 
- Public Member Functions inherited from Gnome::Gda::DataModel
virtual ~DataModel ()
 
GdaDataModel* gobj ()
 Provides access to the underlying C GObject. More...
 
const GdaDataModel* gobj () const
 Provides access to the underlying C GObject. More...
 
void freeze ()
 Disables notifications of changes on the given data model. More...
 
void thaw ()
 Re-enables notifications of changes on the given data model. More...
 
int get_n_rows () const
 
int get_n_columns () const
 
int get_column_index (const Glib::ustring& name)
 Get the index of the first column named name in model. More...
 
Glib::RefPtr< Columndescribe_column (int col)
 Queries the underlying data model implementation for a description of a given column. More...
 
Glib::RefPtr< const Columndescribe_column (int col) const
 Queries the underlying data model implementation for a description of a given column. More...
 
Glib::ustring get_column_title (int col) const
 
void set_column_title (int col, const Glib::ustring& title)
 Sets the title of the given col in model. More...
 
Value get_value_at (int col, int row) const
 Retrieves the data stored in the given position (identified by the col and row parameters) on a data model. More...
 
Value get_typed_value_at (int col, int row, GType expected_type, bool nullok) const
 Upon errors 0 will be returned and error will be assigned a Error from the Gda::DATA_MODEL_ERROR domain. More...
 
ValueAttribute get_attributes_at (int col, int row)
 Get the attributes of the value stored at (row, col) in model, which is an ORed value of Gda::ValueAttribute flags. More...
 
Glib::RefPtr< DataModelItercreate_iter ()
 Creates a new iterator object Gda::DataModelIter object which can be used to iterate through rows in model. More...
 
bool set_value_at (int col, int row, const Value& value)
 Modifies a value in model, at ( col, row). More...
 
bool set_values (int row, const std::vector< Value >& values)
 In a similar way to set_value_at(), this method modifies a data model's contents by setting several values at once. More...
 
DataModelAccessFlags get_access_flags () const
 Get the attributes of model such as how to access the data it contains if it's modifiable, etc. More...
 
int append_values (const std::vector< Value >& values)
 Appends a row to the given data model. More...
 
bool append_row ()
 Appends a row to the data model (the new row will possibly have 0 values for all columns, or some other values depending on the data model implementation) More...
 
bool remove_row (int row)
 Removes a row from the data model. More...
 
int get_row_from_values (const ValueVector& values, const std::vector< int >& cols_index)
 Returns the first row where all the values in values at the columns identified at cols_index match. More...
 
void send_hint (DataModelHint hint, const Value& hint_value)
 Sends a hint to the data model. More...
 
Glib::ustring export_to_string (DataModelIOFormat format, const std::vector< int >& cols, const std::vector< int >& rows, const Glib::RefPtr< Set >& options)
 Exports data contained in model to the a string; the format is specified using the format argument. More...
 
bool export_to_file (DataModelIOFormat format, const std::string& file, const std::vector< int >& cols, const std::vector< int >& rows, const Glib::RefPtr< Set >& options)
 Exports data contained in model to the file; the format is specified using the format argument. More...
 
bool import_from_model (const Glib::RefPtr< DataModel >& from, bool overwrite, GHashTable* cols_trans)
 Copy the contents of the from data model to the to data model. More...
 
bool import_from_string (const Glib::ustring& string, GHashTable* cols_trans, const Glib::RefPtr< const Set >& options)
 Loads the data from string into model. More...
 
bool import_from_file (const std::string& file, GHashTable* cols_trans, const Glib::RefPtr< const Set >& options)
 Imports data contained in the file file into model; the format is detected. More...
 
void dump (FILE* to_stream) const
 Dumps a textual representation of the model to the to_stream stream. More...
 
Glib::ustring dump_as_string () const
 Dumps a textual representation of the model into a new string. More...
 
void set_column_name (int col, const Glib::ustring& name)
 Sets the name of the given col in model, and if its title is not set, also sets the title to name. More...
 
Glib::ustring get_column_name (int col) const
 
bool iter_move_next_default (const Glib::RefPtr< DataModelIter >& iter)
 
bool iter_move_prev_default (const Glib::RefPtr< DataModelIter >& iter)
 
bool iter_move_to_row_default (const Glib::RefPtr< DataModelIter >& iter, int row)
 
Glib::SignalProxy1< void, int > signal_row_inserted ()
 
Glib::SignalProxy1< void, int > signal_row_updated ()
 
Glib::SignalProxy1< void, int > signal_row_removed ()
 
Glib::SignalProxy0< void > signal_reset ()
 
Glib::SignalProxy0< void > signal_changed ()
 

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
< DataAccessWrapper
create (const Glib::RefPtr< DataModel >& model)
 
- Static Public Member Functions inherited from Gnome::Gda::DataModel
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

 DataAccessWrapper (const Glib::RefPtr< DataModel >& model)
 
- Protected Member Functions inherited from Gnome::Gda::DataModel
 DataModel ()
 You should derive from this class to use it. More...
 
virtual void on_row_inserted (int row)
 This is a default handler for the signal signal_row_inserted(). More...
 
virtual void on_row_updated (int row)
 This is a default handler for the signal signal_row_updated(). More...
 
virtual void on_row_removed (int row)
 This is a default handler for the signal signal_row_removed(). More...
 
virtual void on_reset ()
 This is a default handler for the signal signal_reset(). More...
 
virtual void on_changed ()
 This is a default handler for the signal signal_changed(). More...
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr
< Gnome::Gda::DataAccessWrapper
wrap (GdaDataAccessWrapper* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- Public Types inherited from Gnome::Gda::DataModel
typedef std::vector< ValueValueVector
 

Detailed Description

Offers random access on top of a cursor-only access data model.

The Gda::DataAccessWrapper object simply wraps around another Gda::DataModel data model object and allows data to be accessed in a random way while remaining memory efficient as much as possible.

Constructor & Destructor Documentation

virtual Gnome::Gda::DataAccessWrapper::~DataAccessWrapper ( )
virtual
Gnome::Gda::DataAccessWrapper::DataAccessWrapper ( const Glib::RefPtr< DataModel >&  model)
explicitprotected

Member Function Documentation

static Glib::RefPtr<DataAccessWrapper> Gnome::Gda::DataAccessWrapper::create ( const Glib::RefPtr< DataModel >&  model)
static
static GType Gnome::Gda::DataAccessWrapper::get_type ( )
static

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

GdaDataAccessWrapper* Gnome::Gda::DataAccessWrapper::gobj ( )
inline

Provides access to the underlying C GObject.

const GdaDataAccessWrapper* Gnome::Gda::DataAccessWrapper::gobj ( ) const
inline

Provides access to the underlying C GObject.

GdaDataAccessWrapper* Gnome::Gda::DataAccessWrapper::gobj_copy ( )

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

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<DataModel> > Gnome::Gda::DataAccessWrapper::property_model ( ) const

Data model being wrapped.

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

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

Friends And Related Function Documentation

Glib::RefPtr< Gnome::Gda::DataAccessWrapper > wrap ( GdaDataAccessWrapper *  object,
bool  take_copy = false 
)
related

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

Parameters
objectThe C instance.
take_copyFalse 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: