File: classGnome_1_1Gda_1_1Renderer.html

package info (click to toggle)
libgdamm3.0 3.0.0-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 13,804 kB
  • ctags: 6,365
  • sloc: xml: 14,451; sh: 8,913; cpp: 1,473; makefile: 138; perl: 108
file content (260 lines) | stat: -rw-r--r-- 17,678 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libgdamm: Gnome::Gda::Renderer Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
    <td>libgdamm Reference Documentation</td>
</tr>
</table>
<center>
  <a class="qindex" href="../../../../../libgnomedbmm-3.0/docs/index.html">Main Page</a> &nbsp;
  <a class="qindex" href="namespaces.html"> Namespaces</a> &nbsp;
  <a href="../../../../../libgnomedbmm-3.0/docs/tutorial/html/index.html"> Book</a> &nbsp;
</center>
<hr width="100%"/>

<!-- Generated by Doxygen 1.5.1 -->
<div class="nav">
<a class="el" href="namespaceGnome.html">Gnome</a>::<a class="el" href="namespaceGnome_1_1Gda.html">Gda</a>::<a class="el" href="classGnome_1_1Gda_1_1Renderer.html">Renderer</a></div>
<h1>Gnome::Gda::Renderer Class Reference<br>
<small>
[<a class="el" href="group__Miscellaneous.html">Miscellaneous</a>]</small>
</h1><!-- doxytag: class="Gnome::Gda::Renderer" --><!-- doxytag: inherits="Glib::Interface" -->Base class to get representations of objects as SQL statements, XML nodes or human readable text.  
<a href="#_details">More...</a>
<p>
Inheritance diagram for Gnome::Gda::Renderer:<p><center><img src="classGnome_1_1Gda_1_1Renderer__inherit__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1Renderer__inherit__map" alt="Inheritance graph"></center>
<map name="Gnome_1_1Gda_1_1Renderer__inherit__map">
<area href="classGnome_1_1Gda_1_1Query.html" shape="rect" coords="412,5,559,32" alt="">
<area href="classGnome_1_1Gda_1_1QueryCondition.html" shape="rect" coords="381,56,589,82" alt="">
<area href="classGnome_1_1Gda_1_1QueryFieldAll.html" shape="rect" coords="389,106,581,133" alt="">
<area href="classGnome_1_1Gda_1_1QueryFieldField.html" shape="rect" coords="383,157,588,184" alt="">
<area href="classGnome_1_1Gda_1_1QueryFieldFunc.html" shape="rect" coords="381,208,589,234" alt="">
<area href="classGnome_1_1Gda_1_1QueryFieldValue.html" shape="rect" coords="380,258,591,285" alt="">
<area href="classGnome_1_1Gda_1_1QueryTarget.html" shape="rect" coords="392,309,579,336" alt="">
<area doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html" shape="rect" coords="5,157,115,184" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classGnome_1_1Gda_1_1Renderer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GdaRenderer*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1Renderer.html#f46e39029bb37ea8feec6f41475e6032">gobj</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#f46e39029bb37ea8feec6f41475e6032"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdaRenderer*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1Renderer.html#14ca843af0f792324cb55d0ac8e1f220">gobj</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#14ca843af0f792324cb55d0ac8e1f220"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1Renderer.html#d08889a1cf0cd473eea4223e1c29d350">is_valid</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1ParameterList.html">ParameterList</a>&gt;&amp; context) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tells if <em>iface</em> has all the necessary information in <em>context</em> to be rendered into a valid statement (which can be executed).  <a href="#d08889a1cf0cd473eea4223e1c29d350"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1Renderer.html#8e6d3eed5a9927a833dd7e7413d4190e">render_as_str</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1ParameterList.html">ParameterList</a>&gt;&amp; context) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Build a human readable string representing the object, in the specified context.  <a href="#8e6d3eed5a9927a833dd7e7413d4190e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1Renderer.html#4921ee3dd4409f59903c379a0988ef92">~Renderer</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1Renderer.html#98c2d3b785ba90a7d0e3f9b3834cc0e3">add_interface</a> (GType gtype_implementer)</td></tr>

