← Back to branch summary

~ubuntu-branches/debian/squeeze/glib2.0/squeeze

« back to all changes in this revision

Viewing changes to docs/reference/gio/xml/gdesktopappinfo.xml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/xml/gdesktopappinfo.xml
5
5
]>
6
6
<refentry id="gio-Desktop-file-based-GAppInfo">
7
7
<refmeta>
8
 
<refentrytitle role="top_of_page">Desktop file based GAppInfo</refentrytitle>
 
8
<refentrytitle role="top_of_page" id="gio-Desktop-file-based-GAppInfo.top_of_page">Desktop file based GAppInfo</refentrytitle>
9
9
<manvolnum>3</manvolnum>
10
10
<refmiscinfo>GIO Library</refmiscinfo>
11
11
</refmeta>
13
13
<refnamediv>
14
14
<refname>Desktop file based GAppInfo</refname>
15
15
<refpurpose>Application information from desktop files</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
 
<refsynopsisdiv role="synopsis">
 
18
<refsynopsisdiv id="gio-Desktop-file-based-GAppInfo.synopsis" role="synopsis">
20
19
<title role="synopsis.title">Synopsis</title>
21
 
<anchor id="GDesktopAppInfo"/>
 
20
<anchor id="GDesktopAppInfo"/><anchor id="GDesktopAppInfoLookup"/>
22
21
<synopsis>
23
22
 
24
23
#include &lt;gio/gdesktopappinfo.h&gt;
25
24
 
26
 
 
27
25
                    <link linkend="GDesktopAppInfo-struct">GDesktopAppInfo</link>;
28
 
<link linkend="GDesktopAppInfo">GDesktopAppInfo</link>*    <link linkend="g-desktop-app-info-new-from-filename">g_desktop_app_info_new_from_filename</link>
 
26
<link linkend="GDesktopAppInfo">GDesktopAppInfo</link> *   <link linkend="g-desktop-app-info-new-from-filename">g_desktop_app_info_new_from_filename</link>
29
27
                                                        (const <link linkend="char">char</link> *filename);
30
 
<link linkend="GDesktopAppInfo">GDesktopAppInfo</link>*    <link linkend="g-desktop-app-info-new">g_desktop_app_info_new</link>              (const <link linkend="char">char</link> *desktop_id);
 
28
<link linkend="GDesktopAppInfo">GDesktopAppInfo</link> *   <link linkend="g-desktop-app-info-new-from-keyfile">g_desktop_app_info_new_from_keyfile</link> (<link linkend="GKeyFile">GKeyFile</link> *key_file);
 
29
<link linkend="GDesktopAppInfo">GDesktopAppInfo</link> *   <link linkend="g-desktop-app-info-new">g_desktop_app_info_new</link>              (const <link linkend="char">char</link> *desktop_id);
31
30
<link linkend="gboolean">gboolean</link>            <link linkend="g-desktop-app-info-get-is-hidden">g_desktop_app_info_get_is_hidden</link>    (<link linkend="GDesktopAppInfo">GDesktopAppInfo</link> *info);
32
31
<link linkend="void">void</link>                <link linkend="g-desktop-app-info-set-desktop-env">g_desktop_app_info_set_desktop_env</link>  (const <link linkend="char">char</link> *desktop_env);
33
 
                    <link linkend="GDesktopAppInfoLookup">GDesktopAppInfoLookup</link>;
34
 
#define             <link linkend="G-DESKTOP-APP-INFO-LOOKUP-EXTENSION-POINT-NAME:CAPS">G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME</link>
35
 
<link linkend="GAppInfo">GAppInfo</link>*           <link linkend="g-desktop-app-info-lookup-get-default-for-uri-scheme">g_desktop_app_info_lookup_get_default_for_uri_scheme</link>
 
32
                    <link linkend="GDesktopAppInfoLookup-struct">GDesktopAppInfoLookup</link>;
 
33
#define             <link linkend="G-DESKTOP-APP-INFO-LOOKUP-EXTENSION-POINT-NAME--CAPS">G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME</link>
 
