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 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 * <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.
83 * Application Information interface, for operating system portability.
85 typedef struct _GAppInfoIface GAppInfoIface;
89 GTypeInterface g_iface;
93 GAppInfo * (* dup) (GAppInfo *appinfo);
94 gboolean (* equal) (GAppInfo *appinfo1,
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,
103 GAppLaunchContext *launch_context,
105 gboolean (* supports_uris) (GAppInfo *appinfo);
106 gboolean (* supports_files) (GAppInfo *appinfo);
107 gboolean (* launch_uris) (GAppInfo *appinfo,
109 GAppLaunchContext *launch_context,
111 gboolean (* should_show) (GAppInfo *appinfo);
113 /* For changing associations */
114 gboolean (* set_as_default_for_type) (GAppInfo *appinfo,
115 const char *content_type,
117 gboolean (* set_as_default_for_extension) (GAppInfo *appinfo,
118 const char *extension,
120 gboolean (* add_supports_type) (GAppInfo *appinfo,
121 const char *content_type,
123 gboolean (* can_remove_supports_type) (GAppInfo *appinfo);
124 gboolean (* remove_supports_type) (GAppInfo *appinfo,
125 const char *content_type,
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,
134 const char ** (* get_supported_types) (GAppInfo *appinfo);
137 GLIB_AVAILABLE_IN_ALL
138 GType g_app_info_get_type (void) G_GNUC_CONST;
139 GLIB_AVAILABLE_IN_ALL
140 GAppInfo * g_app_info_create_from_commandline (const char *commandline,
141 const char *application_name,
142 GAppInfoCreateFlags flags,
144 GLIB_AVAILABLE_IN_ALL
145 GAppInfo * g_app_info_dup (GAppInfo *appinfo);
146 GLIB_AVAILABLE_IN_ALL
147 gboolean g_app_info_equal (GAppInfo *appinfo1,
149 GLIB_AVAILABLE_IN_ALL
150 const char *g_app_info_get_id (GAppInfo *appinfo);
151 GLIB_AVAILABLE_IN_ALL
152 const char *g_app_info_get_name (GAppInfo *appinfo);
153 GLIB_AVAILABLE_IN_ALL
154 const char *g_app_info_get_display_name (GAppInfo *appinfo);
155 GLIB_AVAILABLE_IN_ALL
156 const char *g_app_info_get_description (GAppInfo *appinfo);
157 GLIB_AVAILABLE_IN_ALL
158 const char *g_app_info_get_executable (GAppInfo *appinfo);
159 GLIB_AVAILABLE_IN_ALL
160 const char *g_app_info_get_commandline (GAppInfo *appinfo);
161 GLIB_AVAILABLE_IN_ALL
162 GIcon * g_app_info_get_icon (GAppInfo *appinfo);
163 GLIB_AVAILABLE_IN_ALL
164 gboolean g_app_info_launch (GAppInfo *appinfo,
166 GAppLaunchContext *launch_context,
168 GLIB_AVAILABLE_IN_ALL
169 gboolean g_app_info_supports_uris (GAppInfo *appinfo);
170 GLIB_AVAILABLE_IN_ALL
171 gboolean g_app_info_supports_files (GAppInfo *appinfo);
172 GLIB_AVAILABLE_IN_ALL
173 gboolean g_app_info_launch_uris (GAppInfo *appinfo,
175 GAppLaunchContext *launch_context,
177 GLIB_AVAILABLE_IN_ALL
178 gboolean g_app_info_should_show (GAppInfo *appinfo);
180 GLIB_AVAILABLE_IN_ALL
181 gboolean g_app_info_set_as_default_for_type (GAppInfo *appinfo,
182 const char *content_type,
184 GLIB_AVAILABLE_IN_ALL
185 gboolean g_app_info_set_as_default_for_extension (GAppInfo *appinfo,
186 const char *extension,
188 GLIB_AVAILABLE_IN_ALL
189 gboolean g_app_info_add_supports_type (GAppInfo *appinfo,
190 const char *content_type,
192 GLIB_AVAILABLE_IN_ALL
193 gboolean g_app_info_can_remove_supports_type (GAppInfo *appinfo);
194 GLIB_AVAILABLE_IN_ALL
195 gboolean g_app_info_remove_supports_type (GAppInfo *appinfo,
196 const char *content_type,
198 GLIB_AVAILABLE_IN_2_34
199 const char **g_app_info_get_supported_types (GAppInfo *appinfo);
201 GLIB_AVAILABLE_IN_ALL
202 gboolean g_app_info_can_delete (GAppInfo *appinfo);
203 GLIB_AVAILABLE_IN_ALL
204 gboolean g_app_info_delete (GAppInfo *appinfo);
206 GLIB_AVAILABLE_IN_ALL
207 gboolean g_app_info_set_as_last_used_for_type (GAppInfo *appinfo,
208 const char *content_type,
211 GLIB_AVAILABLE_IN_ALL
212 GList * g_app_info_get_all (void);
213 GLIB_AVAILABLE_IN_ALL
214 GList * g_app_info_get_all_for_type (const char *content_type);
215 GLIB_AVAILABLE_IN_ALL
216 GList * g_app_info_get_recommended_for_type (const gchar *content_type);
217 GLIB_AVAILABLE_IN_ALL
218 GList * g_app_info_get_fallback_for_type (const gchar *content_type);
220 GLIB_AVAILABLE_IN_ALL
221 void g_app_info_reset_type_associations (const char *content_type);
222 GLIB_AVAILABLE_IN_ALL
223 GAppInfo *g_app_info_get_default_for_type (const char *content_type,
224 gboolean must_support_uris);
225 GLIB_AVAILABLE_IN_ALL
226 GAppInfo *g_app_info_get_default_for_uri_scheme (const char *uri_scheme);
228 GLIB_AVAILABLE_IN_ALL
229 gboolean g_app_info_launch_default_for_uri (const char *uri,
230 GAppLaunchContext *launch_context,
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.
240 struct _GAppLaunchContext
242 GObject parent_instance;
245 GAppLaunchContextPrivate *priv;
248 struct _GAppLaunchContextClass
250 GObjectClass parent_class;
252 char * (* get_display) (GAppLaunchContext *context,
255 char * (* get_startup_notify_id) (GAppLaunchContext *context,
258 void (* launch_failed) (GAppLaunchContext *context,
259 const char *startup_notify_id);
260 void (* launched) (GAppLaunchContext *context,
262 GVariant *platform_data);
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);
271 GLIB_AVAILABLE_IN_ALL
272 GType g_app_launch_context_get_type (void) G_GNUC_CONST;
273 GLIB_AVAILABLE_IN_ALL
274 GAppLaunchContext *g_app_launch_context_new (void);
276 GLIB_AVAILABLE_IN_2_32
277 void g_app_launch_context_setenv (GAppLaunchContext *context,
278 const char *variable,
280 GLIB_AVAILABLE_IN_2_32
281 void g_app_launch_context_unsetenv (GAppLaunchContext *context,
282 const char *variable);
283 GLIB_AVAILABLE_IN_2_32
284 char ** g_app_launch_context_get_environment (GAppLaunchContext *context);
286 GLIB_AVAILABLE_IN_ALL
287 char * g_app_launch_context_get_display (GAppLaunchContext *context,
290 GLIB_AVAILABLE_IN_ALL
291 char * g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
294 GLIB_AVAILABLE_IN_ALL
295 void g_app_launch_context_launch_failed (GAppLaunchContext *context,
296 const char * startup_notify_id);
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))
304 typedef struct _GAppInfoMonitor GAppInfoMonitor;
306 GLIB_AVAILABLE_IN_2_40
307 GType g_app_info_monitor_get_type (void);
309 GLIB_AVAILABLE_IN_2_40
310 GAppInfoMonitor * g_app_info_monitor_get (void);
314 #endif /* __G_APP_INFO_H__ */