<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1Renderer.html">Gnome::Gda::Renderer</a>&gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1Renderer.html#38e140fd6d81398419f59bdc7871376e">wrap</a> (GdaRenderer* object, bool take_copy=false)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.  <a href="#38e140fd6d81398419f59bdc7871376e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class to get representations of objects as SQL statements, XML nodes or human readable text. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="4921ee3dd4409f59903c379a0988ef92"></a><!-- doxytag: member="Gnome::Gda::Renderer::~Renderer" ref="4921ee3dd4409f59903c379a0988ef92" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Gnome::Gda::Renderer::~Renderer           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="98c2d3b785ba90a7d0e3f9b3834cc0e3"></a><!-- doxytag: member="Gnome::Gda::Renderer::add_interface" ref="98c2d3b785ba90a7d0e3f9b3834cc0e3" args="(GType gtype_implementer)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void Gnome::Gda::Renderer::add_interface           </td>
          <td>(</td>
          <td class="paramtype">GType&nbsp;</td>
          <td class="paramname"> <em>gtype_implementer</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="f46e39029bb37ea8feec6f41475e6032"></a><!-- doxytag: member="Gnome::Gda::Renderer::gobj" ref="f46e39029bb37ea8feec6f41475e6032" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const GdaRenderer* Gnome::Gda::Renderer::gobj           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> 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="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html#4737c92fa9930b4f006ab8b3c9487504">Glib::Interface</a>.
<p>
Reimplemented in <a class="el" href="classGnome_1_1Gda_1_1Query.html#5d60eee3a8abb6578f5a922e7e9c121a">Gnome::Gda::Query</a>, <a class="el" href="classGnome_1_1Gda_1_1QueryCondition.html#a2b1ffb812d15b5f8266640af33692ab">Gnome::Gda::QueryCondition</a>, <a class="el" href="classGnome_1_1Gda_1_1QueryFieldAll.html#cd93e578232bc1fc3f3cb45eb20fc495">Gnome::Gda::QueryFieldAll</a>, <a class="el" href="classGnome_1_1Gda_1_1QueryFieldField.html#5fced664ce2db1839888c39e5c1eb97e">Gnome::Gda::QueryFieldField</a>, <a class="el" href="classGnome_1_1Gda_1_1QueryFieldFunc.html#d518375d27012bd0fe1016032b36a501">Gnome::Gda::QueryFieldFunc</a>, <a class="el" href="classGnome_1_1Gda_1_1QueryFieldValue.html#77e45e6a7389f36a787bf748598353c6">Gnome::Gda::QueryFieldValue</a>, and <a class="el" href="classGnome_1_1Gda_1_1QueryTarget.html#1bf04720c399324bc332ceeca99dfb61">Gnome::Gda::QueryTarget</a>.
</div>
</div><p>
<a class="anchor" name="14ca843af0f792324cb55d0ac8e1f220"></a><!-- doxytag: member="Gnome::Gda::Renderer::gobj" ref="14ca843af0f792324cb55d0ac8e1f220" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GdaRenderer* Gnome::Gda::Renderer::gobj           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Provides access to the underlying C GObject. 
<p>

<p>
Reimplemented from <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1Interface.html#969e9396f75132a9577428f4fa932d42">Glib::Interface</a>.
<p>
Reimplemented in <a class="el" href="classGnome_1_1Gda_1_1Query.html#de4fee4d68f46382dbaa4222c0edb625">Gnome::Gda::Query</a>, <a class="el" href="classGnome_1_1Gda_1_1QueryCondition.html#e912a7cc9e77a6e05dbddd810b707ead">Gnome::Gda::QueryCondition</a>, <a class="el" href="classGnome_1_1Gda_1_1QueryFieldAll.html#4b52987359d925b51b1bf0b3a130f168">Gnome::Gda::QueryFieldAll</a>, <a class="el" href="classGnome_1_1Gda_1_1QueryFieldField.html#176ad83768c0df362f38efdd90ba9c0c">Gnome::Gda::QueryFieldField</a>, <a class="el" href="classGnome_1_1Gda_1_1QueryFieldFunc.html#a8a0bfd7222eb61dc3b7a50e19497871">Gnome::Gda::QueryFieldFunc</a>, <a class="el" href="classGnome_1_1Gda_1_1QueryFieldValue.html#566bc3d24200f13ff4a6686d7e983dc5">Gnome::Gda::QueryFieldValue</a>, and <a class="el" href="classGnome_1_1Gda_1_1QueryTarget.html#bfe642e7b53465ae41142644440628f6">Gnome::Gda::QueryTarget</a>.
</div>
</div><p>
<a class="anchor" name="d08889a1cf0cd473eea4223e1c29d350"></a><!-- doxytag: member="Gnome::Gda::Renderer::is_valid" ref="d08889a1cf0cd473eea4223e1c29d350" args="(const Glib::RefPtr&lt; ParameterList &gt; &amp;context) const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Gnome::Gda::Renderer::is_valid           </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1ParameterList.html">ParameterList</a>&gt;&amp;&nbsp;</td>
          <td class="paramname"> <em>context</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Tells if <em>iface</em> has all the necessary information in <em>context</em> to be rendered into a valid statement (which can be executed). 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>Rendering context. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if <em>iface</em> can be rendered with <em>context</em>. </dd></dl>

</div>
</div><p>
<a class="anchor" name="8e6d3eed5a9927a833dd7e7413d4190e"></a><!-- doxytag: member="Gnome::Gda::Renderer::render_as_str" ref="8e6d3eed5a9927a833dd7e7413d4190e" args="(const Glib::RefPtr&lt; ParameterList &gt; &amp;context) const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gnome::Gda::Renderer::render_as_str           </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1ParameterList.html">ParameterList</a>&gt;&amp;&nbsp;</td>
          <td class="paramname"> <em>context</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Build a human readable string representing the object, in the specified context. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>Rendering context. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The new string. </dd></dl>

</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="38e140fd6d81398419f59bdc7871376e"></a><!-- doxytag: member="Gnome::Gda::Renderer::wrap" ref="38e140fd6d81398419f59bdc7871376e" args="(GdaRenderer *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classGnome_1_1Gda_1_1Renderer.html">Gnome::Gda::Renderer</a>&gt; wrap           </td>
          <td>(</td>
          <td class="paramtype">GdaRenderer *&nbsp;</td>
          <td class="paramname"> <em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
A <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>The C instance. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>take_copy</em>&nbsp;</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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="renderer_8h.html">renderer.h</a></ul>
<hr><address><small>
Generated for libgdamm by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.1 &copy;&nbsp;1997-2001</small></address>
</body>
</html>