1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>MgQfValue</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="Libmergeant Reference Manual"><link rel="up" href="ch04s02.html" title="Query fields"><link rel="previous" href="MgQfFunc.html" title="MgQfFunc"><link rel="next" href="MgJoin.html" title="MgJoin"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><style type="text/css">
2
.synopsis, .classsynopsis {
4
border: solid 1px #aaaaaa;
9
border: solid 1px #aaaaff;
18
border: solid 1px #ffaaaa;
25
.navigation a:visited {
31
</style></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="MgQfFunc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch04s02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">Libmergeant Reference Manual</th><td><a accesskey="n" href="MgJoin.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="MgQfValue"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">MgQfValue</span></h2><p>MgQfValue — Represents a single value (or a parameter)</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
35
struct <a href="MgQfValue.html#MgQfValue-struct">MgQfValue</a>;
36
guint <a href="MgQfValue.html#mg-qf-value-get-type">mg_qf_value_get_type</a> (void);
37
GObject* <a href="MgQfValue.html#mg-qf-value-new">mg_qf_value_new</a> (<a href="MgQuery.html" title="MgQuery">MgQuery</a> *query,
38
<a href="MgServerDataType.html" title="MgServerDataType">MgServerDataType</a> *type);
39
void <a href="MgQfValue.html#mg-qf-value-set-value">mg_qf_value_set_value</a> (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field,
41
href="../libgda/libgda-gda-value.html#GdaValue"
44
href="../libgda/libgda-gda-value.html#GdaValue"
45
>GdaValue</a>* <a href="MgQfValue.html#mg-qf-value-get-value">mg_qf_value_get_value</a> (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);
46
void <a href="MgQfValue.html#mg-qf-value-set-default-value">mg_qf_value_set_default_value</a> (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field,
48
href="../libgda/libgda-gda-value.html#GdaValue"
49
>GdaValue</a> *default_val);
51
href="../libgda/libgda-gda-value.html#GdaValue"
52
>GdaValue</a>* <a href="MgQfValue.html#mg-qf-value-get-default-value">mg_qf_value_get_default_value</a>
53
(<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);
55
href="../libgda/libgda-gda-value.html#GdaValueType"
56
>GdaValueType</a> <a href="MgQfValue.html#mg-qf-value-get-value-type">mg_qf_value_get_value_type</a> (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);
57
<a href="MgServerDataType.html" title="MgServerDataType">MgServerDataType</a>* <a href="MgQfValue.html#mg-qf-value-get-server-data-type">mg_qf_value_get_server_data_type</a>
58
(<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);
59
void <a href="MgQfValue.html#mg-qf-value-set-is-parameter">mg_qf_value_set_is_parameter</a> (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field,
61
gboolean <a href="MgQfValue.html#mg-qf-value-is-parameter">mg_qf_value_is_parameter</a> (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);
62
void <a href="MgQfValue.html#mg-qf-value-set-not-null">mg_qf_value_set_not_null</a> (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field,
64
gboolean <a href="MgQfValue.html#mg-qf-value-get-not-null">mg_qf_value_get_not_null</a> (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);
65
gboolean <a href="MgQfValue.html#mg-qf-value-is-value-null">mg_qf_value_is_value_null</a> (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field,
66
<a href="MgContext.html" title="MgContext">MgContext</a> *context);
67
</pre></div><div class="refsect1" lang="en"><a name="id2907888"></a><h2>Object Hierarchy</h2><pre class="synopsis">
70
+----<a href="MgBase.html" title="MgBase">MgBase</a>
71
+----<a href="MgQfield.html" title="MgQfield">MgQfield</a>
73
</pre></div><div class="refsect1" lang="en"><a name="id2907922"></a><h2>Implemented Interfaces</h2><p>
75
<a href="MgXmlStorage.html" title="MgXmlStorage">MgXmlStorage</a>, <a href="MgRenderer.html" title="MgRenderer">MgRenderer</a>, <a href="MgReferer.html" title="MgReferer">MgReferer</a> and <a href="MgField.html" title="MgField">MgField</a>.</p></div><div class="refsect1" lang="en"><a name="id2907960"></a><h2>Properties</h2><pre class="synopsis">
77
"<a href="MgQfValue.html#MgQfValue--handler-plugin">handler-plugin</a>" gchararray : Read / Write
78
"<a href="MgQfValue.html#MgQfValue--query">query</a>" gpointer : Read / Write
79
"<a href="MgQfValue.html#MgQfValue--value-provider">value-provider</a>" gpointer : Read / Write
80
"<a href="MgQfValue.html#MgQfValue--value-provider-xml-id">value-provider-xml-id</a>" gchararray : Read / Write
81
</pre></div><div class="refsect1" lang="en"><a name="id2908041"></a><h2>Signal Prototypes</h2><pre class="synopsis">
83
"<a href="MgQfValue.html#MgQfValue-templ-signal">templ-signal</a>"
84
void user_function (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *mgqfvalue,
86
</pre></div><div class="refsect1" lang="en"><a name="id2908086"></a><h2>Description</h2><p>
87
The value held in this object can be of any type (a <a href="MgServerDataType.html" title="MgServerDataType"><span class="type">MgServerDataType</span></a> object must be provided when
88
creating the object). If the value can be considered as a parameter, then the possible values for this
89
parameter can be limited by the result of the execution of a sub query (use the "value_provider*" properties
90
to tell from which query field the values will be taken).
91
</p></div><div class="refsect1" lang="en"><a name="id2908110"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2908115"></a><h3><a name="MgQfValue-struct"></a>struct MgQfValue</h3><a class="indexterm" name="id2908126"></a><pre class="programlisting">struct MgQfValue;</pre><p>
93
</p></div><hr><div class="refsect2" lang="en"><a name="id2908141"></a><h3><a name="mg-qf-value-get-type"></a>mg_qf_value_get_type ()</h3><a class="indexterm" name="id2908152"></a><pre class="programlisting">guint mg_qf_value_get_type (void);</pre><p>
95
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
98
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2908188"></a><h3><a name="mg-qf-value-new"></a>mg_qf_value_new ()</h3><a class="indexterm" name="id2908198"></a><pre class="programlisting">GObject* mg_qf_value_new (<a href="MgQuery.html" title="MgQuery">MgQuery</a> *query,
99
<a href="MgServerDataType.html" title="MgServerDataType">MgServerDataType</a> *type);</pre><p>
100
Creates a new MgQfValue object which represents a value or a parameter.</p><p>
102
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>query</tt></i>�:</span></td><td> a <a href="MgQuery.html" title="MgQuery"><span class="type">MgQuery</span></a> in which the new object will be
103
</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i>�:</span></td><td> the requested type for the value
104
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the new object
105
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2908289"></a><h3><a name="mg-qf-value-set-value"></a>mg_qf_value_set_value ()</h3><a class="indexterm" name="id2908300"></a><pre class="programlisting">void mg_qf_value_set_value (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field,
107
href="../libgda/libgda-gda-value.html#GdaValue"
108
>GdaValue</a> *val);</pre><p>
109
Sets the value of <i class="parameter"><tt>field</tt></i>, or removes it (if <i class="parameter"><tt>val</tt></i> is <tt class="literal">NULL</tt>)</p><p>
111
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
112
</td></tr><tr><td><span class="term"><i class="parameter"><tt>val</tt></i>�:</span></td><td> the value to be set, or <tt class="literal">NULL</tt>
113
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2908404"></a><h3><a name="mg-qf-value-get-value"></a>mg_qf_value_get_value ()</h3><a class="indexterm" name="id2908415"></a><pre class="programlisting">const <a
114
href="../libgda/libgda-gda-value.html#GdaValue"
115
>GdaValue</a>* mg_qf_value_get_value (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);</pre><p>
116
Get the value stored by <i class="parameter"><tt>field</tt></i>. If there is no value, but a default value exists, then the
117
default value is returned.n it's up to the caller to test if there is a default value for <i class="parameter"><tt>field</tt></i>.
118
The default value can be of a different type than the one expected by <i class="parameter"><tt>field</tt></i>.</p><p>
120
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
121
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the value or NULL
122
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2908506"></a><h3><a name="mg-qf-value-set-default-value"></a>mg_qf_value_set_default_value ()</h3><a class="indexterm" name="id2908517"></a><pre class="programlisting">void mg_qf_value_set_default_value (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field,
124
href="../libgda/libgda-gda-value.html#GdaValue"
125
>GdaValue</a> *default_val);</pre><p>
126
Sets the default value of <i class="parameter"><tt>field</tt></i>, or removes it (if <i class="parameter"><tt>default_val</tt></i> is <tt class="literal">NULL</tt>)</p><p>
128
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
129
</td></tr><tr><td><span class="term"><i class="parameter"><tt>default_val</tt></i>�:</span></td><td> the default value to be set, or <tt class="literal">NULL</tt>
130
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2908621"></a><h3><a name="mg-qf-value-get-default-value"></a>mg_qf_value_get_default_value ()</h3><a class="indexterm" name="id2908633"></a><pre class="programlisting">const <a
131
href="../libgda/libgda-gda-value.html#GdaValue"
132
>GdaValue</a>* mg_qf_value_get_default_value
133
(<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);</pre><p>
134
Get the default value stored by <i class="parameter"><tt>field</tt></i>.</p><p>
136
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
137
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the value or NULL
138
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2908709"></a><h3><a name="mg-qf-value-get-value-type"></a>mg_qf_value_get_value_type ()</h3><a class="indexterm" name="id2908721"></a><pre class="programlisting"><a
139
href="../libgda/libgda-gda-value.html#GdaValueType"
140
>GdaValueType</a> mg_qf_value_get_value_type (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);</pre><p>
141
Get the GDA type of value stored within <i class="parameter"><tt>field</tt></i></p><p>
143
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
144
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the type
145
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2908794"></a><h3><a name="mg-qf-value-get-server-data-type"></a>mg_qf_value_get_server_data_type ()</h3><a class="indexterm" name="id2908805"></a><pre class="programlisting"><a href="MgServerDataType.html" title="MgServerDataType">MgServerDataType</a>* mg_qf_value_get_server_data_type
146
(<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);</pre><p>
147
Get the <span class="type">MgserverDataType</span> type of <i class="parameter"><tt>field</tt></i></p><p>
149
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
150
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the <span class="type">MgserverDataType</span> type
151
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2908897"></a><h3><a name="mg-qf-value-set-is-parameter"></a>mg_qf_value_set_is_parameter ()</h3><a class="indexterm" name="id2908909"></a><pre class="programlisting">void mg_qf_value_set_is_parameter (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field,
152
gboolean is_param);</pre><p>
153
Sets wether <i class="parameter"><tt>field</tt></i> can be considered as a parameter</p><p>
155
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
156
</td></tr><tr><td><span class="term"><i class="parameter"><tt>is_param</tt></i>�:</span></td><td>
157
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2908995"></a><h3><a name="mg-qf-value-is-parameter"></a>mg_qf_value_is_parameter ()</h3><a class="indexterm" name="id2909006"></a><pre class="programlisting">gboolean mg_qf_value_is_parameter (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);</pre><p>
158
Tells if <i class="parameter"><tt>field</tt></i> can be considered as a parameter</p><p>
160
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
161
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if <i class="parameter"><tt>field</tt></i> can be considered as a parameter
162
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2909087"></a><h3><a name="mg-qf-value-set-not-null"></a>mg_qf_value_set_not_null ()</h3><a class="indexterm" name="id2909098"></a><pre class="programlisting">void mg_qf_value_set_not_null (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field,
163
gboolean not_null);</pre><p>
164
Sets if a NULL value is acceptable for <i class="parameter"><tt>field</tt></i>. If <i class="parameter"><tt>not_null</tt></i> is TRUE, then <i class="parameter"><tt>field</tt></i>
165
can't have a NULL value.</p><p>
167
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
168
</td></tr><tr><td><span class="term"><i class="parameter"><tt>not_null</tt></i>�:</span></td><td>
169
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2909196"></a><h3><a name="mg-qf-value-get-not-null"></a>mg_qf_value_get_not_null ()</h3><a class="indexterm" name="id2909207"></a><pre class="programlisting">gboolean mg_qf_value_get_not_null (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field);</pre><p>
170
Tells if <i class="parameter"><tt>field</tt></i> can receive a NULL value.</p><p>
172
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
173
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if <i class="parameter"><tt>field</tt></i> can't have a NULL value
174
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2909288"></a><h3><a name="mg-qf-value-is-value-null"></a>mg_qf_value_is_value_null ()</h3><a class="indexterm" name="id2909300"></a><pre class="programlisting">gboolean mg_qf_value_is_value_null (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *field,
175
<a href="MgContext.html" title="MgContext">MgContext</a> *context);</pre><p>
176
Tells if <i class="parameter"><tt>field</tt></i> represents a NULL value.</p><p>
178
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfValue.html" title="MgQfValue"><span class="type">MgQfValue</span></a> object
179
</td></tr><tr><td><span class="term"><i class="parameter"><tt>context</tt></i>�:</span></td><td> a <a href="MgContext.html" title="MgContext"><span class="type">MgContext</span></a> object
180
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
181
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2909403"></a><h2>Properties</h2><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><a name="MgQfValue--handler-plugin"></a>"<tt class="literal">handler-plugin</tt>" (gchararray : Read / Write)</span></td><td><p></p></td></tr><tr><td><span class="term"><a name="MgQfValue--query"></a>"<tt class="literal">query</tt>" (gpointer : Read / Write)</span></td><td><p></p></td></tr><tr><td><span class="term"><a name="MgQfValue--value-provider"></a>"<tt class="literal">value-provider</tt>" (gpointer : Read / Write)</span></td><td><p></p></td></tr><tr><td><span class="term"><a name="MgQfValue--value-provider-xml-id"></a>"<tt class="literal">value-provider-xml-id</tt>" (gchararray : Read / Write)</span></td><td><p></p></td></tr></tbody></table></div></div><div class="refsect1" lang="en"><a name="id2909529"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="id2909534"></a><h3><a name="MgQfValue-templ-signal"></a>The "templ-signal" signal</h3><pre class="programlisting">void user_function (<a href="MgQfValue.html" title="MgQfValue">MgQfValue</a> *mgqfvalue,
182
gpointer user_data);</pre><p>
184
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>mgqfvalue</tt></i>�:</span></td><td>the object which received the signal.
186
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>�:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="MgQfFunc.html"><b><<�MgQfFunc</b></a></td><td align="right"><a accesskey="n" href="MgJoin.html"><b>MgJoin�>></b></a></td></tr></table></body></html>