34
<link linkend="GAppInfo">GAppInfo</link> *          <link linkend="g-desktop-app-info-lookup-get-default-for-uri-scheme">g_desktop_app_info_lookup_get_default_for_uri_scheme</link>
36
35
                                                        (<link linkend="GDesktopAppInfoLookup">GDesktopAppInfoLookup</link> *lookup,
37
36
                                                         const <link linkend="char">char</link> *uri_scheme);
38
 
 
39
 
 
40
37
</synopsis>
41
38
</refsynopsisdiv>
42
39
 
43
 
<refsect1 role="object_hierarchy">
 
40
<refsect1 id="gio-Desktop-file-based-GAppInfo.object-hierarchy" role="object_hierarchy">
44
41
<title role="object_hierarchy.title">Object Hierarchy</title>
45
42
<synopsis>
46
 
 
47
43
  <link linkend="GObject">GObject</link>
48
44
   +----GDesktopAppInfo
49
45
</synopsis>
50
 
 
51
 
</refsect1>
52
 
 
53
 
 
54
 
 
55
 
<refsect1 role="impl_interfaces">
 
46
<synopsis>
 
47
  <link linkend="GInterface">GInterface</link>
 
48
   +----GDesktopAppInfoLookup
 
49
</synopsis>
 
50
</refsect1>
 
51
 
 
52
<refsect1 id="gio-Desktop-file-based-GAppInfo.prerequisites" role="prerequisites">
 
53
<title role="prerequisites.title">Prerequisites</title>
 
54
<para>
 
55
GDesktopAppInfoLookup requires
 
56
 <link linkend="GObject">GObject</link>.</para>
 
57
</refsect1>
 
58
 
 
59
 
 
60
<refsect1 id="gio-Desktop-file-based-GAppInfo.implemented-interfaces" role="impl_interfaces">
56
61
<title role="impl_interfaces.title">Implemented Interfaces</title>
57
62
<para>
58
63
GDesktopAppInfo implements
59
64
 <link linkend="GAppInfo">GAppInfo</link>.</para>
60
 
 
61
65
</refsect1>
62
66
 
63
67
 
64
68
 
65
69
 
66
70
 
67
 
<refsect1 role="desc">
 
71
<refsect1 id="gio-Desktop-file-based-GAppInfo.description" role="desc">
68
72
<title role="desc.title">Description</title>
69
73
<para>
70
74
<link linkend="GDesktopAppInfo"><type>GDesktopAppInfo</type></link> is an implementation of <link linkend="GAppInfo"><type>GAppInfo</type></link> based on
71
75
desktop files.</para>
72
76
<para>
73
 
 
74
77
</para>
75
78
</refsect1>
76
79
 
77
 
<refsect1 role="details">
 
80
<refsect1 id="gio-Desktop-file-based-GAppInfo.details" role="details">
78
81
<title role="details.title">Details</title>
79
 
<refsect2>
80
 
<title><anchor id="GDesktopAppInfo-struct" role="struct"/>GDesktopAppInfo</title>
81
 
<indexterm><primary>GDesktopAppInfo</primary></indexterm><programlisting>typedef struct _GDesktopAppInfo GDesktopAppInfo;</programlisting>
 
82
<refsect2 id="GDesktopAppInfo-struct" role="struct">
 
83
<title>GDesktopAppInfo</title>
 
84
<indexterm zone="GDesktopAppInfo-struct"><primary sortas="GDesktopAppInfo">GDesktopAppInfo</primary></indexterm><programlisting>typedef struct _GDesktopAppInfo GDesktopAppInfo;</programlisting>
82
85
<para>
83
86
Information about an installed application from a desktop file.</para>
84
87
<para>
85
 
 
86
88
</para></refsect2>
87
 
<refsect2>
88
 
<title><anchor id="g-desktop-app-info-new-from-filename" role="function"/>g_desktop_app_info_new_from_filename ()</title>
89
 
<indexterm><primary>g_desktop_app_info_new_from_filename</primary></indexterm><programlisting><link linkend="GDesktopAppInfo">GDesktopAppInfo</link>*    g_desktop_app_info_new_from_filename
 
89
<refsect2 id="g-desktop-app-info-new-from-filename" role="function">
 
