libanjuta-dev 2:3.18.2-1 / usr / share / gtk-doc / html / libanjuta / AnjutaPreferences.html

This file is indexed.

/usr/share/gtk-doc/html/libanjuta/AnjutaPreferences.html is in libanjuta-dev 2:3.18.2-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Anjuta Developers Reference Manual: AnjutaPreferences</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Anjuta Developers Reference Manual">
<link rel="up" href="libanjuta-api.html" title="libanjuta API">
<link rel="prev" href="AnjutaShell.html" title="AnjutaShell">
<link rel="next" href="AnjutaPreferencesDialog.html" title="AnjutaPreferencesDialog">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#AnjutaPreferences.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#AnjutaPreferences.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libanjuta-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="AnjutaShell.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AnjutaPreferencesDialog.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AnjutaPreferences"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AnjutaPreferences.top_of_page"></a>AnjutaPreferences</span></h2>
<p>AnjutaPreferences — Anjuta Preferences system.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AnjutaPreferences.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="AnjutaPreferences.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="AnjutaPreferences.html#anjuta-property-get-widget" title="anjuta_property_get_widget ()">anjuta_property_get_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="AnjutaPreferences.html#AnjutaPreferencesCallback" title="AnjutaPreferencesCallback ()">*AnjutaPreferencesCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="returnvalue">AnjutaPreferences</span></a> *
</td>
<td class="function_name">
<a class="link" href="AnjutaPreferences.html#anjuta-preferences-new" title="anjuta_preferences_new ()">anjuta_preferences_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="returnvalue">AnjutaPreferences</span></a> *
</td>
<td class="function_name">
<a class="link" href="AnjutaPreferences.html#anjuta-preferences-default" title="anjuta_preferences_default ()">anjuta_preferences_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaPreferences.html#anjuta-preferences-add-from-builder" title="anjuta_preferences_add_from_builder ()">anjuta_preferences_add_from_builder</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaPreferences.html#anjuta-preferences-remove-page" title="anjuta_preferences_remove_page ()">anjuta_preferences_remove_page</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaPreferences.html#anjuta-preferences-register-all-properties-from-builder-xml" title="anjuta_preferences_register_all_properties_from_builder_xml ()">anjuta_preferences_register_all_properties_from_builder_xml</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaPreferences.html#anjuta-preferences-register-property" title="anjuta_preferences_register_property ()">anjuta_preferences_register_property</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="AnjutaPreferences.html#anjuta-preferences-get-dialog" title="anjuta_preferences_get_dialog ()">anjuta_preferences_get_dialog</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="AnjutaPreferences.html#anjuta-preferences-is-dialog-created" title="anjuta_preferences_is_dialog_created ()">anjuta_preferences_is_dialog_created</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AnjutaPreferences.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="AnjutaPreferences.html#AnjutaProperty" title="AnjutaProperty">AnjutaProperty</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="AnjutaPreferences.html#AnjutaPreferencesPriv" title="AnjutaPreferencesPriv">AnjutaPreferencesPriv</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AnjutaPreferences.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> AnjutaPreferences
</pre>
</div>
<div class="refsect1">
<a name="AnjutaPreferences.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libanjuta/anjuta-preferences.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="AnjutaPreferences.description"></a><h2>Description</h2>
<p><a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> is a way to let plugins register their preferences. There
are mainly two ways a plugin could register its preferences in Anjuta.</p>
<p>First is to not use <a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> at all. Simply register a
preferences page in <a class="link" href="AnjutaPreferencesDialog.html" title="AnjutaPreferencesDialog"><span class="type">AnjutaPreferencesDialog</span></a> using the function
<a class="link" href="AnjutaPreferencesDialog.html#anjuta-preferences-dialog-add-page" title="anjuta_preferences_dialog_add_page ()"><code class="function">anjuta_preferences_dialog_add_page()</code></a>. The plugin should take
care of loading, saving and widgets synchronization of the
preferences values. This can be done using <span class="type">GSettings</span> bindings
for example.</p>
<p>Second is to use <code class="function">anjuta_preferences_add_page()</code>, which will
automatically register the preferences keys and values from
a glade xml file. The glade xml file contains a preferences
page of the plugin. The widget names in the page are
given in a particular way (see <code class="function">anjuta_preferences_add_page()</code>) to
let it know property key details. The preference dialog will automatically
setup the bindings between GSettings and the widgets.</p>
</div>
<div class="refsect1">
<a name="AnjutaPreferences.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="anjuta-property-get-widget"></a><h3>anjuta_property_get_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
anjuta_property_get_widget (<em class="parameter"><code><a class="link" href="AnjutaPreferences.html#AnjutaProperty" title="AnjutaProperty"><span class="type">AnjutaProperty</span></a> *prop</code></em>);</pre>
<p>
</p>
<div class="refsect3">
<a name="id-1.6.3.9.2.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaPreferencesCallback"></a><h3>AnjutaPreferencesCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
<span class="c_punctuation">(</span>*AnjutaPreferencesCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> *pr</code></em>,
                              <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
                              <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
</p>
<div class="refsect3">
<a name="id-1.6.3.9.3.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-preferences-new"></a><h3>anjuta_preferences_new ()</h3>
<pre class="programlisting"><a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="returnvalue">AnjutaPreferences</span></a> *
anjuta_preferences_new (<em class="parameter"><code><a class="link" href="AnjutaPluginManager.html" title="AnjutaPluginManager"><span class="type">AnjutaPluginManager</span></a> *plugin_manager</code></em>,
                        <em class="parameter"><code>const <span class="type">gchar</span> *common_schema_id</code></em>);</pre>
<p>Creates a new <a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> object</p>
<div class="refsect3">
<a name="id-1.6.3.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plugin_manager</p></td>
<td class="parameter_description"><p><a class="link" href="AnjutaPluginManager.html" title="AnjutaPluginManager"><span class="type">AnjutaPluginManager</span></a> to be used</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>common_schema_id</p></td>
<td class="parameter_description"><p>Common schema id used for key starting with .</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.3.9.4.6"></a><h4>Returns</h4>
<p> A <a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> object.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-preferences-default"></a><h3>anjuta_preferences_default ()</h3>
<pre class="programlisting"><a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="returnvalue">AnjutaPreferences</span></a> *
anjuta_preferences_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
<div class="refsect3">
<a name="id-1.6.3.9.5.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-preferences-add-from-builder"></a><h3>anjuta_preferences_add_from_builder ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_preferences_add_from_builder (<em class="parameter"><code><a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> *pr</code></em>,
                                     <em class="parameter"><code><span class="type">GtkBuilder</span> *builder</code></em>,
                                     <em class="parameter"><code><span class="type">GSettings</span> *settings</code></em>,
                                     <em class="parameter"><code>const <span class="type">gchar</span> *glade_widget_name</code></em>,
                                     <em class="parameter"><code>const <span class="type">gchar</span> *stitle</code></em>,
                                     <em class="parameter"><code>const <span class="type">gchar</span> *icon_filename</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-preferences-remove-page"></a><h3>anjuta_preferences_remove_page ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_preferences_remove_page (<em class="parameter"><code><a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> *pr</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *page_name</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-preferences-register-all-properties-from-builder-xml"></a><h3>anjuta_preferences_register_all_properties_from_builder_xml ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
anjuta_preferences_register_all_properties_from_builder_xml
                               (<em class="parameter"><code><a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> *pr</code></em>,
                                <em class="parameter"><code><span class="type">GtkBuilder</span> *builder</code></em>,
                                <em class="parameter"><code><span class="type">GSettings</span> *settings</code></em>,
                                <em class="parameter"><code><span class="type">GtkWidget</span> *parent</code></em>);</pre>
<p>This will register all the properties names of the format described above
without considering the UI. Useful if you have the widgets shown elsewhere
but you want them to be part of preferences system.</p>
<div class="refsect3">
<a name="id-1.6.3.9.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pr</p></td>
<td class="parameter_description"><p>a <a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> Object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>builder</p></td>
<td class="parameter_description"><p>GtkBuilder object containing the properties widgets.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>Parent widget in the builder object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-preferences-register-property"></a><h3>anjuta_preferences_register_property ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
anjuta_preferences_register_property (<em class="parameter"><code><a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> *pr</code></em>,
                                      <em class="parameter"><code><span class="type">GSettings</span> *settings</code></em>,
                                      <em class="parameter"><code><span class="type">GtkWidget</span> *object</code></em>,
                                      <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
<p>This registers only one widget. The widget could be shown elsewhere.
The widget needs to fulfill the properties described in
<span class="type">anjuta_preferences_add_page</span> documentation.</p>
<div class="refsect3">
<a name="id-1.6.3.9.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pr</p></td>
<td class="parameter_description"><p>a <a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>settings</p></td>
<td class="parameter_description"><p>the <span class="type">GSettings</span> object associated with that property</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>Widget to register</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>Property key</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.3.9.9.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if sucessful.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-preferences-get-dialog"></a><h3>anjuta_preferences_get_dialog ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
anjuta_preferences_get_dialog (<em class="parameter"><code><a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> *pr</code></em>);</pre>
<p>
</p>
<div class="refsect3">
<a name="id-1.6.3.9.10.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-preferences-is-dialog-created"></a><h3>anjuta_preferences_is_dialog_created ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
anjuta_preferences_is_dialog_created (<em class="parameter"><code><a class="link" href="AnjutaPreferences.html" title="AnjutaPreferences"><span class="type">AnjutaPreferences</span></a> *pr</code></em>);</pre>
<p>
</p>
<div class="refsect3">
<a name="id-1.6.3.9.11.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="AnjutaPreferences.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AnjutaProperty"></a><h3>AnjutaProperty</h3>
<pre class="programlisting">typedef struct _AnjutaProperty AnjutaProperty;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaPreferencesPriv"></a><h3>AnjutaPreferencesPriv</h3>
<pre class="programlisting">typedef struct _AnjutaPreferencesPriv AnjutaPreferencesPriv;</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="AnjutaPreferences.see-also"></a><h2>See Also</h2>
<p><a class="link" href="AnjutaPreferencesDialog.html" title="AnjutaPreferencesDialog"><span class="type">AnjutaPreferencesDialog</span></a></p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.