1/* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2006-2007 Red Hat, Inc.
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 *
18 * Author: Alexander Larsson <alexl@redhat.com>
19 */
20
21#ifndef __G_APP_INFO_H__
22#define __G_APP_INFO_H__
23
24#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25#error "Only <gio/gio.h> can be included directly."
26#endif
27
28#include <gio/giotypes.h>
29
30G_BEGIN_DECLS
31
32#define G_TYPE_APP_INFO (g_app_info_get_type ())
33#define G_APP_INFO(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_APP_INFO, GAppInfo))
34#define G_IS_APP_INFO(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_APP_INFO))
35#define G_APP_INFO_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_APP_INFO, GAppInfoIface))
36
37#define G_TYPE_APP_LAUNCH_CONTEXT (g_app_launch_context_get_type ())
38#define G_APP_LAUNCH_CONTEXT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContext))
39#define G_APP_LAUNCH_CONTEXT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
40#define G_IS_APP_LAUNCH_CONTEXT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_APP_LAUNCH_CONTEXT))
41#define G_IS_APP_LAUNCH_CONTEXT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_APP_LAUNCH_CONTEXT))
42#define G_APP_LAUNCH_CONTEXT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
43
44typedef struct _GAppLaunchContextClass GAppLaunchContextClass;
45typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
46
47/**
48 * GAppInfo:
49 *
50 * Information about an installed application and methods to launch
51 * it (with file arguments).
52 */
53
54/**
55 * GAppInfoIface:
56 * @g_iface: The parent interface.
57 * @dup: Copies a #GAppInfo.
58 * @equal: Checks two #GAppInfos for equality.
59 * @get_id: Gets a string identifier for a #GAppInfo.
60 * @get_name: Gets the name of the application for a #GAppInfo.
61 * @get_description: Gets a short description for the application described by the #GAppInfo.
62 * @get_executable: Gets the executable name for the #GAppInfo.
63 * @get_icon: Gets the #GIcon for the #GAppInfo.
64 * @launch: Launches an application specified by the #GAppInfo.
65 * @supports_uris: Indicates whether the application specified supports launching URIs.
66 * @supports_files: Indicates whether the application specified accepts filename arguments.
67 * @launch_uris: Launches an application with a list of URIs.
68 * @should_show: Returns whether an application should be shown (e.g. when getting a list of installed applications).
69 * [FreeDesktop.Org Startup Notification Specification](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt).
70 * @set_as_default_for_type: Sets an application as default for a given content type.
71 * @set_as_default_for_extension: Sets an application as default for a given file extension.
72 * @add_supports_type: Adds to the #GAppInfo information about supported file types.
73 * @can_remove_supports_type: Checks for support for removing supported file types from a #GAppInfo.
74 * @remove_supports_type: Removes a supported application type from a #GAppInfo.
75 * @can_delete: Checks if a #GAppInfo can be deleted. Since 2.20
76 * @do_delete: Deletes a #GAppInfo. Since 2.20
77 * @get_commandline: Gets the commandline for the #GAppInfo. Since 2.20
78 * @get_display_name: Gets the display name for the #GAppInfo. Since 2.24
79 * @set_as_last_used_for_type: Sets the application as the last used. See g_app_info_set_as_last_used_for_type().
80 * @get_supported_types: Retrieves the list of content types that @app_info claims to support.
81 *
82 * Application Information interface, for operating system portability.
83 */
84typedef struct _GAppInfoIface GAppInfoIface;
85
86struct _GAppInfoIface
87{
88 GTypeInterface g_iface;
89
90 /* Virtual Table */
91
92 GAppInfo * (* dup) (GAppInfo *appinfo);
93 gboolean (* equal) (GAppInfo *appinfo1,
94 GAppInfo *appinfo2);
95 const char * (* get_id) (GAppInfo *appinfo);
96 const char * (* get_name) (GAppInfo *appinfo);
97 const char * (* get_description) (GAppInfo *appinfo);
98 const char * (* get_executable) (GAppInfo *appinfo);
99 GIcon * (* get_icon) (GAppInfo *appinfo);
100 gboolean (* launch) (GAppInfo *appinfo,
101 GList *files,
102 GAppLaunchContext *context,
103 GError **error);
104 gboolean (* supports_uris) (GAppInfo *appinfo);
105 gboolean (* supports_files) (GAppInfo *appinfo);
106 gboolean (* launch_uris) (GAppInfo *appinfo,
107 GList *uris,
108 GAppLaunchContext *context,
109 GError **error);
110 gboolean (* should_show) (GAppInfo *appinfo);
111
112 /* For changing associations */
113 gboolean (* set_as_default_for_type) (GAppInfo *appinfo,
114 const char *content_type,
115 GError **error);
116 gboolean (* set_as_default_for_extension) (GAppInfo *appinfo,
117 const char *extension,
118 GError **error);
119 gboolean (* add_supports_type) (GAppInfo *appinfo,
120 const char *content_type,
121 GError **error);
122 gboolean (* can_remove_supports_type) (GAppInfo *appinfo);
123 gboolean (* remove_supports_type) (GAppInfo *appinfo,
124 const char *content_type,
125 GError **error);
126 gboolean (* can_delete) (GAppInfo *appinfo);
127 gboolean (* do_delete) (GAppInfo *appinfo);
128 const char * (* get_commandline) (GAppInfo *appinfo);
129 const char * (* get_display_name) (GAppInfo *appinfo);
130 gboolean (* set_as_last_used_for_type) (GAppInfo *appinfo,
131 const char *content_type,
132 GError **error);
133 const char ** (* get_supported_types) (GAppInfo *appinfo);
134};
135
136GLIB_AVAILABLE_IN_ALL
137GType g_app_info_get_type (void) G_GNUC_CONST;
138GLIB_AVAILABLE_IN_ALL
139GAppInfo * g_app_info_create_from_commandline (const char *commandline,
140 const char *application_name,
141 GAppInfoCreateFlags flags,
142 GError **error);
143GLIB_AVAILABLE_IN_ALL
144GAppInfo * g_app_info_dup (GAppInfo *appinfo);
145GLIB_AVAILABLE_IN_ALL
146gboolean g_app_info_equal (GAppInfo *appinfo1,
147 GAppInfo *appinfo2);
148GLIB_AVAILABLE_IN_ALL
149const char *g_app_info_get_id (GAppInfo *appinfo);
150GLIB_AVAILABLE_IN_ALL
151const char *g_app_info_get_name (GAppInfo *appinfo);
152GLIB_AVAILABLE_IN_ALL
153const char *g_app_info_get_display_name (GAppInfo *appinfo);
154GLIB_AVAILABLE_IN_ALL
155const char *g_app_info_get_description (GAppInfo *appinfo);
156GLIB_AVAILABLE_IN_ALL
157const char *g_app_info_get_executable (GAppInfo *appinfo);
158GLIB_AVAILABLE_IN_ALL
159const char *g_app_info_get_commandline (GAppInfo *appinfo);
160GLIB_AVAILABLE_IN_ALL
161GIcon * g_app_info_get_icon (GAppInfo *appinfo);
162GLIB_AVAILABLE_IN_ALL
163gboolean g_app_info_launch (GAppInfo *appinfo,
164 GList *files,
165 GAppLaunchContext *context,
166 GError **error);
167GLIB_AVAILABLE_IN_ALL
168gboolean g_app_info_supports_uris (GAppInfo *appinfo);
169GLIB_AVAILABLE_IN_ALL
170gboolean g_app_info_supports_files (GAppInfo *appinfo);
171GLIB_AVAILABLE_IN_ALL
172gboolean g_app_info_launch_uris (GAppInfo *appinfo,
173 GList *uris,
174 GAppLaunchContext *context,
175 GError **error);
176GLIB_AVAILABLE_IN_ALL
177gboolean g_app_info_should_show (GAppInfo *appinfo);
178
179GLIB_AVAILABLE_IN_ALL
180gboolean g_app_info_set_as_default_for_type (GAppInfo *appinfo,
181 const char *content_type,
182 GError **error);
183GLIB_AVAILABLE_IN_ALL
184gboolean g_app_info_set_as_default_for_extension (GAppInfo *appinfo,
185 const char *extension,
186 GError **error);
187GLIB_AVAILABLE_IN_ALL
188gboolean g_app_info_add_supports_type (GAppInfo *appinfo,
189 const char *content_type,
190 GError **error);
191GLIB_AVAILABLE_IN_ALL
192gboolean g_app_info_can_remove_supports_type (GAppInfo *appinfo);
193GLIB_AVAILABLE_IN_ALL
194gboolean g_app_info_remove_supports_type (GAppInfo *appinfo,
195 const char *content_type,
196 GError **error);
197GLIB_AVAILABLE_IN_2_34
198const char **g_app_info_get_supported_types (GAppInfo *appinfo);
199
200GLIB_AVAILABLE_IN_ALL
201gboolean g_app_info_can_delete (GAppInfo *appinfo);
202GLIB_AVAILABLE_IN_ALL
203gboolean g_app_info_delete (GAppInfo *appinfo);
204
205GLIB_AVAILABLE_IN_ALL
206gboolean g_app_info_set_as_last_used_for_type (GAppInfo *appinfo,
207 const char *content_type,
208 GError **error);
209
210GLIB_AVAILABLE_IN_ALL
211GList * g_app_info_get_all (void);
212GLIB_AVAILABLE_IN_ALL
213GList * g_app_info_get_all_for_type (const char *content_type);
214GLIB_AVAILABLE_IN_ALL
215GList * g_app_info_get_recommended_for_type (const gchar *content_type);
216GLIB_AVAILABLE_IN_ALL
217GList * g_app_info_get_fallback_for_type (const gchar *content_type);
218
219GLIB_AVAILABLE_IN_ALL
220void g_app_info_reset_type_associations (const char *content_type);
221GLIB_AVAILABLE_IN_ALL
222GAppInfo *g_app_info_get_default_for_type (const char *content_type,
223 gboolean must_support_uris);
224GLIB_AVAILABLE_IN_ALL
225GAppInfo *g_app_info_get_default_for_uri_scheme (const char *uri_scheme);
226
227GLIB_AVAILABLE_IN_ALL
228gboolean g_app_info_launch_default_for_uri (const char *uri,
229 GAppLaunchContext *context,
230 GError **error);
231
232GLIB_AVAILABLE_IN_2_50
233void g_app_info_launch_default_for_uri_async (const char *uri,
234 GAppLaunchContext *context,
235 GCancellable *cancellable,
236 GAsyncReadyCallback callback,
237 gpointer user_data);
238GLIB_AVAILABLE_IN_2_50
239gboolean g_app_info_launch_default_for_uri_finish (GAsyncResult *result,
240 GError **error);
241
242
243/**
244 * GAppLaunchContext:
245 *
246 * Integrating the launch with the launching application. This is used to
247 * handle for instance startup notification and launching the new application
248 * on the same screen as the launching window.
249 */
250struct _GAppLaunchContext
251{
252 GObject parent_instance;
253
254 /*< private >*/
255 GAppLaunchContextPrivate *priv;
256};
257
258struct _GAppLaunchContextClass
259{
260 GObjectClass parent_class;
261
262 char * (* get_display) (GAppLaunchContext *context,
263 GAppInfo *info,
264 GList *files);
265 char * (* get_startup_notify_id) (GAppLaunchContext *context,
266 GAppInfo *info,
267 GList *files);
268 void (* launch_failed) (GAppLaunchContext *context,
269 const char *startup_notify_id);
270 void (* launched) (GAppLaunchContext *context,
271 GAppInfo *info,
272 GVariant *platform_data);
273
274 /* Padding for future expansion */
275 void (*_g_reserved1) (void);
276 void (*_g_reserved2) (void);
277 void (*_g_reserved3) (void);
278 void (*_g_reserved4) (void);
279};
280
281GLIB_AVAILABLE_IN_ALL
282GType g_app_launch_context_get_type (void) G_GNUC_CONST;
283GLIB_AVAILABLE_IN_ALL
284GAppLaunchContext *g_app_launch_context_new (void);
285
286GLIB_AVAILABLE_IN_2_32
287void g_app_launch_context_setenv (GAppLaunchContext *context,
288 const char *variable,
289 const char *value);
290GLIB_AVAILABLE_IN_2_32
291void g_app_launch_context_unsetenv (GAppLaunchContext *context,
292 const char *variable);
293GLIB_AVAILABLE_IN_2_32
294char ** g_app_launch_context_get_environment (GAppLaunchContext *context);
295
296GLIB_AVAILABLE_IN_ALL
297char * g_app_launch_context_get_display (GAppLaunchContext *context,
298 GAppInfo *info,
299 GList *files);
300GLIB_AVAILABLE_IN_ALL
301char * g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
302 GAppInfo *info,
303 GList *files);
304GLIB_AVAILABLE_IN_ALL
305void g_app_launch_context_launch_failed (GAppLaunchContext *context,
306 const char * startup_notify_id);
307
308#define G_TYPE_APP_INFO_MONITOR (g_app_info_monitor_get_type ())
309#define G_APP_INFO_MONITOR(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
310 G_TYPE_APP_INFO_MONITOR, GAppInfoMonitor))
311#define G_IS_APP_INFO_MONITOR(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
312 G_TYPE_APP_INFO_MONITOR))
313
314typedef struct _GAppInfoMonitor GAppInfoMonitor;
315
316GLIB_AVAILABLE_IN_2_40
317GType g_app_info_monitor_get_type (void);
318
319GLIB_AVAILABLE_IN_2_40
320GAppInfoMonitor * g_app_info_monitor_get (void);
321
322G_END_DECLS
323
324#endif /* __G_APP_INFO_H__ */
325