90
<title>g_desktop_app_info_new_from_filename ()</title>
 
91
<indexterm zone="g-desktop-app-info-new-from-filename"><primary sortas="g_desktop_app_info_new_from_filename">g_desktop_app_info_new_from_filename</primary></indexterm><programlisting><link linkend="GDesktopAppInfo">GDesktopAppInfo</link> *   g_desktop_app_info_new_from_filename
90
92
                                                        (const <link linkend="char">char</link> *filename);</programlisting>
91
93
<para>
92
94
Creates a new <link linkend="GDesktopAppInfo"><type>GDesktopAppInfo</type></link>.</para>
93
95
<para>
94
 
 
95
96
</para><variablelist role="params">
96
 
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
97
 
<listitem><simpara> a string containing a file name.
 
97
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
 
98
<listitem><simpara> the path of a desktop file, in the GLib filename encoding
98
99
</simpara></listitem></varlistentry>
99
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GDesktopAppInfo"><type>GDesktopAppInfo</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on error.
 
100
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GDesktopAppInfo"><type>GDesktopAppInfo</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link> on error.
100
101
</simpara></listitem></varlistentry>
101
102
</variablelist></refsect2>
102
 
<refsect2>
103
 
<title><anchor id="g-desktop-app-info-new" role="function"/>g_desktop_app_info_new ()</title>
104
 
<indexterm><primary>g_desktop_app_info_new</primary></indexterm><programlisting><link linkend="GDesktopAppInfo">GDesktopAppInfo</link>*    g_desktop_app_info_new              (const <link linkend="char">char</link> *desktop_id);</programlisting>
 
103
<refsect2 id="g-desktop-app-info-new-from-keyfile" role="function" condition="since:2.18">
 
104
<title>g_desktop_app_info_new_from_keyfile ()</title>
 
105
<indexterm zone="g-desktop-app-info-new-from-keyfile" role="2.18"><primary sortas="g_desktop_app_info_new_from_keyfile">g_desktop_app_info_new_from_keyfile</primary></indexterm><programlisting><link linkend="GDesktopAppInfo">GDesktopAppInfo</link> *   g_desktop_app_info_new_from_keyfile (<link linkend="GKeyFile">GKeyFile</link> *key_file);</programlisting>
105
106
<para>
106
107
Creates a new <link linkend="GDesktopAppInfo"><type>GDesktopAppInfo</type></link>.</para>
107
108
<para>
 
109
</para><variablelist role="params">
 
110
<varlistentry><term><parameter>key_file</parameter>&#160;:</term>
 
111
<listitem><simpara> an opened <link linkend="GKeyFile"><type>GKeyFile</type></link>
 
112
</simpara></listitem></varlistentry>
 
113
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GDesktopAppInfo"><type>GDesktopAppInfo</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link> on error.
108
114
 
 
115
</simpara></listitem></varlistentry>
 
116
</variablelist><para role="since">Since 2.18</para></refsect2>
 
117
<refsect2 id="g-desktop-app-info-new" role="function">
 
118
<title>g_desktop_app_info_new ()</title>
 
119
<indexterm zone="g-desktop-app-info-new"><primary sortas="g_desktop_app_info_new">g_desktop_app_info_new</primary></indexterm><programlisting><link linkend="GDesktopAppInfo">GDesktopAppInfo</link> *   g_desktop_app_info_new              (const <link linkend="char">char</link> *desktop_id);</programlisting>
 
120
<para>
 
121
Creates a new <link linkend="GDesktopAppInfo"><type>GDesktopAppInfo</type></link>.</para>
 
122
<para>
109
123
</para><variablelist role="params">
110
 
<varlistentry><term><parameter>desktop_id</parameter>&nbsp;:</term>
 
124
<varlistentry><term><parameter>desktop_id</parameter>&#160;:</term>
111
125
<listitem><simpara> the desktop file id
112
126
</simpara></listitem></varlistentry>
113
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GDesktopAppInfo"><type>GDesktopAppInfo</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no desktop file with that id
 
127
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GDesktopAppInfo"><type>GDesktopAppInfo</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no desktop file with that id
114
128
</simpara></listitem></varlistentry>
115
129
</variablelist></refsect2>
116
 
