← Back to branch summary

~ubuntu-branches/ubuntu/lucid/libxfce4util/lucid

« back to all changes in this revision

Viewing changes to docs/html/libxfce4util-Desktop-entries.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Casadevall
  • Date: 2009-01-17 15:36:28 UTC
  • mfrom: (1.2.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20090117153628-ulyk11ozaa2b19tk
Tags: 4.5.93-0ubuntu1
* Merge with Debian Xfce UNRELEASED, remaining Ubuntu changes:
  - debian/control:
    - added gtk-doc-tools to build-deps
  - debian/rules: 
    - pass --enable-gtk-doc to ./configure
  - debian/patches/series: 
    - don't apply 01_add-desktop-base-in-config-dirs.patch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/libxfce4util-Desktop-entries.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>XfceDesktopEntry</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
7
 
<link rel="home" href="index.html" title="libxfce4util Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
 
7
<link rel="start" href="index.html" title="libxfce4util Reference Manual">
8
8
<link rel="up" href="libxfce4util-core.html" title="Xfce Core Application support">
9
9
<link rel="prev" href="libxfce4util-core.html" title="Xfce Core Application support">
10
10
<link rel="next" href="libxfce4util-Xfce-Kiosk-functions.html" title="Xfce Kiosk functions">
47
47
#include &lt;libxfce4util/libxfce4util.h&gt;
48
48
 
49
49
                    <a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry-struct" title="XfceDesktopEntry">XfceDesktopEntry</a>;
50
 
<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>*   <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-new" title="xfce_desktop_entry_new ()">xfce_desktop_entry_new</a>              (const <a
51
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
52
 
>gchar</a> *file,
53
 
                                                         const <a
54
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
55
 
>gchar</a> **categories,
56
 
                                                         <a
57
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
58
 
>gint</a> num_categories);
59
 
<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>*   <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-new-from-data" title="xfce_desktop_entry_new_from_data ()">xfce_desktop_entry_new_from_data</a>    (const <a
60
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
61
 
>gchar</a> *data,
62
 
                                                         const <a
63
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
64
 
>gchar</a> **categories,
65
 
                                                         <a
66
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
67
 
>gint</a> num_categories);
68
 
const <a
69
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
70
 
>gchar</a>*        <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-file" title="xfce_desktop_entry_get_file ()">xfce_desktop_entry_get_file</a>         (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);
71
 
<a
72
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
73
 
>gboolean</a>            <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-string" title="xfce_desktop_entry_get_string ()">xfce_desktop_entry_get_string</a>       (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
74
 
                                                         const <a
75
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
76
 
>gchar</a> *key,
77
 
                                                         <a
78
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
79
 
>gboolean</a> translated,
80
 
                                                         <a
81
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
82
 
>gchar</a> **value_return);
83
 
<a
84
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
85
 
>gboolean</a>            <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-int" title="xfce_desktop_entry_get_int ()">xfce_desktop_entry_get_int</a>          (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
86
 
                                                         const <a
87
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
88
 
>gchar</a> *key,
89
 
                                                         <a
90
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
91
 
>gint</a> *value_return);
92
 
<a
93
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
94
 
>gboolean</a>            <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-has-translated-entry" title="xfce_desktop_entry_has_translated_entry ()">xfce_desktop_entry_has_translated_entry</a>
 
50
<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>*   <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-new" title="xfce_desktop_entry_new ()">xfce_desktop_entry_new</a>              (const gchar *file,
 
51
                                                         const gchar **categories,
 
52
                                                         gint num_categories);
 
53
<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>*   <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-new-from-data" title="xfce_desktop_entry_new_from_data ()">xfce_desktop_entry_new_from_data</a>    (const gchar *data,
 
54
                                                         const gchar **categories,
 
55
                                                         gint num_categories);
 
56
const gchar*        <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-file" title="xfce_desktop_entry_get_file ()">xfce_desktop_entry_get_file</a>         (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);
 
57
gboolean            <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-string" title="xfce_desktop_entry_get_string ()">xfce_desktop_entry_get_string</a>       (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
 
58
                                                         const gchar *key,
 
59
                                                         gboolean translated,
 
60
                                                         gchar **value_return);
 
61
gboolean            <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-int" title="xfce_desktop_entry_get_int ()">xfce_desktop_entry_get_int</a>          (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
 
62
                                                         const gchar *key,
 
63
                                                         gint *value_return);
 
64
gboolean            <a class="link" href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-has-translated-entry" title="xfce_desktop_entry_has_translated_entry ()">xfce_desktop_entry_has_translated_entry</a>
95
65
                                                        (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
96
 
                                                         const <a
97
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
98
 
>gchar</a> *key);
 
66
                                                         const gchar *key);
99
67
</pre>
100
68
</div>
101
69
<div class="refsect1" lang="en">
102
70
<a name="libxfce4util-Desktop-entries.object-hierarchy"></a><h2>Object Hierarchy</h2>
103
71
<pre class="synopsis">
104
 
  <a
105
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
106
 
>GObject</a>
 
72
  GObject
107
73
   +----XfceDesktopEntry
108
74
</pre>
109
75
</div>
128
94
<hr>
129
95
<div class="refsect2" lang="en">
130
96
<a name="xfce-desktop-entry-new"></a><h3>xfce_desktop_entry_new ()</h3>
131
 
<pre class="programlisting"><a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>*   xfce_desktop_entry_new              (const <a
132
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
133
 
>gchar</a> *file,
134
 
                                                         const <a
135
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
136
 
>gchar</a> **categories,
137
 
                                                         <a
138
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
139
 
>gint</a> num_categories);</pre>
 
