<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>libgdamm: Gnome::Gda::DataAccessWrapper Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libgdamm  <span id="projectnumber">4.99.6</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.1-20110925 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceGnome.html">Gnome</a> </li> <li class="navelem"><a class="el" href="namespaceGnome_1_1Gda.html">Gda</a> </li> <li class="navelem"><a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html">DataAccessWrapper</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#related">Related Functions</a> </div> <div class="headertitle"> <div class="title">Gnome::Gda::DataAccessWrapper Class Reference<div class="ingroups"><a class="el" href="group__DataModels.html">Data Models</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="Gnome::Gda::DataAccessWrapper" --><!-- doxytag: inherits="Glib::Object,Gnome::Gda::DataModel" --> <p>Offers random access on top of a cursor-only access data model. <a href="classGnome_1_1Gda_1_1DataAccessWrapper.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for Gnome::Gda::DataAccessWrapper:</div> <div class="dyncontent"> <div class="center"><img src="classGnome_1_1Gda_1_1DataAccessWrapper__inherit__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1DataAccessWrapper_inherit__map" alt="Inheritance graph"/></div> <map name="Gnome_1_1Gda_1_1DataAccessWrapper_inherit__map" id="Gnome_1_1Gda_1_1DataAccessWrapper_inherit__map"> <area shape="rect" id="node2" /></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <div class="dynheader"> Collaboration diagram for Gnome::Gda::DataAccessWrapper:</div> <div class="dyncontent"> <div class="center"><img src="classGnome_1_1Gda_1_1DataAccessWrapper__coll__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1DataAccessWrapper_coll__map" alt="Collaboration graph"/></div> <map name="Gnome_1_1Gda_1_1DataAccessWrapper_coll__map" id="Gnome_1_1Gda_1_1DataAccessWrapper_coll__map"> <area shape="rect" id="node2" /></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classGnome_1_1Gda_1_1DataAccessWrapper-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html#aa82e188d63a959cb19515b7aa3eac51c">~DataAccessWrapper</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">GdaDataAccessWrapper* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html#a0bb554015b5b20f2d3d29c57006ca096">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a0bb554015b5b20f2d3d29c57006ca096"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const GdaDataAccessWrapper* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html#ab18bada75edce6cece06d8a4ddf1af0e">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ab18bada75edce6cece06d8a4ddf1af0e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">GdaDataAccessWrapper* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html#ad5a8809151148da167efdb6b3fe4488d">gobj_copy</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#ad5a8809151148da167efdb6b3fe4488d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" /> < <a class="elRef" >property_model</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data model being wrapped. <a href="#a2e85eb281576e090aa69f30c448a632d"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" /> < <a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html">DataAccessWrapper</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html#a217dc01bd338b20cccece6fc1a23dd0a">create</a> (const <a class="elRef" >DataModel</a> >& model)</td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html#a695d5f513419f6a8d10e429d1355b29a">DataAccessWrapper</a> (const <a class="elRef" >DataModel</a> >& model)</td></tr> <tr><td colspan="2"><h2><a name="related"></a> Related Functions</h2></td></tr> <tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p> </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" /> < <a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html">Gnome::Gda::DataAccessWrapper</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html#aa763b0ddf25cc9bc6d008269214cd0fd">wrap</a> (GdaDataAccessWrapper* object, bool take_copy=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" ></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Offers random access on top of a cursor-only access data model. </p> <p>The <a class="el" href="classGnome_1_1Gda_1_1DataAccessWrapper.html" title="Offers random access on top of a cursor-only access data model.">Gda::DataAccessWrapper</a> object simply wraps around another <a class="el" href="classGnome_1_1Gda_1_1DataModel.html" title="Abstract DataModel (Base class for all DataModels).">Gda::DataModel</a> data model object and allows data to be accessed in a random way while remaining memory efficient as much as possible. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aa82e188d63a959cb19515b7aa3eac51c"></a><!-- doxytag: member="Gnome::Gda::DataAccessWrapper::~DataAccessWrapper" ref="aa82e188d63a959cb19515b7aa3eac51c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Gnome::Gda::DataAccessWrapper::~DataAccessWrapper </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a695d5f513419f6a8d10e429d1355b29a"></a><!-- doxytag: member="Gnome::Gda::DataAccessWrapper::DataAccessWrapper" ref="a695d5f513419f6a8d10e429d1355b29a" args="(const Glib::RefPtr< DataModel > &model)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gnome::Gda::DataAccessWrapper::DataAccessWrapper </td> <td>(</td> <td class="paramtype">const <a class="elRef" >DataModel</a> >& </td> <td class="paramname"><em>model</em></td><td>)</td> <td><code> [explicit, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a217dc01bd338b20cccece6fc1a23dd0a"></a><!-- doxytag: member="Gnome::Gda::DataAccessWrapper::create" ref="a217dc01bd338b20cccece6fc1a23dd0a" args="(const Glib::RefPtr< DataModel > &model)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" >DataAccessWrapper</a>> Gnome::Gda::DataAccessWrapper::create </td> <td>(</td> <td class="paramtype">const <a class="elRef" >DataModel</a> >& </td> <td class="paramname"><em>model</em></td><td>)</td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a0bb554015b5b20f2d3d29c57006ca096"></a><!-- doxytag: member="Gnome::Gda::DataAccessWrapper::gobj" ref="a0bb554015b5b20f2d3d29c57006ca096" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GdaDataAccessWrapper* Gnome::Gda::DataAccessWrapper::gobj </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> <p>Reimplemented from <a class="el" href="classGnome_1_1Gda_1_1DataModel.html#a63b551e8308d050dbd5ab8964b405e76">Gnome::Gda::DataModel</a>.</p> </div> </div> <a class="anchor" id="ab18bada75edce6cece06d8a4ddf1af0e"></a><!-- doxytag: member="Gnome::Gda::DataAccessWrapper::gobj" ref="ab18bada75edce6cece06d8a4ddf1af0e" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const GdaDataAccessWrapper* Gnome::Gda::DataAccessWrapper::gobj </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> <p>Reimplemented from <a class="el" href="classGnome_1_1Gda_1_1DataModel.html#af06bc95c0e33adf8a3faca1870190a7f">Gnome::Gda::DataModel</a>.</p> </div> </div> <a class="anchor" id="ad5a8809151148da167efdb6b3fe4488d"></a><!-- doxytag: member="Gnome::Gda::DataAccessWrapper::gobj_copy" ref="ad5a8809151148da167efdb6b3fe4488d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GdaDataAccessWrapper* Gnome::Gda::DataAccessWrapper::gobj_copy </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p> </div> </div> <a class="anchor" id="a2e85eb281576e090aa69f30c448a632d"></a><!-- doxytag: member="Gnome::Gda::DataAccessWrapper::property_model" ref="a2e85eb281576e090aa69f30c448a632d" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >DataModel</a>> > Gnome::Gda::DataAccessWrapper::property_model </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Data model being wrapped. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="aa763b0ddf25cc9bc6d008269214cd0fd"></a><!-- doxytag: member="Gnome::Gda::DataAccessWrapper::wrap" ref="aa763b0ddf25cc9bc6d008269214cd0fd" args="(GdaDataAccessWrapper *object, bool take_copy=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" >Gnome::Gda::DataAccessWrapper</a> > wrap </td> <td>(</td> <td class="paramtype">GdaDataAccessWrapper * </td> <td class="paramname"><em>object</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>take_copy</em> = <code>false</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A <a class="elRef" >Glib::wrap()</a> method for this object. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">object</td><td>The C instance. </td></tr> <tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>libgdamm/dataaccesswrapper.h</li> </ul> </div> <hr class="footer"/><address class="footer"><small> Generated on Sun Nov 20 2011 22:38:13 for libgdamm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.5.1-20110925 </small></address> </body> </html>