File: classGnome_1_1Gda_1_1ServerOperation.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 (265 lines) | stat: -rw-r--r-- 18,126 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
261
262
263
264
265
<!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::ServerOperation 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_1ServerOperation.html">ServerOperation</a></div>
<h1>Gnome::Gda::ServerOperation Class Reference<br>
<small>
[<a class="el" href="group__DDL.html">Data definition (DDL) queries</a>]</small>
</h1><!-- doxytag: class="Gnome::Gda::ServerOperation" --><!-- doxytag: inherits="Glib::Object" -->Handles any DDL query in an abstract way.  
<a href="#_details">More...</a>
<p>
Inheritance diagram for Gnome::Gda::ServerOperation:<p><center><img src="classGnome_1_1Gda_1_1ServerOperation__inherit__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1ServerOperation__inherit__map" alt="Inheritance graph"></center>
<map name="Gnome_1_1Gda_1_1ServerOperation__inherit__map">
<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_1Object.html" shape="rect" coords="67,161,160,188" 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_1ObjectBase.html" shape="rect" coords="51,84,176,111" 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/classsigc_1_1trackable.html" shape="rect" coords="57,7,169,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classGnome_1_1Gda_1_1ServerOperation-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"><a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#cb480e8bd44b75684ca25ec99d0ae1d4">get_value_at</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_1ustring.html">Glib::ustring</a>&amp; path) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value for the node at the path formed using <em>path_format</em> and .  <a href="#cb480e8bd44b75684ca25ec99d0ae1d4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GdaServerOperation*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#bc9ed9f83d33b3f38ef1f9e14e4cf70c">gobj</a> () const</td></tr>

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

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provides access to the underlying C GObject.  <a href="#e8b506e01473d1b650456879bf230576"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdaServerOperation*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#f4ffc5075f0d8dffe695afdb41edc93c">gobj_copy</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</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="#f4ffc5075f0d8dffe695afdb41edc93c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#66705e928bbded194606837c85ea7a83">set_value_at</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_1ustring.html">Glib::ustring</a>&amp; path, 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_1ustring.html">Glib::ustring</a>&amp; value)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the value for the node at the path formed using <em>path_format</em> and .  <a href="#66705e928bbded194606837c85ea7a83"></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_1ServerOperation.html#d58648702a14ab2982ba3dd8e4dc0f30">~ServerOperation</a> ()</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_1ServerOperation.html">Gnome::Gda::ServerOperation</a>&gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1ServerOperation.html#70dabea139041b39325be33f226a4ffa">wrap</a> (GdaServerOperation* 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="#70dabea139041b39325be33f226a4ffa"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Handles any DDL query in an abstract way. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="d58648702a14ab2982ba3dd8e4dc0f30"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::~ServerOperation" ref="d58648702a14ab2982ba3dd8e4dc0f30" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Gnome::Gda::ServerOperation::~ServerOperation           </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="cb480e8bd44b75684ca25ec99d0ae1d4"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::get_value_at" ref="cb480e8bd44b75684ca25ec99d0ae1d4" args="(const Glib::ustring &amp;path) const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a> Gnome::Gda::ServerOperation::get_value_at           </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_1ustring.html">Glib::ustring</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>path</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the value for the node at the path formed using <em>path_format</em> and . 
<p>
.. (the rules are the same as for Glib::strdup_printf()) <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path_format</em>&nbsp;</td><td>A complete path to a node (starting with "/"). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Varargs</em>&nbsp;</td><td>Arguments to use with <em>path_format</em> to make a complete path. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A constant <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a> if a value has been defined, or <code>0</code> if the value is undefined or if the <em>path</em> is not defined or <em>path</em> does not hold any value. </dd></dl>

</div>
</div><p>
<a class="anchor" name="bc9ed9f83d33b3f38ef1f9e14e4cf70c"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::gobj" ref="bc9ed9f83d33b3f38ef1f9e14e4cf70c" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const GdaServerOperation* Gnome::Gda::ServerOperation::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_1ObjectBase.html#2b7010748d60e770e9e0b3d65c100cf2">Glib::ObjectBase</a>.
</div>
</div><p>
<a class="anchor" name="e8b506e01473d1b650456879bf230576"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::gobj" ref="e8b506e01473d1b650456879bf230576" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GdaServerOperation* Gnome::Gda::ServerOperation::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_1ObjectBase.html#4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.
</div>
</div><p>
<a class="anchor" name="f4ffc5075f0d8dffe695afdb41edc93c"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::gobj_copy" ref="f4ffc5075f0d8dffe695afdb41edc93c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GdaServerOperation* Gnome::Gda::ServerOperation::gobj_copy           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></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><p>
<a class="anchor" name="66705e928bbded194606837c85ea7a83"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::set_value_at" ref="66705e928bbded194606837c85ea7a83" args="(const Glib::ustring &amp;path, const Glib::ustring &amp;value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gnome::Gda::ServerOperation::set_value_at           </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_1ustring.html">Glib::ustring</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></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_1ustring.html">Glib::ustring</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the value for the node at the path formed using <em>path_format</em> and . 
<p>
.. the rules are the same as for Glib::strdup_printf())<p>
Here are the corner cases: &lt;itemizedlist&gt; &lt;listitem&gt;If the path corresponds to a <a class="el" href="classGnome_1_1Gda_1_1Parameter.html">Gda::Parameter</a>, then the parameter is set to <em>value&lt;/listitem&gt;</em> &lt;listitem&gt;If the path corresponds to a sequence item like for example "/SEQUENCE_NAME/5/NAME" for the "NAME" value of the 6th item of the "SEQUENCE_NAME" sequence then: &lt;itemizedlist&gt; &lt;listitem&gt;if the sequence already has 6 or more items, then the value is just set to the corresponding value in the 6th item of the sequence&lt;/listitem&gt; &lt;listitem&gt;if the sequence has less then 6 items, then items are added up to the 6th one before setting the value to the corresponding in the 6th item of the sequence&lt;/listitem&gt; &lt;/itemizedlist&gt; &lt;/listitem&gt; &lt;listitem&gt;If the path corresponds to a <a class="el" href="classGnome_1_1Gda_1_1DataModel.html">Gda::DataModel</a>, like for example "/ARRAY/ @a COLUMN/5" for the value at the 6th row of the "COLUMN" column of the "ARRAY" data model, then: &lt;itemizedlist&gt; &lt;listitem&gt;if the data model already contains 6 or more rows, then the value is just set&lt;/listitem&gt; &lt;listitem&gt;if the data model has less than 6 rows, then rows are added up to the 6th one before setting the value&lt;/listitem&gt; &lt;/itemizedlist&gt; &lt;/listitem&gt; &lt;/itemizedlist&gt; <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>A string. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>path_format</em>&nbsp;</td><td>A complete path to a node (starting with "/"). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>Varargs</em>&nbsp;</td><td>Arguments to use with <em>path_format</em> to make a complete path. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if no error occurred. </dd></dl>

</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="70dabea139041b39325be33f226a4ffa"></a><!-- doxytag: member="Gnome::Gda::ServerOperation::wrap" ref="70dabea139041b39325be33f226a4ffa" args="(GdaServerOperation *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_1ServerOperation.html">Gnome::Gda::ServerOperation</a>&gt; wrap           </td>
          <td>(</td>
          <td class="paramtype">GdaServerOperation *&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="serveroperation_8h.html">serveroperation.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>