<refsect2>
117
 
<title><anchor id="g-desktop-app-info-get-is-hidden" role="function"/>g_desktop_app_info_get_is_hidden ()</title>
118
 
<indexterm><primary>g_desktop_app_info_get_is_hidden</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_desktop_app_info_get_is_hidden    (<link linkend="GDesktopAppInfo">GDesktopAppInfo</link> *info);</programlisting>
 
130
<refsect2 id="g-desktop-app-info-get-is-hidden" role="function">
 
131
<title>g_desktop_app_info_get_is_hidden ()</title>
 
132
<indexterm zone="g-desktop-app-info-get-is-hidden"><primary sortas="g_desktop_app_info_get_is_hidden">g_desktop_app_info_get_is_hidden</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_desktop_app_info_get_is_hidden    (<link linkend="GDesktopAppInfo">GDesktopAppInfo</link> *info);</programlisting>
119
133
<para>
120
134
A desktop file is hidden if the Hidden key in it is
121
135
set to True.</para>
122
136
<para>
123
 
 
124
137
</para><variablelist role="params">
125
 
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
138
<varlistentry><term><parameter>info</parameter>&#160;:</term>
126
139
<listitem><simpara> a <link linkend="GDesktopAppInfo"><type>GDesktopAppInfo</type></link>.
127
140
</simpara></listitem></varlistentry>
128
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if hidden, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise. 
 
141
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if hidden, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise. 
129
142
</simpara></listitem></varlistentry>
130
143
</variablelist></refsect2>
131
 
<refsect2>
132
 
<title><anchor id="g-desktop-app-info-set-desktop-env" role="function"/>g_desktop_app_info_set_desktop_env ()</title>
133
 
<indexterm><primary>g_desktop_app_info_set_desktop_env</primary></indexterm><programlisting><link linkend="void">void</link>                g_desktop_app_info_set_desktop_env  (const <link linkend="char">char</link> *desktop_env);</programlisting>
 
144
<refsect2 id="g-desktop-app-info-set-desktop-env" role="function">
 
145
<title>g_desktop_app_info_set_desktop_env ()</title>
 
146
<indexterm zone="g-desktop-app-info-set-desktop-env"><primary sortas="g_desktop_app_info_set_desktop_env">g_desktop_app_info_set_desktop_env</primary></indexterm><programlisting><link linkend="void">void</link>                g_desktop_app_info_set_desktop_env  (const <link linkend="char">char</link> *desktop_env);</programlisting>
134
147
<para>
135
148
Sets the name of the desktop that the application is running in.
136
149
This is used by <link linkend="g-app-info-should-show"><function>g_app_info_should_show()</function></link> to evaluate the
151
164
<para>
152
165
Should be called only once; subsequent calls are ignored.</para>
153
166
<para>
154
 
 
155
167
</para><variablelist role="params">
156
 
<varlistentry><term><parameter>desktop_env</parameter>&nbsp;:</term>
 
168
<varlistentry><term><parameter>desktop_env</parameter>&#160;:</term>
157
169
<listitem><simpara> a string specifying what desktop this is
158
170
</simpara></listitem></varlistentry>
159
171
</variablelist></refsect2>
160
 
<refsect2>
161
 
<title><anchor id="GDesktopAppInfoLookup" role="struct"/>GDesktopAppInfoLookup</title>
162
 
<indexterm><primary>GDesktopAppInfoLookup</primary></indexterm><programlisting>typedef struct _GDesktopAppInfoLookup GDesktopAppInfoLookup;</programlisting>
 
172
<refsect2 id="GDesktopAppInfoLookup-struct" role="struct">
 
173
<title>GDesktopAppInfoLookup</title>
 
174
<indexterm zone="GDesktopAppInfoLookup-struct"><primary sortas="GDesktopAppInfoLookup">GDesktopAppInfoLookup</primary></indexterm><programlisting>typedef struct _GDesktopAppInfoLookup GDesktopAppInfoLookup;</programlisting>
163
175
<para>
164
 
Interface that is used by backends to associate default 
 
