← Back to branch summary

~ubuntu-branches/ubuntu/maverick/packagekit/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/api/html/PackageKit-pk-desktop.html

  • Committer: Bazaar Package Importer
  • Author(s): Felix Geyer
  • Date: 2010-08-08 12:46:44 UTC
  • mfrom: (1.1.15 upstream)
  • Revision ID: james.westby@ubuntu.com-20100808124644-1di0ycit6mbt24d8
Tags: 0.6.7-0ubuntu1
https://launchpad.net/bugs/613412
https://launchpad.net/bugs/614168
* New upstream release.
* Drop 20packagekit_error.diff, applied upstream.
* Make packagekit depend on packagekit-backend-aptcc without alternative
  dependencies as the default config requires it. (LP: #613412)
  - Move the apt and smart backends to Suggests.
* Add python and python-packagekit to the packagekit-backend-aptcc
  dependencies as get-distro-upgrade.py requires them. (LP: #614168)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/api/html/PackageKit-pk-desktop.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>PkDesktop</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="PackageKit Reference Manual">
 
8
<link rel="up" href="libpackagekit-gobject.html" title="libpackagekit GObjects">
 
9
<link rel="prev" href="PackageKit-pk-control.html" title="PkControl">
 
10
<link rel="next" href="PackageKit-pk-details.html" title="PkDetails">
 
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="PackageKit-pk-control.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="libpackagekit-gobject.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">PackageKit Reference Manual</th>
 
21
<td><a accesskey="n" href="PackageKit-pk-details.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#PackageKit-pk-desktop.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#PackageKit-pk-desktop.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#PackageKit-pk-desktop.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
</td></tr>
 
30
</table>
 
31
<div class="refentry" title="PkDesktop">
 
32
<a name="PackageKit-pk-desktop"></a><div class="titlepage"></div>
 
33
<div class="refnamediv"><table width="100%"><tr>
 
34
<td valign="top">
 
35
<h2><span class="refentrytitle"><a name="PackageKit-pk-desktop.top_of_page"></a>PkDesktop</span></h2>
 
36
<p>PkDesktop — Find desktop metadata about a package</p>
 
37
</td>
 
38
<td valign="top" align="right"></td>
 
39
</tr></table></div>
 
40
<div class="refsynopsisdiv" title="Synopsis">
 
41
<a name="PackageKit-pk-desktop.synopsis"></a><h2>Synopsis</h2>
 
42
<a name="PkDesktop"></a><pre class="synopsis">#define             <a class="link" href="PackageKit-pk-desktop.html#PK-DESKTOP-DEFAULT-DATABASE:CAPS" title="PK_DESKTOP_DEFAULT_DATABASE">PK_DESKTOP_DEFAULT_DATABASE</a>
 
43
#define             <a class="link" href="PackageKit-pk-desktop.html#PK-DESKTOP-DEFAULT-APPLICATION-DIR:CAPS" title="PK_DESKTOP_DEFAULT_APPLICATION_DIR">PK_DESKTOP_DEFAULT_APPLICATION_DIR</a>
 
44
                    <a class="link" href="PackageKit-pk-desktop.html#PkDesktopPrivate" title="PkDesktopPrivate">PkDesktopPrivate</a>;
 
45
                    <a class="link" href="PackageKit-pk-desktop.html#PkDesktop-struct" title="PkDesktop">PkDesktop</a>;
 
46
<a class="link" href="PackageKit-pk-desktop.html#PkDesktop"><span class="returnvalue">PkDesktop</span></a> *         <a class="link" href="PackageKit-pk-desktop.html#pk-desktop-new" title="pk_desktop_new ()">pk_desktop_new</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
 
47
<span class="returnvalue">void</span>                <a class="link" href="PackageKit-pk-desktop.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>);
 
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="PackageKit-pk-desktop.html#pk-desktop-open-database" title="pk_desktop_open_database ()">pk_desktop_open_database</a>            (<em class="parameter"><code><a class="link" href="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
 
49
                                                         <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>);
 
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *         <a class="link" href="PackageKit-pk-desktop.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="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
 
51
                                                         <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>,
 
52
                                                         <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>);
 
53
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *         <a class="link" href="PackageKit-pk-desktop.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="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
 
54
                                                         <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>,
 
55
                                                         <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>);
 
56
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="PackageKit-pk-desktop.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="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
 
57
                                                         <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>,
 
58
                                                         <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>);
 
59
</pre>
 
60
</div>
 
