/usr/share/gtk-doc/html/PackageKit/PkDesktop.html is in packagekit-docs 0.8.12-1ubuntu5.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PkDesktop</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="PackageKit Reference Manual">
<link rel="up" href="libpackagekit-gobject.html" title="libpackagekit GObjects">
<link rel="prev" href="PkControl.html" title="PkControl">
<link rel="next" href="PkDetails.html" title="PkDetails">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="PkControl.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libpackagekit-gobject.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">PackageKit Reference Manual</th>
<td><a accesskey="n" href="PkDetails.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PkDesktop.synopsis" class="shortcut">Top</a>
|
<a href="#PkDesktop.description" class="shortcut">Description</a>
|
<a href="#PkDesktop.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="PkDesktop"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PkDesktop.top_of_page"></a>PkDesktop</span></h2>
<p>PkDesktop — Find desktop metadata about a package</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PkDesktop.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="PkDesktop.html#PK-DESKTOP-DEFAULT-DATABASE:CAPS" title="PK_DESKTOP_DEFAULT_DATABASE">PK_DESKTOP_DEFAULT_DATABASE</a>
#define <a class="link" href="PkDesktop.html#PK-DESKTOP-DEFAULT-APPLICATION-DIR:CAPS" title="PK_DESKTOP_DEFAULT_APPLICATION_DIR">PK_DESKTOP_DEFAULT_APPLICATION_DIR</a>
struct <a class="link" href="PkDesktop.html#PkDesktop-struct" title="struct PkDesktop">PkDesktop</a>;
struct <a class="link" href="PkDesktop.html#PkDesktopClass" title="struct PkDesktopClass">PkDesktopClass</a>;
<a class="link" href="PkDesktop.html" title="PkDesktop"><span class="returnvalue">PkDesktop</span></a> * <a class="link" href="PkDesktop.html#pk-desktop-new" title="pk_desktop_new ()">pk_desktop_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="PkDesktop.html#pk-desktop-test" title="pk_desktop_test ()">pk_desktop_test</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="PkDesktop.html#pk-desktop-open-database" title="pk_desktop_open_database ()">pk_desktop_open_database</a> (<em class="parameter"><code><a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="PkDesktop.html#pk-desktop-get-files-for-package" title="pk_desktop_get_files_for_package ()">pk_desktop_get_files_for_package</a> (<em class="parameter"><code><a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *package</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="PkDesktop.html#pk-desktop-get-shown-for-package" title="pk_desktop_get_shown_for_package ()">pk_desktop_get_shown_for_package</a> (<em class="parameter"><code><a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *package</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="PkDesktop.html#pk-desktop-get-package-for-file" title="pk_desktop_get_package_for_file ()">pk_desktop_get_package_for_file</a> (<em class="parameter"><code><a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="PkDesktop.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----PkDesktop
</pre>
</div>
<div class="refsect1">
<a name="PkDesktop.description"></a><h2>Description</h2>
<p>
Desktop metadata such as icon name and localised summary may be stored in
a local sqlite cache, and this module allows applications to query this.
</p>
</div>
<div class="refsect1">
<a name="PkDesktop.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="PK-DESKTOP-DEFAULT-DATABASE:CAPS"></a><h3>PK_DESKTOP_DEFAULT_DATABASE</h3>
<pre class="programlisting">#define PK_DESKTOP_DEFAULT_DATABASE LOCALSTATEDIR "/lib/PackageKit/desktop-files.db"
</pre>
<p>
The default location for the database
</p>
</div>
<hr>
<div class="refsect2">
<a name="PK-DESKTOP-DEFAULT-APPLICATION-DIR:CAPS"></a><h3>PK_DESKTOP_DEFAULT_APPLICATION_DIR</h3>
<pre class="programlisting">#define PK_DESKTOP_DEFAULT_APPLICATION_DIR "/usr/share/applications"
</pre>
<p>
The default location for the desktop files
</p>
</div>
<hr>
<div class="refsect2">
<a name="PkDesktop-struct"></a><h3>struct PkDesktop</h3>
<pre class="programlisting">struct PkDesktop;</pre>
</div>
<hr>
<div class="refsect2">
<a name="PkDesktopClass"></a><h3>struct PkDesktopClass</h3>
<pre class="programlisting">struct PkDesktopClass {
GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="pk-desktop-new"></a><h3>pk_desktop_new ()</h3>
<pre class="programlisting"><a class="link" href="PkDesktop.html" title="PkDesktop"><span class="returnvalue">PkDesktop</span></a> * pk_desktop_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p class="since">Since 0.5.3</p>
</div>
<hr>
<div class="refsect2">
<a name="pk-desktop-test"></a><h3>pk_desktop_test ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> pk_desktop_test (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="pk-desktop-open-database"></a><h3>pk_desktop_open_database ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> pk_desktop_open_database (<em class="parameter"><code><a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>desktop</code></em> :</span></p></td>
<td>a valid <a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if opened correctly</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.3</p>
</div>
<hr>
<div class="refsect2">
<a name="pk-desktop-get-files-for-package"></a><h3>pk_desktop_get_files_for_package ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * pk_desktop_get_files_for_package (<em class="parameter"><code><a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *package</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Return all desktop files owned by a package, regardless if they are shown
in the main menu or not.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>desktop</code></em> :</span></p></td>
<td>a valid <a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>package</code></em> :</span></p></td>
<td>the package name, e.g. "gnome-power-manager"</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><code class="literal">GError</code></a> to put the error code and message in, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>string array of results, free with <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-unref"><code class="function">g_ptr_array_unref()</code></a>. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.3</p>
</div>
<hr>
<div class="refsect2">
<a name="pk-desktop-get-shown-for-package"></a><h3>pk_desktop_get_shown_for_package ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * pk_desktop_get_shown_for_package (<em class="parameter"><code><a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *package</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Return all desktop files owned by a package that would be shown in a menu,
i.e are an application
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>desktop</code></em> :</span></p></td>
<td>a valid <a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>package</code></em> :</span></p></td>
<td>the package name, e.g. "gnome-power-manager"</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><code class="literal">GError</code></a> to put the error code and message in, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>string array of results, free with <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-unref"><code class="function">g_ptr_array_unref()</code></a>. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.3</p>
</div>
<hr>
<div class="refsect2">
<a name="pk-desktop-get-package-for-file"></a><h3>pk_desktop_get_package_for_file ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * pk_desktop_get_package_for_file (<em class="parameter"><code><a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Returns the package name that owns the desktop file. Fast.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>desktop</code></em> :</span></p></td>
<td>a valid <a class="link" href="PkDesktop.html" title="PkDesktop"><span class="type">PkDesktop</span></a> instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a fully qualified filename</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><code class="literal">GError</code></a> to put the error code and message in, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>package name, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.5.3</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|