← Back to branch summary

~ubuntu-branches/ubuntu/karmic/mergeant/karmic

« back to all changes in this revision

Viewing changes to doc/libmergeant/C/html/MgParameter.html

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo R. Montesino
  • Date: 2007-11-29 08:44:48 UTC
  • mfrom: (2.1.4 hardy)
  • Revision ID: james.westby@ubuntu.com-20071129084448-6aon73d22bv6hzfw
Tags: 0.67-3
* Re-enable installation of the mime files in mergeant.install
* mergeant.dirs: create usr/share/mime/packages to make dh_installmime add
  the update-mime-database code snippets

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/libmergeant/C/html/MgParameter.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>MgParameter</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="ch04.html" title="Objects related to queries"><link rel="previous" href="MgCondition.html" title="MgCondition"><link rel="next" href="MgContext.html" title="MgContext"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><style type="text/css">
2
 
        .synopsis, .classsynopsis {
3
 
            background: #eeeeee;
4
 
            border: solid 1px #aaaaaa;
5
 
            padding: 0.5em;
6
 
        }
7
 
        .programlisting {
8
 
            background: #eeeeff;
9
 
            border: solid 1px #aaaaff;
10
 
            padding: 0.5em;
11
 
        }
12
 
        .variablelist {
13
 
            padding: 4px;
14
 
            margin-left: 3em;
15
 
        }
16
 
        .navigation {
17
 
            background: #ffeeee;
18
 
            border: solid 1px #ffaaaa;
19
 
            margin-top: 0.5em;
20
 
            margin-bottom: 0.5em;
21
 
        }
22
 
        .navigation a {
23
 
            color: #770000;
24
 
        }
25
 
        .navigation a:visited {
26
 
            color: #550000;
27
 
        }
28
 
        .navigation .title {
29
 
            font-size: 200%;
30
 
        }
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="MgCondition.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch04.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="MgContext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="MgParameter"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">MgParameter</span></h2><p>MgParameter &#8212; Represents a parameter when needed to execute a query</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
32
 
 
33
 
 
34
 
 
35
 
struct      <a href="MgParameter.html#MgParameter-struct">MgParameter</a>;
36
 
guint       <a href="MgParameter.html#mg-parameter-get-type">mg_parameter_get_type</a>           (void);
37
 
GObject*    <a href="MgParameter.html#mg-parameter-new">mg_parameter_new</a>                (<a href="MgConf.html" title="MgConf">MgConf</a> *conf,
38
 
                                             <a href="MgServerDataType.html" title="MgServerDataType">MgServerDataType</a> *type);
39
 
GObject*    <a href="MgParameter.html#mg-parameter-new-copy">mg_parameter_new_copy</a>           (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *orig);
40
 
GObject*    <a href="MgParameter.html#mg-parameter-new-with-dest-field">mg_parameter_new_with_dest_field</a>
41
 
                                            (<a href="MgQfield.html" title="MgQfield">MgQfield</a> *field,
42
 
                                             <a href="MgServerDataType.html" title="MgServerDataType">MgServerDataType</a> *type);
43
 
void        <a href="MgParameter.html#mg-parameter-add-dest-field">mg_parameter_add_dest_field</a>     (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
44
 
                                             <a href="MgQfield.html" title="MgQfield">MgQfield</a> *field);
45
 