61
<div class="refsect1" title="Object Hierarchy">
 
62
<a name="PackageKit-pk-desktop.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
63
<pre class="synopsis">
 
64
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
65
   +----PkDesktop
 
66
</pre>
 
67
</div>
 
68
<div class="refsect1" title="Description">
 
69
<a name="PackageKit-pk-desktop.description"></a><h2>Description</h2>
 
70
<p>
 
71
Desktop metadata such as icon name and localised summary may be stored in
 
72
a local sqlite cache, and this module allows applications to query this.
 
73
</p>
 
74
</div>
 
75
<div class="refsect1" title="Details">
 
76
<a name="PackageKit-pk-desktop.details"></a><h2>Details</h2>
 
77
<div class="refsect2" title="PK_DESKTOP_DEFAULT_DATABASE">
 
78
<a name="PK-DESKTOP-DEFAULT-DATABASE:CAPS"></a><h3>PK_DESKTOP_DEFAULT_DATABASE</h3>
 
79
<pre class="programlisting">#define PK_DESKTOP_DEFAULT_DATABASE         LOCALSTATEDIR "/lib/PackageKit/desktop-files.db"
 
80
</pre>
 
81
<p>
 
82
The default location for the database
 
83
</p>
 
84
</div>
 
85
<hr>
 
86
<div class="refsect2" title="PK_DESKTOP_DEFAULT_APPLICATION_DIR">
 
87
<a name="PK-DESKTOP-DEFAULT-APPLICATION-DIR:CAPS"></a><h3>PK_DESKTOP_DEFAULT_APPLICATION_DIR</h3>
 
88
<pre class="programlisting">#define             PK_DESKTOP_DEFAULT_APPLICATION_DIR</pre>
 
89
<p>
 
90
The default location for the desktop files
 
91
</p>
 
92
</div>
 
93
<hr>
 
94
<div class="refsect2" title="PkDesktopPrivate">
 
95
<a name="PkDesktopPrivate"></a><h3>PkDesktopPrivate</h3>
 
96
<pre class="programlisting">typedef struct _PkDesktopPrivate PkDesktopPrivate;</pre>
 
97
<p>
 
98
Private <a class="link" href="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> data
 
99
</p>
 
100
</div>
 
101
<hr>
 
102
<div class="refsect2" title="PkDesktop">
 
103
<a name="PkDesktop-struct"></a><h3>PkDesktop</h3>
 
104
<pre class="programlisting">typedef struct _PkDesktop PkDesktop;</pre>
 
105
<p>
 
106
</p>
 
107
</div>
 
108
<hr>
 
109
<div class="refsect2" title="pk_desktop_new ()">
 
110
<a name="pk-desktop-new"></a><h3>pk_desktop_new ()</h3>
 
111
<pre class="programlisting"><a class="link" href="PackageKit-pk-desktop.html#PkDesktop"><span class="returnvalue">PkDesktop</span></a> *         pk_desktop_new                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
112
<div class="variablelist"><table border="0">
 
113
<col align="left" valign="top">
 
114
<tbody><tr>
 
115
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
116
<td>
 
117
</td>
 
118
</tr></tbody>
 
119
</table></div>
 
120
<p class="since">Since 0.5.3</p>
 
121
</div>
 
122
<hr>
 
123
<div class="refsect2" title="pk_desktop_test ()">
 
124
<a name="pk-desktop-test"></a><h3>pk_desktop_test ()</h3>
 
125
<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>
 
126
<p>
 
127
</p>
 
128
<div class="variablelist"><table border="0">
 
129
<col align="left" valign="top">
 
130
<tbody><tr>
 
131
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
132
<td>
 
133
</td>
 
134
</tr></tbody>
 
135
</table></div>
 
136
</div>
 
137
<hr>
 
138
<div class="refsect2" title="pk_desktop_open_database ()">
 
139
<a name="pk-desktop-open-database"></a><h3>pk_desktop_open_database ()</h3>
 
140
<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="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
 
141
                                                         <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>
 
142
<div class="variablelist"><table border="0">
 
143
<col align="left" valign="top">
 
144
<tbody>
 
145
<tr>
 
146
<td><p><span class="term"><em class="parameter"><code>desktop</code></em> :</span></p></td>
 
147
<td>a valid <a class="link" href="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> instance
 
148
</td>
 
149
</tr>
 
150
<tr>
 
151
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
152
<td>
 
153
</td>
 
154
</tr>
 
155
<tr>
 
156
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
157
<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
 
