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 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 * <ulink url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
70 * <citetitle>FreeDesktop.Org Startup Notification Specification</citetitle></ulink>.
71 * @set_as_default_for_type: Sets an application as default for a given content type.
72 * @set_as_default_for_extension: Sets an application as default for a given file extension.
73 * @add_supports_type: Adds to the #GAppInfo information about supported file types.
74 * @can_remove_supports_type: Checks for support for removing supported file types from a #GAppInfo.
75 * @remove_supports_type: Removes a supported application type from a #GAppInfo.
76 * @can_delete: Checks if a #GAppInfo can be deleted. Since 2.20
77 * @do_delete: Deletes a #GAppInfo. Since 2.20
78 * @get_commandline: Gets the commandline for the #GAppInfo. Since 2.20
79 * @get_display_name: Gets the display name for the #GAppInfo. Since 2.24
80 * @set_as_last_used_for_type: Sets the application as the last used. See g_app_info_set_as_last_used_for_type().
81 * @get_supported_types: Retrieves the list of content types that @app_info claims to support.
82 *
83 * Application Information interface, for operating system portability.
84 */
85typedef struct _GAppInfoIface GAppInfoIface;
86
87struct _GAppInfoIface
88{
89 GTypeInterface g_iface;
90
91 /* Virtual Table */
92
93 GAppInfo * (* dup) (GAppInfo *appinfo);
94 gboolean (* equal) (GAppInfo *appinfo1,
95 GAppInfo *appinfo2);
96 const char * (* get_id) (GAppInfo *appinfo);
97 const char * (* get_name) (GAppInfo *appinfo);
98 const char * (* get_description) (GAppInfo *appinfo);
99 const char * (* get_executable) (GAppInfo *appinfo);
100 GIcon * (* get_icon) (GAppInfo *appinfo);
101 gboolean (* launch) (GAppInfo *appinfo,
102 GList *files,
103 GAppLaunchContext *launch_context,
104 GError **error);
105 gboolean (* supports_uris) (GAppInfo *appinfo);
106 gboolean (* supports_files) (GAppInfo *appinfo);
107 gboolean (* launch_uris) (GAppInfo *appinfo,
108 GList *uris,
109 GAppLaunchContext *launch_context,
110 GError **error);
111 gboolean (* should_show) (GAppInfo *appinfo);
112
113 /* For changing associations */
114 gboolean (* set_as_default_for_type) (GAppInfo *appinfo,
115 const char *content_type,
116 GError **error);
117 gboolean (* set_as_default_for_extension) (GAppInfo *appinfo,
118 const char *extension,
119 GError **error);
120 gboolean (* add_supports_type) (GAppInfo *appinfo,
121 const char *content_type,
122 GError **error);
123 gboolean (* can_remove_supports_type) (GAppInfo *appinfo);
124 gboolean (* remove_supports_type) (GAppInfo *appinfo,
125 const char *content_type,
126 GError **error);
127 gboolean (* can_delete) (GAppInfo *appinfo);
128 gboolean (* do_delete) (GAppInfo *appinfo);
129 const char * (* get_commandline) (GAppInfo *appinfo);
130 const char * (* get_display_name) (GAppInfo *appinfo);
131 gboolean (* set_as_last_used_for_type) (GAppInfo *appinfo,
132 const char *content_type,
133 GError **error);
134 const char ** (* get_supported_types) (GAppInfo *appinfo);
135};
136
137GLIB_AVAILABLE_IN_ALL
138GType g_app_info_get_type (void) G_GNUC_CONST;
139GLIB_AVAILABLE_IN_ALL
140GAppInfo * g_app_info_create_from_commandline (const char *commandline,
141 const char *application_name,
142 GAppInfoCreateFlags flags,
143 GError **error);
144GLIB_AVAILABLE_IN_ALL
145GAppInfo * g_app_info_dup (GAppInfo *appinfo);
146GLIB_AVAILABLE_IN_ALL
147gboolean g_app_info_equal (GAppInfo *appinfo1,
148 GAppInfo *appinfo2);
149GLIB_AVAILABLE_IN_ALL
150const char *g_app_info_get_id (GAppInfo *appinfo);
151GLIB_AVAILABLE_IN_ALL
152const char *g_app_info_get_name (GAppInfo *appinfo);
153GLIB_AVAILABLE_IN_ALL
154const char *g_app_info_get_display_name (GAppInfo *appinfo);
155GLIB_AVAILABLE_IN_ALL
156const char *g_app_info_get_description (GAppInfo *appinfo);
157GLIB_AVAILABLE_IN_ALL
158const char *g_app_info_get_executable (GAppInfo *appinfo);
159GLIB_AVAILABLE_IN_ALL
160const char *g_app_info_get_commandline (GAppInfo *appinfo);
161GLIB_AVAILABLE_IN_ALL
162GIcon * g_app_info_get_icon (GAppInfo *appinfo);
163GLIB_AVAILABLE_IN_ALL
164gboolean g_app_info_launch (GAppInfo *appinfo,
165 GList *files,
166 GAppLaunchContext *launch_context,
167 GError **error);
168GLIB_AVAILABLE_IN_ALL
169gboolean g_app_info_supports_uris (GAppInfo *appinfo);
170GLIB_AVAILABLE_IN_ALL
171gboolean g_app_info_supports_files (GAppInfo *appinfo);
172GLIB_AVAILABLE_IN_ALL
173gboolean g_app_info_launch_uris (GAppInfo *appinfo,
174 GList *uris,
175 GAppLaunchContext *launch_context,
176 GError **error);
177GLIB_AVAILABLE_IN_ALL
178gboolean g_app_info_should_show (GAppInfo *appinfo);
179
180GLIB_AVAILABLE_IN_ALL
181gboolean g_app_info_set_as_default_for_type (GAppInfo *appinfo,
182 const char *content_type,
183 GError **error);
184GLIB_AVAILABLE_IN_ALL
185gboolean g_app_info_set_as_default_for_extension (GAppInfo *appinfo,
186 const char *extension,
187 GError **error);
188GLIB_AVAILABLE_IN_ALL
189gboolean g_app_info_add_supports_type (GAppInfo *appinfo,
190 const char *content_type,
191 GError **error);
192GLIB_AVAILABLE_IN_ALL
193gboolean g_app_info_can_remove_supports_type (GAppInfo *appinfo);
194GLIB_AVAILABLE_IN_ALL
195gboolean g_app_info_remove_supports_type (GAppInfo *appinfo,
196 const char *content_type,
197 GError **error);
198GLIB_AVAILABLE_IN_2_34
199const char **g_app_info_get_supported_types (GAppInfo *appinfo);
200
201GLIB_AVAILABLE_IN_ALL
202gboolean g_app_info_can_delete (GAppInfo *appinfo);
203GLIB_AVAILABLE_IN_ALL
204gboolean g_app_info_delete (GAppInfo *appinfo);
205
206GLIB_AVAILABLE_IN_ALL
207gboolean g_app_info_set_as_last_used_for_type (GAppInfo *appinfo,
208 const char *content_type,
209 GError **error);
210
211GLIB_AVAILABLE_IN_ALL
212GList * g_app_info_get_all (void);
213GLIB_AVAILABLE_IN_ALL
214GList * g_app_info_get_all_for_type (const char *content_type);
215GLIB_AVAILABLE_IN_ALL
216GList * g_app_info_get_recommended_for_type (const gchar *content_type);
217GLIB_AVAILABLE_IN_ALL
218GList * g_app_info_get_fallback_for_type (const gchar *content_type);
219
220GLIB_AVAILABLE_IN_ALL
221void g_app_info_reset_type_associations (const char *content_type);
222GLIB_AVAILABLE_IN_ALL
223GAppInfo *g_app_info_get_default_for_type (const char *content_type,
224 gboolean must_support_uris);
225GLIB_AVAILABLE_IN_ALL
226GAppInfo *g_app_info_get_default_for_uri_scheme (const char *uri_scheme);
227
228GLIB_AVAILABLE_IN_ALL
229gboolean g_app_info_launch_default_for_uri (const char *uri,
230 GAppLaunchContext *launch_context,
231 GError **error);
232
233/**
234 * GAppLaunchContext:
235 *
236 * Integrating the launch with the launching application. This is used to
237 * handle for instance startup notification and launching the new application
238 * on the same screen as the launching window.
239 */
240struct _GAppLaunchContext
241{
242 GObject parent_instance;
243
244 /*< private >*/
245 GAppLaunchContextPrivate *priv;
246};
247
248struct _GAppLaunchContextClass
249{
250 GObjectClass parent_class;
251
252 char * (* get_display) (GAppLaunchContext *context,
253 GAppInfo *info,
254 GList *files);
255 char * (* get_startup_notify_id) (GAppLaunchContext *context,
256 GAppInfo *info,
257 GList *files);
258 void (* launch_failed) (GAppLaunchContext *context,
259 const char *startup_notify_id);
260 void (* launched) (GAppLaunchContext *context,
261 GAppInfo *info,
262 GVariant *platform_data);
263
264 /* Padding for future expansion */
265 void (*_g_reserved1) (void);
266 void (*_g_reserved2) (void);
267 void (*_g_reserved3) (void);
268 void (*_g_reserved4) (void);
269};
270
271GLIB_AVAILABLE_IN_ALL
272GType g_app_launch_context_get_type (void) G_GNUC_CONST;
273GLIB_AVAILABLE_IN_ALL
274GAppLaunchContext *g_app_launch_context_new (void);
275
276GLIB_AVAILABLE_IN_2_32
277void g_app_launch_context_setenv (GAppLaunchContext *context,
278 const char *variable,
279 const char *value);
280GLIB_AVAILABLE_IN_2_32
281void g_app_launch_context_unsetenv (GAppLaunchContext *context,
282 const char *variable);
283GLIB_AVAILABLE_IN_2_32
284char ** g_app_launch_context_get_environment (GAppLaunchContext *context);
285
286GLIB_AVAILABLE_IN_ALL
287char * g_app_launch_context_get_display (GAppLaunchContext *context,
288 GAppInfo *info,
289 GList *files);
290GLIB_AVAILABLE_IN_ALL
291char * g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
292 GAppInfo *info,
293 GList *files);
294GLIB_AVAILABLE_IN_ALL
295void g_app_launch_context_launch_failed (GAppLaunchContext *context,
296 const char * startup_notify_id);
297
298#define G_TYPE_APP_INFO_MONITOR (g_app_info_monitor_get_type ())
299#define G_APP_INFO_MONITOR(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
300 G_TYPE_APP_INFO_MONITOR, GAppInfoMonitor))
301#define G_IS_APP_INFO_MONITOR(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
302 G_TYPE_APP_INFO_MONITOR))
303
304typedef struct _GAppInfoMonitor GAppInfoMonitor;
305
306GLIB_AVAILABLE_IN_2_40
307GType g_app_info_monitor_get_type (void);
308
309GLIB_AVAILABLE_IN_2_40
310GAppInfoMonitor * g_app_info_monitor_get (void);
311
312G_END_DECLS
313
314#endif /* __G_APP_INFO_H__ */
315