1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
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/>.
18 * Author: Alexander Larsson <alexl@redhat.com>
21 #ifndef __G_APP_INFO_H__
22 #define __G_APP_INFO_H__
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
28 #include <gio/giotypes.h>
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))
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))
44 typedef struct _GAppLaunchContextClass GAppLaunchContextClass;
45 typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
50 * Information about an installed application and methods to launch
51 * it (with file arguments).
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 * @launch_uris_async: Asynchronously launches an application with a list of URIs. (Since: 2.60)
82 * @launch_uris_finish: Finishes an operation started with @launch_uris_async. (Since: 2.60)
84 * Application Information interface, for operating system portability.
86 typedef struct _GAppInfoIface GAppInfoIface;
90 GTypeInterface g_iface;
94 GAppInfo * (* dup) (GAppInfo *appinfo);
95 gboolean (* equal) (GAppInfo *appinfo1,
97 const char * (* get_id) (GAppInfo *appinfo);
98 const char * (* get_name) (GAppInfo *appinfo);
99 const char * (* get_description) (GAppInfo *appinfo);
100 const char * (* get_executable) (GAppInfo *appinfo);
101 GIcon * (* get_icon) (GAppInfo *appinfo);
102 gboolean (* launch) (GAppInfo *appinfo,
104 GAppLaunchContext *context,
106 gboolean (* supports_uris) (GAppInfo *appinfo);
107 gboolean (* supports_files) (GAppInfo *appinfo);
108 gboolean (* launch_uris) (GAppInfo *appinfo,
110 GAppLaunchContext *context,
112 gboolean (* should_show) (GAppInfo *appinfo);
114 /* For changing associations */
115 gboolean (* set_as_default_for_type) (GAppInfo *appinfo,
116 const char *content_type,
118 gboolean (* set_as_default_for_extension) (GAppInfo *appinfo,
119 const char *extension,
121 gboolean (* add_supports_type) (GAppInfo *appinfo,
122 const char *content_type,
124 gboolean (* can_remove_supports_type) (GAppInfo *appinfo);
125 gboolean (* remove_supports_type) (GAppInfo *appinfo,
126 const char *content_type,
128 gboolean (* can_delete) (GAppInfo *appinfo);
129 gboolean (* do_delete) (GAppInfo *appinfo);
130 const char * (* get_commandline) (GAppInfo *appinfo);
131 const char * (* get_display_name) (GAppInfo *appinfo);
132 gboolean (* set_as_last_used_for_type) (GAppInfo *appinfo,
133 const char *content_type,
135 const char ** (* get_supported_types) (GAppInfo *appinfo);
136 void (* launch_uris_async) (GAppInfo *appinfo,
138 GAppLaunchContext *context,
139 GCancellable *cancellable,
140 GAsyncReadyCallback callback,
142 gboolean (* launch_uris_finish) (GAppInfo *appinfo,
143 GAsyncResult *result,
147 GLIB_AVAILABLE_IN_ALL
148 GType g_app_info_get_type (void) G_GNUC_CONST;
149 GLIB_AVAILABLE_IN_ALL
150 GAppInfo * g_app_info_create_from_commandline (const char *commandline,
151 const char *application_name,
152 GAppInfoCreateFlags flags,
154 GLIB_AVAILABLE_IN_ALL
155 GAppInfo * g_app_info_dup (GAppInfo *appinfo);
156 GLIB_AVAILABLE_IN_ALL
157 gboolean g_app_info_equal (GAppInfo *appinfo1,
159 GLIB_AVAILABLE_IN_ALL
160 const char *g_app_info_get_id (GAppInfo *appinfo);
161 GLIB_AVAILABLE_IN_ALL
162 const char *g_app_info_get_name (GAppInfo *appinfo);
163 GLIB_AVAILABLE_IN_ALL
164 const char *g_app_info_get_display_name (GAppInfo *appinfo);
165 GLIB_AVAILABLE_IN_ALL
166 const char *g_app_info_get_description (GAppInfo *appinfo);
167 GLIB_AVAILABLE_IN_ALL
168 const char *g_app_info_get_executable (GAppInfo *appinfo);
169 GLIB_AVAILABLE_IN_ALL
170 const char *g_app_info_get_commandline (GAppInfo *appinfo);
171 GLIB_AVAILABLE_IN_ALL
172 GIcon * g_app_info_get_icon (GAppInfo *appinfo);
173 GLIB_AVAILABLE_IN_ALL
174 gboolean g_app_info_launch (GAppInfo *appinfo,
176 GAppLaunchContext *context,
178 GLIB_AVAILABLE_IN_ALL
179 gboolean g_app_info_supports_uris (GAppInfo *appinfo);
180 GLIB_AVAILABLE_IN_ALL
181 gboolean g_app_info_supports_files (GAppInfo *appinfo);
182 GLIB_AVAILABLE_IN_ALL
183 gboolean g_app_info_launch_uris (GAppInfo *appinfo,
185 GAppLaunchContext *context,
187 GLIB_AVAILABLE_IN_2_60
188 void g_app_info_launch_uris_async (GAppInfo *appinfo,
190 GAppLaunchContext *context,
191 GCancellable *cancellable,
192 GAsyncReadyCallback callback,
194 GLIB_AVAILABLE_IN_2_60
195 gboolean g_app_info_launch_uris_finish (GAppInfo *appinfo,
196 GAsyncResult *result,
199 GLIB_AVAILABLE_IN_ALL
200 gboolean g_app_info_should_show (GAppInfo *appinfo);
202 GLIB_AVAILABLE_IN_ALL
203 gboolean g_app_info_set_as_default_for_type (GAppInfo *appinfo,
204 const char *content_type,
206 GLIB_AVAILABLE_IN_ALL
207 gboolean g_app_info_set_as_default_for_extension (GAppInfo *appinfo,
208 const char *extension,
210 GLIB_AVAILABLE_IN_ALL
211 gboolean g_app_info_add_supports_type (GAppInfo *appinfo,
212 const char *content_type,
214 GLIB_AVAILABLE_IN_ALL
215 gboolean g_app_info_can_remove_supports_type (GAppInfo *appinfo);
216 GLIB_AVAILABLE_IN_ALL
217 gboolean g_app_info_remove_supports_type (GAppInfo *appinfo,
218 const char *content_type,
220 GLIB_AVAILABLE_IN_2_34
221 const char **g_app_info_get_supported_types (GAppInfo *appinfo);
223 GLIB_AVAILABLE_IN_ALL
224 gboolean g_app_info_can_delete (GAppInfo *appinfo);
225 GLIB_AVAILABLE_IN_ALL
226 gboolean g_app_info_delete (GAppInfo *appinfo);
228 GLIB_AVAILABLE_IN_ALL
229 gboolean g_app_info_set_as_last_used_for_type (GAppInfo *appinfo,
230 const char *content_type,
233 GLIB_AVAILABLE_IN_ALL
234 GList * g_app_info_get_all (void);
235 GLIB_AVAILABLE_IN_ALL
236 GList * g_app_info_get_all_for_type (const char *content_type);
237 GLIB_AVAILABLE_IN_ALL
238 GList * g_app_info_get_recommended_for_type (const gchar *content_type);
239 GLIB_AVAILABLE_IN_ALL
240 GList * g_app_info_get_fallback_for_type (const gchar *content_type);
242 GLIB_AVAILABLE_IN_ALL
243 void g_app_info_reset_type_associations (const char *content_type);
244 GLIB_AVAILABLE_IN_ALL
245 GAppInfo *g_app_info_get_default_for_type (const char *content_type,
246 gboolean must_support_uris);
247 GLIB_AVAILABLE_IN_ALL
248 GAppInfo *g_app_info_get_default_for_uri_scheme (const char *uri_scheme);
250 GLIB_AVAILABLE_IN_ALL
251 gboolean g_app_info_launch_default_for_uri (const char *uri,
252 GAppLaunchContext *context,
255 GLIB_AVAILABLE_IN_2_50
256 void g_app_info_launch_default_for_uri_async (const char *uri,
257 GAppLaunchContext *context,
258 GCancellable *cancellable,
259 GAsyncReadyCallback callback,
261 GLIB_AVAILABLE_IN_2_50
262 gboolean g_app_info_launch_default_for_uri_finish (GAsyncResult *result,
269 * Integrating the launch with the launching application. This is used to
270 * handle for instance startup notification and launching the new application
271 * on the same screen as the launching window.
273 struct _GAppLaunchContext
275 GObject parent_instance;
278 GAppLaunchContextPrivate *priv;
281 struct _GAppLaunchContextClass
283 GObjectClass parent_class;
285 char * (* get_display) (GAppLaunchContext *context,
288 char * (* get_startup_notify_id) (GAppLaunchContext *context,
291 void (* launch_failed) (GAppLaunchContext *context,
292 const char *startup_notify_id);
293 void (* launched) (GAppLaunchContext *context,
295 GVariant *platform_data);
297 /* Padding for future expansion */
298 void (*_g_reserved1) (void);
299 void (*_g_reserved2) (void);
300 void (*_g_reserved3) (void);
301 void (*_g_reserved4) (void);
304 GLIB_AVAILABLE_IN_ALL
305 GType g_app_launch_context_get_type (void) G_GNUC_CONST;
306 GLIB_AVAILABLE_IN_ALL
307 GAppLaunchContext *g_app_launch_context_new (void);
309 GLIB_AVAILABLE_IN_2_32
310 void g_app_launch_context_setenv (GAppLaunchContext *context,
311 const char *variable,
313 GLIB_AVAILABLE_IN_2_32
314 void g_app_launch_context_unsetenv (GAppLaunchContext *context,
315 const char *variable);
316 GLIB_AVAILABLE_IN_2_32
317 char ** g_app_launch_context_get_environment (GAppLaunchContext *context);
319 GLIB_AVAILABLE_IN_ALL
320 char * g_app_launch_context_get_display (GAppLaunchContext *context,
323 GLIB_AVAILABLE_IN_ALL
324 char * g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
327 GLIB_AVAILABLE_IN_ALL
328 void g_app_launch_context_launch_failed (GAppLaunchContext *context,
329 const char * startup_notify_id);
331 #define G_TYPE_APP_INFO_MONITOR (g_app_info_monitor_get_type ())
332 #define G_APP_INFO_MONITOR(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
333 G_TYPE_APP_INFO_MONITOR, GAppInfoMonitor))
334 #define G_IS_APP_INFO_MONITOR(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
335 G_TYPE_APP_INFO_MONITOR))
337 typedef struct _GAppInfoMonitor GAppInfoMonitor;
339 GLIB_AVAILABLE_IN_2_40
340 GType g_app_info_monitor_get_type (void);
342 GLIB_AVAILABLE_IN_2_40
343 GAppInfoMonitor * g_app_info_monitor_get (void);
347 #endif /* __G_APP_INFO_H__ */