176
Interface that is used by backends to associate default
165
177
handlers with URI schemes.</para>
166
178
<para>
167
 
 
168
179
</para></refsect2>
169
 
<refsect2>
170
 
<title><anchor id="G-DESKTOP-APP-INFO-LOOKUP-EXTENSION-POINT-NAME:CAPS" role="macro"/>G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME</title>
171
 
<indexterm><primary>G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME</primary></indexterm><programlisting>#define G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME "gio-desktop-app-info-lookup"
 
180
<refsect2 id="G-DESKTOP-APP-INFO-LOOKUP-EXTENSION-POINT-NAME--CAPS" role="macro">
 
181
<title>G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME</title>
 
182
<indexterm zone="G-DESKTOP-APP-INFO-LOOKUP-EXTENSION-POINT-NAME--CAPS"><primary sortas="G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME">G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME</primary></indexterm><programlisting>#define G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME "gio-desktop-app-info-lookup"
172
183
</programlisting>
173
184
<para>
174
185
Extension point for default handler to URI association. See
175
 
<link linkend="gio-extension-points">Extending GIO</link>.</para>
 
186
<link linkend="extending-gio">Extending GIO</link>.</para>
176
187
<para>
177
 
 
178
188
</para></refsect2>
179
 
<refsect2>
180
 
<title><anchor id="g-desktop-app-info-lookup-get-default-for-uri-scheme" role="function"/>g_desktop_app_info_lookup_get_default_for_uri_scheme ()</title>
181
 
<indexterm><primary>g_desktop_app_info_lookup_get_default_for_uri_scheme</primary></indexterm><programlisting><link linkend="GAppInfo">GAppInfo</link>*           g_desktop_app_info_lookup_get_default_for_uri_scheme
 
189
<refsect2 id="g-desktop-app-info-lookup-get-default-for-uri-scheme" role="function">
 
190
<title>g_desktop_app_info_lookup_get_default_for_uri_scheme ()</title>
 
191
<indexterm zone="g-desktop-app-info-lookup-get-default-for-uri-scheme"><primary sortas="g_desktop_app_info_lookup_get_default_for_uri_scheme">g_desktop_app_info_lookup_get_default_for_uri_scheme</primary></indexterm><programlisting><link linkend="GAppInfo">GAppInfo</link> *          g_desktop_app_info_lookup_get_default_for_uri_scheme
182
192
                                                        (<link linkend="GDesktopAppInfoLookup">GDesktopAppInfoLookup</link> *lookup,
183
193
                                                         const <link linkend="char">char</link> *uri_scheme);</programlisting>
184
194
<para>
192
202
in a GIO module. There is no reason for applications to use it
193
203
directly. Applications should use <link linkend="g-app-info-get-default-for-uri-scheme"><function>g_app_info_get_default_for_uri_scheme()</function></link>.</para>
194
204
<para>
195
 
 
196
205
</para><variablelist role="params">
197
 
<varlistentry><term><parameter>lookup</parameter>&nbsp;:</term>
 
206
<varlistentry><term><parameter>lookup</parameter>&#160;:</term>
198
207
<listitem><simpara> a <link linkend="GDesktopAppInfoLookup"><type>GDesktopAppInfoLookup</type></link>
199
208
</simpara></listitem></varlistentry>
200
 
<varlistentry><term><parameter>uri_scheme</parameter>&nbsp;:</term>
 
209
<varlistentry><term><parameter>uri_scheme</parameter>&#160;:</term>
201
210
<listitem><simpara> a string containing a URI scheme.
202
211
</simpara></listitem></varlistentry>
203
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="GAppInfo"><type>GAppInfo</type></link> for given <parameter>uri_scheme</parameter> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on error.
 
212
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="GAppInfo"><type>GAppInfo</type></link> for given <parameter>uri_scheme</parameter> or <link linkend="NULL--CAPS"><literal>NULL</literal></link> on error.
204
213
</simpara></listitem></varlistentry>
205
214
</variablelist></refsect2>
206
215
 
209
218
 
210
219
 
211
220
 
212
 
 
213
 
<refsect1><refsect2 /><refsect2 /></refsect1>
214
221
</refentry>