1 <refentry id="modest-ModestConf">
3 <refentrytitle id="top_of_page">ModestConf</refentrytitle>
4 <manvolnum>3</manvolnum>
5 <refmiscinfo>MODEST Library</refmiscinfo>
9 <refname>ModestConf</refname>
10 <refpurpose></refpurpose>
11 <!--[<xref linkend="desc" endterm="desc.title"/>]-->
14 <refsynopsisdiv id="synopsis">
15 <title id="synopsis.title">Synopsis</title>
21 <link linkend="ModestConf">ModestConf</link>;
22 <link linkend="GObject">GObject</link>* <link linkend="modest-conf-new">modest_conf_new</link> (void);
23 <link linkend="gchar">gchar</link>* <link linkend="modest-conf-get-string">modest_conf_get_string</link> (<link linkend="ModestConf">ModestConf</link> *self,
24 const <link linkend="gchar">gchar</link> *key,
25 <link linkend="GError">GError</link> **err);
26 <link linkend="int">int</link> <link linkend="modest-conf-get-int">modest_conf_get_int</link> (<link linkend="ModestConf">ModestConf</link> *self,
27 const <link linkend="gchar">gchar</link> *key,
28 <link linkend="GError">GError</link> **err);
29 <link linkend="gboolean">gboolean</link> <link linkend="modest-conf-get-bool">modest_conf_get_bool</link> (<link linkend="ModestConf">ModestConf</link> *self,
30 const <link linkend="gchar">gchar</link> *key,
31 <link linkend="GError">GError</link> **err);
32 <link linkend="gboolean">gboolean</link> <link linkend="modest-conf-set-string">modest_conf_set_string</link> (<link linkend="ModestConf">ModestConf</link> *self,
33 const <link linkend="gchar">gchar</link> *key,
34 const <link linkend="gchar">gchar</link> *val,
35 <link linkend="GError">GError</link> **err);
36 <link linkend="gboolean">gboolean</link> <link linkend="modest-conf-set-int">modest_conf_set_int</link> (<link linkend="ModestConf">ModestConf</link> *self,
37 const <link linkend="gchar">gchar</link> *key,
38 <link linkend="int">int</link> val,
39 <link linkend="GError">GError</link> **err);
40 <link linkend="gboolean">gboolean</link> <link linkend="modest-conf-set-bool">modest_conf_set_bool</link> (<link linkend="ModestConf">ModestConf</link> *self,
41 const <link linkend="gchar">gchar</link> *key,
42 <link linkend="gboolean">gboolean</link> val,
43 <link linkend="GError">GError</link> **err);
44 <link linkend="GSList">GSList</link>* <link linkend="modest-conf-list-subkeys">modest_conf_list_subkeys</link> (<link linkend="ModestConf">ModestConf</link> *self,
45 const <link linkend="gchar">gchar</link> *key,
46 <link linkend="GError">GError</link> **err);
47 <link linkend="gboolean">gboolean</link> <link linkend="modest-conf-remove-key">modest_conf_remove_key</link> (<link linkend="ModestConf">ModestConf</link> *self,
48 const <link linkend="gchar">gchar</link> *key,
49 <link linkend="GError">GError</link> **err);
50 <link linkend="gboolean">gboolean</link> <link linkend="modest-conf-key-exists">modest_conf_key_exists</link> (<link linkend="ModestConf">ModestConf</link> *self,
51 const <link linkend="gchar">gchar</link> *key,
52 <link linkend="GError">GError</link> **err);
66 <title id="desc.title">Description</title>
72 <refsect1 id="details">
73 <title id="details.title">Details</title>
75 <title><anchor id="ModestConf" role="struct"/>ModestConf</title>
76 <indexterm><primary>ModestConf</primary></indexterm><programlisting>typedef struct {
84 <title><anchor id="modest-conf-new" role="function"/>modest_conf_new ()</title>
85 <indexterm><primary>modest_conf_new</primary></indexterm><programlisting><link linkend="GObject">GObject</link>* modest_conf_new (void);</programlisting>
87 create a new modest ModestConf object.</para>
90 </para><variablelist role="params">
91 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new ModestConf instance, or NULL in case
93 </simpara></listitem></varlistentry>
94 </variablelist></refsect2>
96 <title><anchor id="modest-conf-get-string" role="function"/>modest_conf_get_string ()</title>
97 <indexterm><primary>modest_conf_get_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* modest_conf_get_string (<link linkend="ModestConf">ModestConf</link> *self,
98 const <link linkend="gchar">gchar</link> *key,
99 <link linkend="GError">GError</link> **err);</programlisting>
101 get a string from the configuration system</para>
104 </para><variablelist role="params">
105 <varlistentry><term><parameter>self</parameter> :</term>
106 <listitem><simpara> self a ModestConf instance
107 </simpara></listitem></varlistentry>
108 <varlistentry><term><parameter>key</parameter> :</term>
109 <listitem><simpara> the key of the value to retrieve
110 </simpara></listitem></varlistentry>
111 <varlistentry><term><parameter>err</parameter> :</term>
112 <listitem><simpara> a GError ptr, or NULL to ignore.
113 </simpara></listitem></varlistentry>
114 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated string with the value for the key,
115 or NULL in case of error. <parameter>err</parameter> gives details in case of error
116 </simpara></listitem></varlistentry>
117 </variablelist></refsect2>
119 <title><anchor id="modest-conf-get-int" role="function"/>modest_conf_get_int ()</title>
120 <indexterm><primary>modest_conf_get_int</primary></indexterm><programlisting><link linkend="int">int</link> modest_conf_get_int (<link linkend="ModestConf">ModestConf</link> *self,
121 const <link linkend="gchar">gchar</link> *key,
122 <link linkend="GError">GError</link> **err);</programlisting>
124 get an integer from the configuration system</para>
127 </para><variablelist role="params">
128 <varlistentry><term><parameter>self</parameter> :</term>
129 <listitem><simpara> self a ModestConf instance
130 </simpara></listitem></varlistentry>
131 <varlistentry><term><parameter>key</parameter> :</term>
132 <listitem><simpara> the key of the value to retrieve
133 </simpara></listitem></varlistentry>
134 <varlistentry><term><parameter>err</parameter> :</term>
135 <listitem><simpara> a GError ptr, or NULL to ignore.
136 </simpara></listitem></varlistentry>
137 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an integer with the value for the key, or -1 in case of error
138 (of course, -1 can also be returned in non-error cases).
139 <parameter>err</parameter> gives details in case of error
140 </simpara></listitem></varlistentry>
141 </variablelist></refsect2>
143 <title><anchor id="modest-conf-get-bool" role="function"/>modest_conf_get_bool ()</title>
144 <indexterm><primary>modest_conf_get_bool</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> modest_conf_get_bool (<link linkend="ModestConf">ModestConf</link> *self,
145 const <link linkend="gchar">gchar</link> *key,
146 <link linkend="GError">GError</link> **err);</programlisting>
148 get a boolean value from the configuration system</para>
151 </para><variablelist role="params">
152 <varlistentry><term><parameter>self</parameter> :</term>
153 <listitem><simpara> self a ModestConf instance
154 </simpara></listitem></varlistentry>
155 <varlistentry><term><parameter>key</parameter> :</term>
156 <listitem><simpara> the key of the value to retrieve
157 </simpara></listitem></varlistentry>
158 <varlistentry><term><parameter>err</parameter> :</term>
159 <listitem><simpara> a GError ptr, or NULL to ignore.
160 </simpara></listitem></varlistentry>
161 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a boolean value with the value for the key, or -1 in case of error
162 (of course, -1 can also be returned in non-error cases).
163 <parameter>err</parameter> gives details in case of error
164 </simpara></listitem></varlistentry>
165 </variablelist></refsect2>
167 <title><anchor id="modest-conf-set-string" role="function"/>modest_conf_set_string ()</title>
168 <indexterm><primary>modest_conf_set_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> modest_conf_set_string (<link linkend="ModestConf">ModestConf</link> *self,
169 const <link linkend="gchar">gchar</link> *key,
170 const <link linkend="gchar">gchar</link> *val,
171 <link linkend="GError">GError</link> **err);</programlisting>
173 store a string value in the configuration system</para>
176 </para><variablelist role="params">
177 <varlistentry><term><parameter>self</parameter> :</term>
178 <listitem><simpara> a ModestConf instance
179 </simpara></listitem></varlistentry>
180 <varlistentry><term><parameter>key</parameter> :</term>
181 <listitem><simpara> the key of the value to set
182 </simpara></listitem></varlistentry>
183 <varlistentry><term><parameter>val</parameter> :</term>
184 <listitem><simpara> the value to set
185 </simpara></listitem></varlistentry>
186 <varlistentry><term><parameter>err</parameter> :</term>
187 <listitem><simpara> a GError ptr, or NULL if not interested.
188 </simpara></listitem></varlistentry>
189 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if succeeded or FALSE in case of error.
190 <parameter>err</parameter> gives details in case of error
191 </simpara></listitem></varlistentry>
192 </variablelist></refsect2>
194 <title><anchor id="modest-conf-set-int" role="function"/>modest_conf_set_int ()</title>
195 <indexterm><primary>modest_conf_set_int</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> modest_conf_set_int (<link linkend="ModestConf">ModestConf</link> *self,
196 const <link linkend="gchar">gchar</link> *key,
197 <link linkend="int">int</link> val,
198 <link linkend="GError">GError</link> **err);</programlisting>
200 store an integer value in the configuration system</para>
203 </para><variablelist role="params">
204 <varlistentry><term><parameter>self</parameter> :</term>
205 <listitem><simpara> a ModestConf instance
206 </simpara></listitem></varlistentry>
207 <varlistentry><term><parameter>key</parameter> :</term>
208 <listitem><simpara> the key of the value to set
209 </simpara></listitem></varlistentry>
210 <varlistentry><term><parameter>val</parameter> :</term>
211 <listitem><simpara> the value to set
212 </simpara></listitem></varlistentry>
213 <varlistentry><term><parameter>err</parameter> :</term>
214 <listitem><simpara> a GError ptr, or NULL if not interested.
215 </simpara></listitem></varlistentry>
216 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if succeeded or FALSE in case of error.
217 <parameter>err</parameter> gives details in case of error
218 </simpara></listitem></varlistentry>
219 </variablelist></refsect2>
221 <title><anchor id="modest-conf-set-bool" role="function"/>modest_conf_set_bool ()</title>
222 <indexterm><primary>modest_conf_set_bool</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> modest_conf_set_bool (<link linkend="ModestConf">ModestConf</link> *self,
223 const <link linkend="gchar">gchar</link> *key,
224 <link linkend="gboolean">gboolean</link> val,
225 <link linkend="GError">GError</link> **err);</programlisting>
227 store a boolean value in the configuration system</para>
230 </para><variablelist role="params">
231 <varlistentry><term><parameter>self</parameter> :</term>
232 <listitem><simpara> a ModestConf instance
233 </simpara></listitem></varlistentry>
234 <varlistentry><term><parameter>key</parameter> :</term>
235 <listitem><simpara> the key of the value to set
236 </simpara></listitem></varlistentry>
237 <varlistentry><term><parameter>val</parameter> :</term>
238 <listitem><simpara> the value to set
239 </simpara></listitem></varlistentry>
240 <varlistentry><term><parameter>err</parameter> :</term>
241 <listitem><simpara> a GError ptr, or NULL if not interested.
242 </simpara></listitem></varlistentry>
243 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if succeeded or FALSE in case of error.
244 <parameter>err</parameter> gives details in case of error
245 </simpara></listitem></varlistentry>
246 </variablelist></refsect2>
248 <title><anchor id="modest-conf-list-subkeys" role="function"/>modest_conf_list_subkeys ()</title>
249 <indexterm><primary>modest_conf_list_subkeys</primary></indexterm><programlisting><link linkend="GSList">GSList</link>* modest_conf_list_subkeys (<link linkend="ModestConf">ModestConf</link> *self,
250 const <link linkend="gchar">gchar</link> *key,
251 <link linkend="GError">GError</link> **err);</programlisting>
253 list all the subkeys for a given key</para>
256 </para><variablelist role="params">
257 <varlistentry><term><parameter>self</parameter> :</term>
258 <listitem><simpara> a ModestConf instance
259 </simpara></listitem></varlistentry>
260 <varlistentry><term><parameter>key</parameter> :</term>
261 <listitem><simpara> the key whose subkeys will be listed
262 </simpara></listitem></varlistentry>
263 <varlistentry><term><parameter>err</parameter> :</term>
264 <listitem><simpara> a GError ptr, or NULL if not interested.
265 </simpara></listitem></varlistentry>
266 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated list or NULL in case of error
267 the returned GSList must be freed by the caller
268 <parameter>err</parameter> gives details in case of error
269 </simpara></listitem></varlistentry>
270 </variablelist></refsect2>
272 <title><anchor id="modest-conf-remove-key" role="function"/>modest_conf_remove_key ()</title>
273 <indexterm><primary>modest_conf_remove_key</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> modest_conf_remove_key (<link linkend="ModestConf">ModestConf</link> *self,
274 const <link linkend="gchar">gchar</link> *key,
275 <link linkend="GError">GError</link> **err);</programlisting>
277 attempts to remove <parameter>key</parameter> and all its subkeys</para>
280 </para><variablelist role="params">
281 <varlistentry><term><parameter>self</parameter> :</term>
282 <listitem><simpara> a ModestConf instance
283 </simpara></listitem></varlistentry>
284 <varlistentry><term><parameter>key</parameter> :</term>
285 <listitem><simpara> the key to remove
286 </simpara></listitem></varlistentry>
287 <varlistentry><term><parameter>err</parameter> :</term>
288 <listitem><simpara> a GError ptr, or NULL if not interested.
289 </simpara></listitem></varlistentry>
290 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if succeeded or FALSE in case of error.
291 <parameter>err</parameter> gives details in case of error
292 </simpara></listitem></varlistentry>
293 </variablelist></refsect2>
295 <title><anchor id="modest-conf-key-exists" role="function"/>modest_conf_key_exists ()</title>
296 <indexterm><primary>modest_conf_key_exists</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> modest_conf_key_exists (<link linkend="ModestConf">ModestConf</link> *self,
297 const <link linkend="gchar">gchar</link> *key,
298 <link linkend="GError">GError</link> **err);</programlisting>
300 checks if the given key exists in the configuration system</para>
303 </para><variablelist role="params">
304 <varlistentry><term><parameter>self</parameter> :</term>
305 <listitem><simpara> a ModestConf instance
306 </simpara></listitem></varlistentry>
307 <varlistentry><term><parameter>key</parameter> :</term>
308 <listitem><simpara> the key to remove
309 </simpara></listitem></varlistentry>
310 <varlistentry><term><parameter>err</parameter> :</term>
311 <listitem><simpara> a GError ptr, or NULL if not interested.
312 </simpara></listitem></varlistentry>
313 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if exists, FALSE otherwise.
314 <parameter>err</parameter> gives details in case of error
315 </simpara></listitem></varlistentry>
316 </variablelist></refsect2>