~ubuntu-branches/ubuntu/edgy/libxfce4util/edgy

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Yves-Alexis Perez
  • Date: 2005-11-27 12:08:34 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051127120834-uq5ptp5p6fyipwkt
Tags: 4.2.3.2-1
* Yves-Alexis Perez
 * New Upstream Release
* Simon Huggins
 * Configure sysconfdir correctly                             closes: #329139
 

Show diffs side-by-side

added added

removed removed

Lines of Context:
41
41
                                            (const char *data,
42
42
                                             const char **categories,
43
43
                                             int num_categories);
44
 
gboolean    <a href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-parse">xfce_desktop_entry_parse</a>        (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);
 
44
<a
 
45
href="../glib/glib-Basic-Types.html#gboolean"
 
46
>gboolean</a>    <a href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-parse">xfce_desktop_entry_parse</a>        (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);
45
47
char*       <a href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-file">xfce_desktop_entry_get_file</a>     (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);
46
 
gboolean    <a href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-string">xfce_desktop_entry_get_string</a>   (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
 
48
<a
 
49
href="../glib/glib-Basic-Types.html#gboolean"
 
50
>gboolean</a>    <a href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-string">xfce_desktop_entry_get_string</a>   (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
47
51
                                             const char *key,
48
 
                                             gboolean translated,
 
52
                                             <a
 
53
href="../glib/glib-Basic-Types.html#gboolean"
 
54
>gboolean</a> translated,
49
55
                                             char **value);
50
 
gboolean    <a href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-int">xfce_desktop_entry_get_int</a>      (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
 
56
<a
 
57
href="../glib/glib-Basic-Types.html#gboolean"
 
58
>gboolean</a>    <a href="libxfce4util-Desktop-entries.html#xfce-desktop-entry-get-int">xfce_desktop_entry_get_int</a>      (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
51
59
                                             const char *key,
52
60
                                             int *value);
53
61
 
54
 
</pre></div><div class="refsect1" lang="en"><a name="id2513087"></a><h2>Object Hierarchy</h2><pre class="synopsis">
 
62
</pre></div><div class="refsect1" lang="en"><a name="id2513105"></a><h2>Object Hierarchy</h2><pre class="synopsis">
55
63
 
56
 
  GObject
 
64
  <a
 
65
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
 
66
>GObject</a>
57
67
   +----XfceDesktopEntry
58
 
</pre></div><div class="refsect1" lang="en"><a name="id2513108"></a><h2>Description</h2><p>
 
68
</pre></div><div class="refsect1" lang="en"><a name="id2513125"></a><h2>Description</h2><p>
59
69
XfceDesktopEntry is a wrapper for a so-called desktop entry file. The
60
70
desktop entry format is defined on <a href="http://www.freedesktop.org/" target="_top">Freedesktop.org</a>.
61
 
</p></div><div class="refsect1" lang="en"><a name="id2513125"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2513131"></a><h3><a name="XfceDesktopEntry-struct"></a>struct XfceDesktopEntry</h3><a class="indexterm" name="id2513142"></a><pre class="programlisting">struct XfceDesktopEntry;</pre><p>
 
71
</p></div><div class="refsect1" lang="en"><a name="id2513143"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2513149"></a><h3><a name="XfceDesktopEntry-struct"></a>struct XfceDesktopEntry</h3><a class="indexterm" name="id2513160"></a><pre class="programlisting">struct XfceDesktopEntry;</pre><p>
62
72
All the fields in the XfceDesktopEntry structure are private to the
63
73
XfceDesktopEntry implementation and should never be accessed directly.
64
74
Instead, you should use the functions listed below.
65
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2513161"></a><h3><a name="xfce-desktop-entry-new"></a>xfce_desktop_entry_new ()</h3><a class="indexterm" name="id2513172"></a><pre class="programlisting"><a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>* xfce_desktop_entry_new    (const char *file,
 
75
</p></div><hr><div class="refsect2" lang="en"><a name="id2513178"></a><h3><a name="xfce-desktop-entry-new"></a>xfce_desktop_entry_new ()</h3><a class="indexterm" name="id2513189"></a><pre class="programlisting"><a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>* xfce_desktop_entry_new    (const char *file,
66
76
                                             const char **categories,
67
77
                                             int num_categories);</pre><p>
68
78
Create a new XfceDesktopEntry object from a desktop entry stored in memory.</p><p>
72
82
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_categories</tt></i>�:</span></td><td> number of items in <i class="parameter"><tt>categories</tt></i>.
73
83
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> newly created <a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry"><span class="type">XfceDesktopEntry</span></a> or NULL if something goes wrong.
74
84
</td></tr></tbody></table></div><p>Since  4.2
75
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2513295"></a><h3><a name="xfce-desktop-entry-new-from-data"></a>xfce_desktop_entry_new_from_data ()</h3><a class="indexterm" name="id2513306"></a><pre class="programlisting"><a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>* xfce_desktop_entry_new_from_data
 