GSList*     <a href="MgParameter.html#mg-parameter-get-dest-fields">mg_parameter_get_dest_fields</a>    (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
46
 
<a href="MgServerDataType.html" title="MgServerDataType">MgServerDataType</a>* <a href="MgParameter.html#mg-parameter-get-data-type">mg_parameter_get_data_type</a>
47
 
                                            (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
48
 
const <a
49
 
href="../libgda/libgda-gda-value.html#GdaValue"
50
 
>GdaValue</a>* <a href="MgParameter.html#mg-parameter-get-value">mg_parameter_get_value</a>      (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
51
 
void        <a href="MgParameter.html#mg-parameter-set-value">mg_parameter_set_value</a>          (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
52
 
                                             const <a
53
 
href="../libgda/libgda-gda-value.html#GdaValue"
54
 
>GdaValue</a> *value);
55
 
void        <a href="MgParameter.html#mg-parameter-declare-invalid">mg_parameter_declare_invalid</a>    (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
56
 
gboolean    <a href="MgParameter.html#mg-parameter-is-valid">mg_parameter_is_valid</a>           (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
57
 
const <a
58
 
href="../libgda/libgda-gda-value.html#GdaValue"
59
 
>GdaValue</a>* <a href="MgParameter.html#mg-parameter-get-default-value">mg_parameter_get_default_value</a>
60
 
                                            (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
61
 
void        <a href="MgParameter.html#mg-parameter-set-default-value">mg_parameter_set_default_value</a>  (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
62
 
                                             const <a
63
 
href="../libgda/libgda-gda-value.html#GdaValue"
64
 
>GdaValue</a> *value);
65
 
void        <a href="MgParameter.html#mg-parameter-set-not-null">mg_parameter_set_not_null</a>       (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
66
 
                                             gboolean not_null);
67
 
gboolean    <a href="MgParameter.html#mg-parameter-get-not-null">mg_parameter_get_not_null</a>       (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
68
 
gboolean    <a href="MgParameter.html#mg-parameter-set-source-field">mg_parameter_set_source_field</a>   (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
69
 
                                             <a href="MgQfield.html" title="MgQfield">MgQfield</a> *field,
70
 
                                             GError **error);
71
 
<a href="MgQfield.html" title="MgQfield">MgQfield</a>*   <a href="MgParameter.html#mg-parameter-get-source-field">mg_parameter_get_source_field</a>   (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
72
 
void        <a href="MgParameter.html#mg-parameter-add-dependency">mg_parameter_add_dependency</a>     (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
73
 
                                             <a href="MgParameter.html" title="MgParameter">MgParameter</a> *depend_on);
74
 
void        <a href="MgParameter.html#mg-parameter-del-dependency">mg_parameter_del_dependency</a>     (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
75
 
                                             <a href="MgParameter.html" title="MgParameter">MgParameter</a> *depend_on);
76
 
GSList*     <a href="MgParameter.html#mg-parameter-get-dependencies">mg_parameter_get_dependencies</a>   (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
77
 
void        <a href="MgParameter.html#mg-parameter-replace-ref">mg_parameter_replace_ref</a>        (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
78
 
                                             GHashTable *replacements);
79
 
void        <a href="MgParameter.html#mg-parameter-bind-to-param">mg_parameter_bind_to_param</a>      (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
80
 
                                             <a href="MgParameter.html" title="MgParameter">MgParameter</a> *bind_to);
81
 
<a href="MgParameter.html" title="MgParameter">MgParameter</a>* <a href="MgParameter.html#mg-parameter-get-bind-param">mg_parameter_get_bind_param</a>    (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
82
 
gboolean    <a href="MgParameter.html#mg-parameter-requires-user-input">mg_parameter_requires_user_input</a>
83
 
                                            (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);
84
 
void        <a href="MgParameter.html#mg-parameter-set-user-input-required">mg_parameter_set_user_input_required</a>
85
 
                                            (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
86
 
                                             gboolean input_required);
87
 
</pre></div><div class="refsect1" lang="en"><a name="id2929863"></a><h2>Object Hierarchy</h2><pre class="synopsis">
88
 
 
89
 
  GObject
90
 
   +----<a href="MgBase.html" title="MgBase">MgBase</a>
91
 
         +----MgParameter
92
 
</pre></div><div class="refsect1" lang="en"><a name="id2929890"></a><h2>Implemented Interfaces</h2><p>
93
 
MgParameter implements
94
 
 <a href="MgReferer.html" title="MgReferer">MgReferer</a>.</p></div><div class="refsect1" lang="en"><a name="id2929907"></a><h2>Properties</h2><pre class="synopsis">
95
 
 
96
 
  "<a href="MgParameter.html#MgParameter--full-bind">full-bind</a>"            gpointer             : Read / Write
97
 
  "<a href="MgParameter.html#MgParameter--handler-plugin">handler-plugin</a>"       gchararray           : Read / Write
98
 
  "<a href="MgParameter.html#MgParameter--simple-bind">simple-bind</a>"          gpointer             : Read / Write
99
 
  "<a href="MgParameter.html#MgParameter--use-default-value">use-default-value</a>"    gboolean             : Read / Write
100
 
</pre></div><div class="refsect1" lang="en"><a name="id2929988"></a><h2>Description</h2><p>
101
 
A <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object basically conveys a value (as a <a
102
 
href="../libgda/libgda-gda-value.html#GdaValue"
103
 
><span class="type">GdaValue</span></a>) and several attributes specifying the value itself.
104
 
</p><p>
105
 
Parameters are usually used in conjunction with queries when they are required before the queries can be executed, but
106
 
they can also be created by hand when a value is requested from the user.
107
 
</p><p>
108
 
Also a parameter can be set to an alias of another parameter, in which case that parameter and the one of which it is an alias
109
 
will always be synchronized regarding their value and attributes. This feature is usefull when a parameter required by a query needs
110
 
to be synchronized to an already existing parameter.
111
 
</p></div><div class="refsect1" lang="en"><a name="id2930030"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2930036"></a><h3><a name="MgParameter-struct"></a>struct MgParameter</h3><a class="indexterm" name="id2930047"></a><pre class="programlisting">struct MgParameter;</pre><p>
112
 
 
113
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2930062"></a><h3><a name="mg-parameter-get-type"></a>mg_parameter_get_type ()</h3><a class="indexterm" name="id2930073"></a><pre class="programlisting">guint       mg_parameter_get_type           (void);</pre><p>
114
 
 
115
 
</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>
116
 
 
117
 
 
118
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2930109"></a><h3><a name="mg-parameter-new"></a>mg_parameter_new ()</h3><a class="indexterm" name="id2930120"></a><pre class="programlisting">GObject*    mg_parameter_new                (<a href="MgConf.html" title="MgConf">MgConf</a> *conf,
119
 
                                             <a href="MgServerDataType.html" title="MgServerDataType">MgServerDataType</a> *type);</pre><p>
120
 
Creates a new parameter of type <i class="parameter"><tt>type</tt></i></p><p>
121
 
 
122
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>conf</tt></i>�:</span></td><td> a <a href="MgConf.html" title="MgConf"><span class="type">MgConf</span></a> object
123
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i>�:</span></td><td> the <a href="MgServerDataType.html" title="MgServerDataType"><span class="type">MgServerDataType</span></a> requested
124
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a new <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
125
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2930231"></a><h3><a name="mg-parameter-new-copy"></a>mg_parameter_new_copy ()</h3><a class="indexterm" name="id2930242"></a><pre class="programlisting">GObject*    mg_parameter_new_copy           (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *orig);</pre><p>
126
 
Copy constructor.</p><p>
127
 
 
128
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>orig</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object to copy
129
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a new <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
130
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2930318"></a><h3><a name="mg-parameter-new-with-dest-field"></a>mg_parameter_new_with_dest_field ()</h3><a class="indexterm" name="id2930330"></a><pre class="programlisting">GObject*    mg_parameter_new_with_dest_field
131
 
                                            (<a href="MgQfield.html" title="MgQfield">MgQfield</a> *field,
132
 
                                             <a href="MgServerDataType.html" title="MgServerDataType">MgServerDataType</a> *type);</pre><p>
133
 
Creates a new parameter to be passed to <i class="parameter"><tt>field</tt></i> for the operations where a parameter is required;
134
 
other <a href="MgQfield.html" title="MgQfield"><span class="type">MgQfield</span></a> can also be added by using the <a href="MgParameter.html#mg-parameter-add-dest-field"><tt class="function">mg_parameter_add_dest_field()</tt></a> method.</p><p>
135
 
 
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> the <a href="MgQfield.html" title="MgQfield"><span class="type">MgQfield</span></a> object the parameter is for
137
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i>�:</span></td><td> the <a href="MgServerDataType.html" title="MgServerDataType"><span class="type">MgServerDataType</span></a> requested
138
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a new <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
139
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2930464"></a><h3><a name="mg-parameter-add-dest-field"></a>mg_parameter_add_dest_field ()</h3><a class="indexterm" name="id2930476"></a><pre class="programlisting">void        mg_parameter_add_dest_field     (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
140
 
                                             <a href="MgQfield.html" title="MgQfield">MgQfield</a> *field);</pre><p>
141
 
Adds a <a href="MgQfield.html" title="MgQfield"><span class="type">MgQfield</span></a> object for which the parameter is for</p><p>
142
 
 
143
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
144
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> the <a href="MgQfield.html" title="MgQfield"><span class="type">MgQfield</span></a> object the parameter is for
145
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2930572"></a><h3><a name="mg-parameter-get-dest-fields"></a>mg_parameter_get_dest_fields ()</h3><a class="indexterm" name="id2930584"></a><pre class="programlisting">GSList*     mg_parameter_get_dest_fields    (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
146
 
Get the <a href="MgQfield.html" title="MgQfield"><span class="type">MgQfield</span></a> objects which created <i class="parameter"><tt>param</tt></i> (and which will use its value)</p><p>
147
 
 
148
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
149
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the list of <a href="MgQfield.html" title="MgQfield"><span class="type">MgQfield</span></a> object
150
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2930674"></a><h3><a name="mg-parameter-get-data-type"></a>mg_parameter_get_data_type ()</h3><a class="indexterm" name="id2930686"></a><pre class="programlisting"><a href="MgServerDataType.html" title="MgServerDataType">MgServerDataType</a>* mg_parameter_get_data_type
151
 
                                            (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
152
 
Get the requested data type for <i class="parameter"><tt>param</tt></i>.</p><p>
153
 
 
154
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
155
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the data type
156
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2930761"></a><h3><a name="mg-parameter-get-value"></a>mg_parameter_get_value ()</h3><a class="indexterm" name="id2930772"></a><pre class="programlisting">const <a
157
 
href="../libgda/libgda-gda-value.html#GdaValue"
158
 
>GdaValue</a>* mg_parameter_get_value      (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
159
 
Get the value held into the parameter</p><p>
160
 
 
161
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
162
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the value (a NULL value returns a GDA_VALUE_TYPE_NULL GdaValue)
163
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2930843"></a><h3><a name="mg-parameter-set-value"></a>mg_parameter_set_value ()</h3><a class="indexterm" name="id2930854"></a><pre class="programlisting">void        mg_parameter_set_value          (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
164
 
                                             const <a
165
 
href="../libgda/libgda-gda-value.html#GdaValue"
166
 
>GdaValue</a> *value);</pre><p>
167
 
 
168
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td>
169
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i>�:</span></td><td>
170
 
 
171
 
 
172
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2930922"></a><h3><a name="mg-parameter-declare-invalid"></a>mg_parameter_declare_invalid ()</h3><a class="indexterm" name="id2930934"></a><pre class="programlisting">void        mg_parameter_declare_invalid    (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
173
 
Forces a parameter to be invalid; to set it valid again, a new value must be assigned
174
 
to it using <a href="MgParameter.html#mg-parameter-set-value"><tt class="function">mg_parameter_set_value()</tt></a>.</p><p>
175
 
 
176
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
177
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2931004"></a><h3><a name="mg-parameter-is-valid"></a>mg_parameter_is_valid ()</h3><a class="indexterm" name="id2931015"></a><pre class="programlisting">gboolean    mg_parameter_is_valid           (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
178
 
Get the validity of <i class="parameter"><tt>param</tt></i> (that is, of the value held by <i class="parameter"><tt>param</tt></i>)</p><p>
179
 
 
180
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
181
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if <i class="parameter"><tt>param</tt></i>'s value can safely be used
182
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2931102"></a><h3><a name="mg-parameter-get-default-value"></a>mg_parameter_get_default_value ()</h3><a class="indexterm" name="id2931114"></a><pre class="programlisting">const <a
183
 
href="../libgda/libgda-gda-value.html#GdaValue"
184
 
>GdaValue</a>* mg_parameter_get_default_value
185
 
                                            (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
186
 
Get the default value held into the parameter. WARNING: the default value does not need to be of 
187
 
the same type as the one required by <i class="parameter"><tt>param</tt></i>.</p><p>
188
 
 
189
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
190
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the default value
191
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2931191"></a><h3><a name="mg-parameter-set-default-value"></a>mg_parameter_set_default_value ()</h3><a class="indexterm" name="id2931204"></a><pre class="programlisting">void        mg_parameter_set_default_value  (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
192
 
                                             const <a
193
 
href="../libgda/libgda-gda-value.html#GdaValue"
194
 
>GdaValue</a> *value);</pre><p>
195
 
 
196
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td>
197
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i>�:</span></td><td>
198
 
 
199
 
 
200
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2931271"></a><h3><a name="mg-parameter-set-not-null"></a>mg_parameter_set_not_null ()</h3><a class="indexterm" name="id2931283"></a><pre class="programlisting">void        mg_parameter_set_not_null       (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
201
 
                                             gboolean not_null);</pre><p>
202
 
Sets if the parameter can have a NULL value. If <i class="parameter"><tt>not_null</tt></i> is TRUE, then that won't be allowed</p><p>
203
 
 
204
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
205
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>not_null</tt></i>�:</span></td><td>
206
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2931369"></a><h3><a name="mg-parameter-get-not-null"></a>mg_parameter_get_not_null ()</h3><a class="indexterm" name="id2931381"></a><pre class="programlisting">gboolean    mg_parameter_get_not_null       (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
207
 
Get wether the parameter can be NULL or not</p><p>
208
 
 
209
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
210
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if the parameter cannot be NULL
211
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2931449"></a><h3><a name="mg-parameter-set-source-field"></a>mg_parameter_set_source_field ()</h3><a class="indexterm" name="id2931461"></a><pre class="programlisting">gboolean    mg_parameter_set_source_field   (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
212
 
                                             <a href="MgQfield.html" title="MgQfield">MgQfield</a> *field,
213
 
                                             GError **error);</pre><p>
214
 
Sets a limit on the possible values for the <i class="parameter"><tt>param</tt></i> parameter: they must be among the values of <i class="parameter"><tt>field</tt></i> when the SELECT
215
 
query to which <i class="parameter"><tt>field</tt></i> belongs is executed. <i class="parameter"><tt>field</tt></i> must be of the same type
216
 
as the requested type for <i class="parameter"><tt>param</tt></i>.
217
 
</p><p>
218
 
<i class="parameter"><tt>field</tt></i> is not copied, just referenced (maybe it'd better to make a copy of it...)</p><p>
219
 
 
220
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
221
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfield.html" title="MgQfield"><span class="type">MgQfield</span></a> object or NULL
222
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>error</tt></i>�:</span></td><td> location to store error, or <tt class="literal">NULL</tt>
223
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if no error occurred
224
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2931629"></a><h3><a name="mg-parameter-get-source-field"></a>mg_parameter_get_source_field ()</h3><a class="indexterm" name="id2931641"></a><pre class="programlisting"><a href="MgQfield.html" title="MgQfield">MgQfield</a>*   mg_parameter_get_source_field   (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
225
 
 
226
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td>
227
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
228
 
 
229
 
 
230
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2931697"></a><h3><a name="mg-parameter-add-dependency"></a>mg_parameter_add_dependency ()</h3><a class="indexterm" name="id2931709"></a><pre class="programlisting">void        mg_parameter_add_dependency     (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
231
 
                                             <a href="MgParameter.html" title="MgParameter">MgParameter</a> *depend_on);</pre><p>
232
 
Tell <i class="parameter"><tt>param</tt></i> that its value will depend on the value of <i class="parameter"><tt>depend_on</tt></i></p><p>
233
 
 
234
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
235
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>depend_on</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
236
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2931807"></a><h3><a name="mg-parameter-del-dependency"></a>mg_parameter_del_dependency ()</h3><a class="indexterm" name="id2931819"></a><pre class="programlisting">void        mg_parameter_del_dependency     (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
237
 
                                             <a href="MgParameter.html" title="MgParameter">MgParameter</a> *depend_on);</pre><p>
238
 
Remove the <i class="parameter"><tt>depend_on</tt></i> dependency from <i class="parameter"><tt>param</tt></i></p><p>
239
 
 
240
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
241
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>depend_on</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
242
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2931916"></a><h3><a name="mg-parameter-get-dependencies"></a>mg_parameter_get_dependencies ()</h3><a class="indexterm" name="id2931928"></a><pre class="programlisting">GSList*     mg_parameter_get_dependencies   (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
243
 
Get the list of <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> <i class="parameter"><tt>param</tt></i> depends on</p><p>
244
 
 
245
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
246
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the list of parameters
247
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2932010"></a><h3><a name="mg-parameter-replace-ref"></a>mg_parameter_replace_ref ()</h3><a class="indexterm" name="id2932022"></a><pre class="programlisting">void        mg_parameter_replace_ref        (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
248
 
                                             GHashTable *replacements);</pre><p>
249
 
Replace references to some objects by references to some other objects,
250
 
as listed in <i class="parameter"><tt>replacements</tt></i>.</p><p>
251
 
 
252
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> object
253
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>replacements</tt></i>�:</span></td><td> the (objects to be replaced, replacing object) pairs
254
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2932109"></a><h3><a name="mg-parameter-bind-to-param"></a>mg_parameter_bind_to_param ()</h3><a class="indexterm" name="id2932121"></a><pre class="programlisting">void        mg_parameter_bind_to_param      (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
255
 
                                             <a href="MgParameter.html" title="MgParameter">MgParameter</a> *bind_to);</pre><p>
256
 
Sets <i class="parameter"><tt>param</tt></i> to change when <i class="parameter"><tt>bind_to</tt></i> changes (and does not make <i class="parameter"><tt>bind_to</tt></i> change when <i class="parameter"><tt>param</tt></i> changes)</p><p>
257
 
 
258
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a>
259
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>bind_to</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> or <tt class="literal">NULL</tt>
260
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2932237"></a><h3><a name="mg-parameter-get-bind-param"></a>mg_parameter_get_bind_param ()</h3><a class="indexterm" name="id2932250"></a><pre class="programlisting"><a href="MgParameter.html" title="MgParameter">MgParameter</a>* mg_parameter_get_bind_param    (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
261
 
Get the parameter which makes <i class="parameter"><tt>param</tt></i> change its value when the param's value is changed.</p><p>
262
 
 
263
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a>
264
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a> or <tt class="literal">NULL</tt>
265
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2932337"></a><h3><a name="mg-parameter-requires-user-input"></a>mg_parameter_requires_user_input ()</h3><a class="indexterm" name="id2932349"></a><pre class="programlisting">gboolean    mg_parameter_requires_user_input
266
 
                                            (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param);</pre><p>
267
 
Tells if the parameter is configured in a way that even if there is a value, it requires
268
 
that the user at least validates that value, or change it.</p><p>
269
 
 
270
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a>
271
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if user input is required
272
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2932420"></a><h3><a name="mg-parameter-set-user-input-required"></a>mg_parameter_set_user_input_required ()</h3><a class="indexterm" name="id2932433"></a><pre class="programlisting">void        mg_parameter_set_user_input_required
273
 
                                            (<a href="MgParameter.html" title="MgParameter">MgParameter</a> *param,
274
 
                                             gboolean input_required);</pre><p>
275
 
Sets if the user input is required for <i class="parameter"><tt>param</tt></i> (even though it may already have
276
 
a value) and be valid.</p><p>
277
 
 
278
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>param</tt></i>�:</span></td><td> a <a href="MgParameter.html" title="MgParameter"><span class="type">MgParameter</span></a>
279
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>input_required</tt></i>�:</span></td><td>
280
 
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2932521"></a><h2>Properties</h2><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><a name="MgParameter--full-bind"></a>"<tt class="literal">full-bind</tt>" (gpointer : Read / Write)</span></td><td><p></p></td></tr><tr><td><span class="term"><a name="MgParameter--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="MgParameter--simple-bind"></a>"<tt class="literal">simple-bind</tt>" (gpointer : Read / Write)</span></td><td><p></p></td></tr><tr><td><span class="term"><a name="MgParameter--use-default-value"></a>"<tt class="literal">use-default-value</tt>" (gboolean : Read / Write)</span></td><td><p></p></td></tr></tbody></table></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="MgCondition.html"><b>&lt;&lt;�MgCondition</b></a></td><td align="right"><a accesskey="n" href="MgContext.html"><b>MgContext�&gt;&gt;</b></a></td></tr></table></body></html>