97
<pre class="programlisting"><a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>*   xfce_desktop_entry_new              (const gchar *file,
 
98
                                                         const gchar **categories,
 
99
                                                         gint num_categories);</pre>
140
100
<p>
141
101
Create a new <a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry"><span class="type">XfceDesktopEntry</span></a> object from a desktop entry stored in a file on disk.
142
102
</p>
143
103
<p>
144
104
The caller is responsible to free the returned object (if any) using
145
 
<a
146
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"
147
 
><code class="function">g_object_unref()</code></a> when no longer needed.</p>
 
105
<code class="function">g_object_unref()</code> when no longer needed.</p>
148
106
<p>
149
107
 
150
108
</p>
180
138
<hr>
181
139
<div class="refsect2" lang="en">
182
140
<a name="xfce-desktop-entry-new-from-data"></a><h3>xfce_desktop_entry_new_from_data ()</h3>
183
 
<pre class="programlisting"><a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>*   xfce_desktop_entry_new_from_data    (const <a
184
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
185
 
>gchar</a> *data,
186
 
                                                         const <a
187
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
188
 
>gchar</a> **categories,
189
 
                                                         <a
190
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
191
 
>gint</a> num_categories);</pre>
 
141
<pre class="programlisting"><a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>*   xfce_desktop_entry_new_from_data    (const gchar *data,
 
142
                                                         const gchar **categories,
 
143
                                                         gint num_categories);</pre>
192
144
<p>
193
145
Create a new <a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry"><span class="type">XfceDesktopEntry</span></a> object from a desktop entry stored in memory.
194
146
</p>
195
147
<p>
196
148
The caller is responsible to free the returned object (if any) using
197
 
<a
198
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"
199
 
><code class="function">g_object_unref()</code></a> when no longer needed.</p>
 
149
<code class="function">g_object_unref()</code> when no longer needed.</p>
200
150
<p>
201
151
 
202
152
</p>
232
182
<hr>
233
183
<div class="refsect2" lang="en">
234
184
<a name="xfce-desktop-entry-get-file"></a><h3>xfce_desktop_entry_get_file ()</h3>
235
 
<pre class="programlisting">const <a
236
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
237
 
>gchar</a>*        xfce_desktop_entry_get_file         (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);</pre>
 
185
<pre class="programlisting">const gchar*        xfce_desktop_entry_get_file         (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);</pre>
238
186
<p>
239
187
Obtain the path to the desktop entry file associated with the
240
188
<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry"><span class="type">XfceDesktopEntry</span></a>.</p>
264
212
<hr>
265
213
<div class="refsect2" lang="en">
266
214
<a name="xfce-desktop-entry-get-string"></a><h3>xfce_desktop_entry_get_string ()</h3>
267
 
<pre class="programlisting"><a
268
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
269
 
>gboolean</a>            xfce_desktop_entry_get_string       (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
270
 
                                                         const <a
271
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
272
 
>gchar</a> *key,
273
 
                                                         <a
274
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
275
 
>gboolean</a> translated,
276
 
                                                         <a
277
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
278
 
>gchar</a> **value_return);</pre>
 
215
<pre class="programlisting">gboolean            xfce_desktop_entry_get_string       (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
 
216
                                                         const gchar *key,
 
217
                                                         gboolean translated,
 
218
                                                         gchar **value_return);</pre>
279
219
<p>
280
220
Finds the value for <em class="parameter"><code>key</code></em>. When <em class="parameter"><code>translated</code></em> is TRUE the function will use
281
221
the translated value (using the current locale settings) if available or
320
260
<hr>
321
261
<div class="refsect2" lang="en">
322
262
<a name="xfce-desktop-entry-get-int"></a><h3>xfce_desktop_entry_get_int ()</h3>
323
 
<pre class="programlisting"><a
324
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
325
 
>gboolean</a>            xfce_desktop_entry_get_int          (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
326
 
                                                         const <a
327
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
328
 
>gchar</a> *key,
329
 
                                                         <a
330
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
331
 
>gint</a> *value_return);</pre>
 
263
<pre class="programlisting">gboolean            xfce_desktop_entry_get_int          (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
 
264
                                                         const gchar *key,
 
265
                                                         gint *value_return);</pre>
332
266
<p>
333
267
Gets a value from <em class="parameter"><code>desktop_entry</code></em> as integer. Therefore finds the value for
334
268
<em class="parameter"><code>key</code></em> and returns its integer representation.</p>
367
301
<hr>
368
302
<div class="refsect2" lang="en">
369
303
<a name="xfce-desktop-entry-has-translated-entry"></a><h3>xfce_desktop_entry_has_translated_entry ()</h3>
370
 
<pre class="programlisting"><a
371
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
372
 
>gboolean</a>            xfce_desktop_entry_has_translated_entry
 
304
<pre class="programlisting">gboolean            xfce_desktop_entry_has_translated_entry
373
305
                                                        (<a class="link" href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
374
 
                                                         const <a
375
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
376
 
>gchar</a> *key);</pre>
 
306
                                                         const gchar *key);</pre>
377
307
<p>
378
308
Checks to see if <em class="parameter"><code>desktop_entry</code></em> has a value for <em class="parameter"><code>key</code></em> translated into
379
309
the current locale.</p>
395
325
</tr>
396
326
<tr>
397
327
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
398
 
<td> <a
399
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
400
 
><code class="literal">TRUE</code></a> if there is a translated key, <a
401
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
402
 
><code class="literal">FALSE</code></a> otherwise.
 
328
<td> <code class="literal">TRUE</code> if there is a translated key, <code class="literal">FALSE</code> otherwise.
403
329
 
404
330
</td>
405
331
</tr>