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, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
27 #ifndef __G_APP_INFO_H__
28 #define __G_APP_INFO_H__
30 #include <glib-object.h>
31 #include <gio/gicon.h>
35 #define G_TYPE_APP_INFO (g_app_info_get_type ())
36 #define G_APP_INFO(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_APP_INFO, GAppInfo))
37 #define G_IS_APP_INFO(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_APP_INFO))
38 #define G_APP_INFO_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_APP_INFO, GAppInfoIface))
40 #define G_TYPE_APP_LAUNCH_CONTEXT (g_app_launch_context_get_type ())
41 #define G_APP_LAUNCH_CONTEXT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContext))
42 #define G_APP_LAUNCH_CONTEXT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
43 #define G_IS_APP_LAUNCH_CONTEXT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_APP_LAUNCH_CONTEXT))
44 #define G_IS_APP_LAUNCH_CONTEXT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_APP_LAUNCH_CONTEXT))
45 #define G_APP_LAUNCH_CONTEXT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
48 * GAppInfoCreateFlags:
49 * @G_APP_INFO_CREATE_NONE: No flags.
50 * @G_APP_INFO_CREATE_NEEDS_TERMINAL: Application opens in a terminal window.
51 * @G_APP_INFO_CREATE_SUPPORTS_URIS: Application supports URI arguments.
53 * Flags used when creating a #GAppInfo.
56 G_APP_INFO_CREATE_NONE = 0, /*< nick=none >*/
57 G_APP_INFO_CREATE_NEEDS_TERMINAL = (1<<0), /*< nick=needs-terminal >*/
58 G_APP_INFO_CREATE_SUPPORTS_URIS = (1<<1) /*< nick=supports-uris >*/
59 } GAppInfoCreateFlags;
61 typedef struct _GAppLaunchContext GAppLaunchContext;
62 typedef struct _GAppLaunchContextClass GAppLaunchContextClass;
63 typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
68 * Information about an installed application and methods to launch
69 * it (with file arguments).
71 typedef struct _GAppInfo GAppInfo; /* Dummy typedef */
75 * @g_iface: The parent interface.
76 * @dup: Copies a #GAppInfo.
77 * @equal: Checks two #GAppInfo<!-- -->s for equality.
78 * @get_id: Gets a string identifier for a #GAppInfo.
79 * @get_name: Gets the name of the application for a #GAppInfo.
80 * @get_description: Gets a short description for the application described by the #GAppInfo.
81 * @get_executable: Gets the execuable name for the #GAppInfo.
82 * @get_icon: Gets the #GIcon for the #GAppInfo.
83 * @launch: Launches an application specified by the #GAppInfo.
84 * @supports_uris: Indicates whether the application specified supports launching URIs.
85 * @supports_files: Indicates whether the application specified accepts filename arguments.
86 * @launch_uris: Launches an application with a list of URIs.
87 * @should_show: Returns whether an application should be shown (e.g. when getting a list of installed applications).
88 * <ulink url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
89 * <citetitle>FreeDesktop.Org Startup Notification Specification</citetitle></ulink>.
90 * @set_as_default_for_type: Sets an application as default for a given content type.
91 * @set_as_default_for_extension: Sets an application as default for a given file extention.
92 * @add_supports_type: Adds to the #GAppInfo information about supported file types.
93 * @can_remove_supports_type: Checks for support for removing supported file types from a #GAppInfo.
94 * @remove_supports_type: Removes a supported application type from a #GAppInfo.
96 * Application Information interface, for operating system portability.
98 typedef struct _GAppInfoIface GAppInfoIface;
100 struct _GAppInfoIface
102 GTypeInterface g_iface;
106 GAppInfo * (*dup) (GAppInfo *appinfo);
107 gboolean (*equal) (GAppInfo *appinfo1,
109 const char * (*get_id) (GAppInfo *appinfo);
110 const char * (*get_name) (GAppInfo *appinfo);
111 const char * (*get_description) (GAppInfo *appinfo);
112 const char * (*get_executable) (GAppInfo *appinfo);
113 GIcon * (*get_icon) (GAppInfo *appinfo);
114 gboolean (*launch) (GAppInfo *appinfo,
116 GAppLaunchContext *launch_context,
118 gboolean (*supports_uris) (GAppInfo *appinfo);
119 gboolean (*supports_files) (GAppInfo *appinfo);
120 gboolean (*launch_uris) (GAppInfo *appinfo,
122 GAppLaunchContext *launch_context,
124 gboolean (*should_show) (GAppInfo *appinfo);
126 /* For changing associations */
127 gboolean (*set_as_default_for_type) (GAppInfo *appinfo,
128 const char *content_type,
130 gboolean (*set_as_default_for_extension) (GAppInfo *appinfo,
131 const char *extension,
133 gboolean (*add_supports_type) (GAppInfo *appinfo,
134 const char *content_type,
136 gboolean (*can_remove_supports_type) (GAppInfo *appinfo);
137 gboolean (*remove_supports_type) (GAppInfo *appinfo,
138 const char *content_type,
142 GType g_app_info_get_type (void) G_GNUC_CONST;
143 GType g_app_launch_context_get_type (void) G_GNUC_CONST;
145 GAppInfo * g_app_info_create_from_commandline (const char *commandline,
146 const char *application_name,
147 GAppInfoCreateFlags flags,
149 GAppInfo * g_app_info_dup (GAppInfo *appinfo);
150 gboolean g_app_info_equal (GAppInfo *appinfo1,
152 const char *g_app_info_get_id (GAppInfo *appinfo);
153 const char *g_app_info_get_name (GAppInfo *appinfo);
154 const char *g_app_info_get_description (GAppInfo *appinfo);
155 const char *g_app_info_get_executable (GAppInfo *appinfo);
156 GIcon * g_app_info_get_icon (GAppInfo *appinfo);
157 gboolean g_app_info_launch (GAppInfo *appinfo,
159 GAppLaunchContext *launch_context,
161 gboolean g_app_info_supports_uris (GAppInfo *appinfo);
162 gboolean g_app_info_supports_files (GAppInfo *appinfo);
163 gboolean g_app_info_launch_uris (GAppInfo *appinfo,
165 GAppLaunchContext *launch_context,
167 gboolean g_app_info_should_show (GAppInfo *appinfo);
169 gboolean g_app_info_set_as_default_for_type (GAppInfo *appinfo,
170 const char *content_type,
172 gboolean g_app_info_set_as_default_for_extension (GAppInfo *appinfo,
173 const char *extension,
175 gboolean g_app_info_add_supports_type (GAppInfo *appinfo,
176 const char *content_type,
178 gboolean g_app_info_can_remove_supports_type (GAppInfo *appinfo);
179 gboolean g_app_info_remove_supports_type (GAppInfo *appinfo,
180 const char *content_type,
183 GList * g_app_info_get_all (void);
184 GList * g_app_info_get_all_for_type (const char *content_type);
185 GAppInfo *g_app_info_get_default_for_type (const char *content_type,
186 gboolean must_support_uris);
187 GAppInfo *g_app_info_get_default_for_uri_scheme (const char *uri_scheme);
189 gboolean g_app_info_launch_default_for_uri (const char *uri,
190 GAppLaunchContext *launch_context,
195 * @parent_instance: The parent instance.
197 * Integrating the launch with the launching application. This is used to
198 * handle for instance startup notification and launching the new application
199 * on the same screen as the launching window.
201 struct _GAppLaunchContext
203 GObject parent_instance;
206 GAppLaunchContextPrivate *priv;
209 struct _GAppLaunchContextClass
211 GObjectClass parent_class;
213 char * (*get_display) (GAppLaunchContext *context,
216 char * (*get_startup_notify_id) (GAppLaunchContext *context,
219 void (*launch_failed) (GAppLaunchContext *context,
220 const char *startup_notify_id);
222 /* Padding for future expansion */
223 void (*_g_reserved1) (void);
224 void (*_g_reserved2) (void);
225 void (*_g_reserved3) (void);
226 void (*_g_reserved4) (void);
227 void (*_g_reserved5) (void);
230 GAppLaunchContext *g_app_launch_context_new (void);
231 char * g_app_launch_context_get_display (GAppLaunchContext *context,
234 char * g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
237 void g_app_launch_context_launch_failed (GAppLaunchContext *context,
238 const char * startup_notify_id);
242 #endif /* __G_APP_INFO_H__ */