158
 
 
159
</td>
 
160
</tr>
 
161
</tbody>
 
162
</table></div>
 
163
<p class="since">Since 0.5.3</p>
 
164
</div>
 
165
<hr>
 
166
<div class="refsect2" title="pk_desktop_get_files_for_package ()">
 
167
<a name="pk-desktop-get-files-for-package"></a><h3>pk_desktop_get_files_for_package ()</h3>
 
168
<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="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
 
169
                                                         <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>,
 
170
                                                         <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>
 
171
<p>
 
172
Return all desktop files owned by a package, regardless if they are shown
 
173
in the main menu or not.
 
174
</p>
 
175
<div class="variablelist"><table border="0">
 
176
<col align="left" valign="top">
 
177
<tbody>
 
178
<tr>
 
179
<td><p><span class="term"><em class="parameter"><code>desktop</code></em> :</span></p></td>
 
180
<td>a valid <a class="link" href="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> instance
 
181
</td>
 
182
</tr>
 
183
<tr>
 
184
<td><p><span class="term"><em class="parameter"><code>package</code></em> :</span></p></td>
 
185
<td>the package name, e.g. "gnome-power-manager"
 
186
</td>
 
187
</tr>
 
188
<tr>
 
189
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
190
<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="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
191
</td>
 
192
</tr>
 
193
<tr>
 
194
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
195
<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>
 
196
 
 
197
</td>
 
198
</tr>
 
199
</tbody>
 
200
</table></div>
 
201
<p class="since">Since 0.5.3</p>
 
202
</div>
 
203
<hr>
 
204
<div class="refsect2" title="pk_desktop_get_shown_for_package ()">
 
205
<a name="pk-desktop-get-shown-for-package"></a><h3>pk_desktop_get_shown_for_package ()</h3>
 
206
<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="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
 
207
                                                         <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>,
 
208
                                                         <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>
 
209
<p>
 
210
Return all desktop files owned by a package that would be shown in a menu,
 
211
i.e are an application
 
212
</p>
 
213
<div class="variablelist"><table border="0">
 
214
<col align="left" valign="top">
 
215
<tbody>
 
216
<tr>
 
217
<td><p><span class="term"><em class="parameter"><code>desktop</code></em> :</span></p></td>
 
218
<td>a valid <a class="link" href="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> instance
 
219
</td>
 
220
</tr>
 
221
<tr>
 
222
<td><p><span class="term"><em class="parameter"><code>package</code></em> :</span></p></td>
 
223
<td>the package name, e.g. "gnome-power-manager"
 
224
</td>
 
225
</tr>
 
226
<tr>
 
227
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
228
<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="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
229
</td>
 
230
</tr>
 
231
<tr>
 
232
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
233
<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>
 
234
 
 
235
</td>
 
236
</tr>
 
237
</tbody>
 
238
</table></div>
 
239
<p class="since">Since 0.5.3</p>
 
240
</div>
 
241
<hr>
 
242
<div class="refsect2" title="pk_desktop_get_package_for_file ()">
 
243
<a name="pk-desktop-get-package-for-file"></a><h3>pk_desktop_get_package_for_file ()</h3>
 
244
<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="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> *desktop</code></em>,
 
245
                                                         <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>,
 
246
                                                         <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>
 
247
<p>
 
248
Returns the package name that owns the desktop file. Fast.
 
249
</p>
 
250
<div class="variablelist"><table border="0">
 
251
<col align="left" valign="top">
 
252
<tbody>
 
253
<tr>
 
254
<td><p><span class="term"><em class="parameter"><code>desktop</code></em> :</span></p></td>
 
255
<td>a valid <a class="link" href="PackageKit-pk-desktop.html#PkDesktop"><span class="type">PkDesktop</span></a> instance
 
256
</td>
 
257
</tr>
 
258
<tr>
 
259
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
 
260
<td>a fully qualified filename
 
261
</td>
 
262
</tr>
 
263
<tr>
 
264
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
265
<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="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
266
</td>
 
267
</tr>
 
268
<tr>
 
269
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
270
<td> package name, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
271
 
 
272
</td>
 
273
</tr>
 
274
</tbody>
 
275
</table></div>
 
276
<p class="since">Since 0.5.3</p>
 
277
</div>
 
278
</div>
 
279
</div>
 
280
<div class="footer">
 
281
<hr>
 
282
          Generated by GTK-Doc V1.15</div>
 
283
</body>
 
284
</html>
 
 
b'\\ No newline at end of file'