85
</p></div><hr><div class="refsect2" lang="en"><a name="id2513312"></a><h3><a name="xfce-desktop-entry-new-from-data"></a>xfce_desktop_entry_new_from_data ()</h3><a class="indexterm" name="id2513324"></a><pre class="programlisting"><a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a>* xfce_desktop_entry_new_from_data
76
86
                                            (const char *data,
77
87
                                             const char **categories,
78
88
                                             int num_categories);</pre><p>
83
93
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_categories</tt></i>�:</span></td><td> number of items in <i class="parameter"><tt>categories</tt></i>.
84
94
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> newly created <a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry"><span class="type">XfceDesktopEntry</span></a> or NULL if something goes wrong.
85
95
</td></tr></tbody></table></div><p>Since  4.2
86
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2513430"></a><h3><a name="xfce-desktop-entry-parse"></a>xfce_desktop_entry_parse ()</h3><a class="indexterm" name="id2513441"></a><pre class="programlisting">gboolean    xfce_desktop_entry_parse        (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">xfce_desktop_entry_parse</tt> is deprecated and should not be used in newly-written code.</p></div><p>
 
96
</p></div><hr><div class="refsect2" lang="en"><a name="id2513448"></a><h3><a name="xfce-desktop-entry-parse"></a>xfce_desktop_entry_parse ()</h3><a class="indexterm" name="id2513459"></a><pre class="programlisting"><a
 
97
href="../glib/glib-Basic-Types.html#gboolean"
 
98
>gboolean</a>    xfce_desktop_entry_parse        (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">xfce_desktop_entry_parse</tt> is deprecated and should not be used in newly-written code.</p></div><p>
87
99
Parses the desktop entry file and fills in the values for all categories.</p><p>
88
100
 
89
101
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>desktop_entry</tt></i>�:</span></td><td> an <a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry"><span class="type">XfceDesktopEntry</span></a>.
90
102
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success, FALSE on failure.
91
103
</td></tr></tbody></table></div><p>Since  4.2
92
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2513524"></a><h3><a name="xfce-desktop-entry-get-file"></a>xfce_desktop_entry_get_file ()</h3><a class="indexterm" name="id2513536"></a><pre class="programlisting">char*       xfce_desktop_entry_get_file     (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);</pre><p>
 
104
</p></div><hr><div class="refsect2" lang="en"><a name="id2513542"></a><h3><a name="xfce-desktop-entry-get-file"></a>xfce_desktop_entry_get_file ()</h3><a class="indexterm" name="id2513554"></a><pre class="programlisting">char*       xfce_desktop_entry_get_file     (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry);</pre><p>
93
105
Obtain the path to the desktop entry file associated with the
94
106
<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry"><span class="type">XfceDesktopEntry</span></a>.</p><p>
95
107
 
98
110
          return value should be considered read-only and must not be freed
99
111
          by the caller.
100
112
</td></tr></tbody></table></div><p>Since  4.2
101
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2513624"></a><h3><a name="xfce-desktop-entry-get-string"></a>xfce_desktop_entry_get_string ()</h3><a class="indexterm" name="id2513637"></a><pre class="programlisting">gboolean    xfce_desktop_entry_get_string   (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
 
113
</p></div><hr><div class="refsect2" lang="en"><a name="id2513642"></a><h3><a name="xfce-desktop-entry-get-string"></a>xfce_desktop_entry_get_string ()</h3><a class="indexterm" name="id2513654"></a><pre class="programlisting"><a
 
114
href="../glib/glib-Basic-Types.html#gboolean"
 
115
>gboolean</a>    xfce_desktop_entry_get_string   (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
102
116
                                             const char *key,
103
 
                                             gboolean translated,
 
117
                                             <a
 
118
href="../glib/glib-Basic-Types.html#gboolean"
 
119
>gboolean</a> translated,
104
120
                                             char **value);</pre><p>
105
121
Finds the value for <i class="parameter"><tt>key</tt></i>. When <i class="parameter"><tt>translated</tt></i> is TRUE the function will use
106
122
the translated value (using the current locale settings) if available or
112
128
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i>�:</span></td><td> location for the value, which will be newly allocated.
113
129
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success, FALSE on failure. <i class="parameter"><tt>value</tt></i> must be freed.
114
130
</td></tr></tbody></table></div><p>Since  4.2
115
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2513795"></a><h3><a name="xfce-desktop-entry-get-int"></a>xfce_desktop_entry_get_int ()</h3><a class="indexterm" name="id2513807"></a><pre class="programlisting">gboolean    xfce_desktop_entry_get_int      (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
 
131
</p></div><hr><div class="refsect2" lang="en"><a name="id2513813"></a><h3><a name="xfce-desktop-entry-get-int"></a>xfce_desktop_entry_get_int ()</h3><a class="indexterm" name="id2513825"></a><pre class="programlisting"><a
 
132
href="../glib/glib-Basic-Types.html#gboolean"
 
133
>gboolean</a>    xfce_desktop_entry_get_int      (<a href="libxfce4util-Desktop-entries.html#XfceDesktopEntry">XfceDesktopEntry</a> *desktop_entry,
116
134
                                             const char *key,
117
135
                                             int *value);</pre><p>
118
136
Gets a value from <i class="parameter"><tt>desktop_entry</tt></i> as integer. Therefore finds the value for