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 #ifndef __G_APP_INFO_H__
24 #define __G_APP_INFO_H__
26 #include <glib-object.h>
27 #include <gio/gicon.h>
31 #define G_TYPE_APP_INFO (g_app_info_get_type ())
32 #define G_APP_INFO(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_APP_INFO, GAppInfo))
33 #define G_IS_APP_INFO(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_APP_INFO))
34 #define G_APP_INFO_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_APP_INFO, GAppInfoIface))
36 #define G_TYPE_APP_LAUNCH_CONTEXT (g_app_launch_context_get_type ())
37 #define G_APP_LAUNCH_CONTEXT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContext))
38 #define G_APP_LAUNCH_CONTEXT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
39 #define G_IS_APP_LAUNCH_CONTEXT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_APP_LAUNCH_CONTEXT))
40 #define G_IS_APP_LAUNCH_CONTEXT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_APP_LAUNCH_CONTEXT))
41 #define G_APP_LAUNCH_CONTEXT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
44 * GAppInfoCreateFlags:
45 * @G_APP_INFO_CREATE_FLAGS_NONE: No flags.
46 * @G_APP_INFO_CREATE_NEEDS_TERMINAL: Application opens in a terminal window.
48 * Flags used when creating a #GAppInfo.
51 G_APP_INFO_CREATE_FLAGS_NONE = 0, /*< nick=none >*/
52 G_APP_INFO_CREATE_NEEDS_TERMINAL = (1<<0) /*< nick=needs-terminal >*/
53 } GAppInfoCreateFlags;
55 typedef struct _GAppLaunchContext GAppLaunchContext;
56 typedef struct _GAppLaunchContextClass GAppLaunchContextClass;
57 typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
62 * Information about an installed application and methods to launch
63 * it (with file arguments).
65 typedef struct _GAppInfo GAppInfo; /* Dummy typedef */
69 * @g_iface: The parent interface.
70 * @dup: Copies a #GAppInfo.
71 * @equal: Checks two #GAppInfo<!-- -->s for equality.
72 * @get_id: Gets a string identifier for a #GAppInfo.
73 * @get_name: Gets the name of the application for a #GAppInfo.
74 * @get_description: Gets a short description for the application described by the #GAppInfo.
75 * @get_executable: Gets the execuable name for the #GAppInfo.
76 * @get_icon: Gets the #GIcon for the #GAppInfo.
77 * @launch: Launches an application specified by the #GAppInfo.
78 * @supports_uris: Indicates whether the application specified supports launching URIs.
79 * @launch_uris: Launches an application with a list of URIs.
80 * @should_show: Returns whether an application should be shown (e.g. when getting a list of installed applications).
81 * <ulink url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
82 * <citetitle>FreeDesktop.Org Startup Notification Specification</citetitle></ulink>.
83 * @set_as_default_for_type: Sets an application as default for a given content type.
84 * @set_as_default_for_extension: Sets an application as default for a given file extention.
85 * @add_supports_type: Adds to the #GAppInfo information about supported file types.
86 * @can_remove_supports_type: Checks for support for removing supported file types from a #GAppInfo.
87 * @remove_supports_type: Removes a supported application type from a #GAppInfo.
89 * Application Information interface, for operating system portability.
91 typedef struct _GAppInfoIface GAppInfoIface;
95 GTypeInterface g_iface;
99 GAppInfo * (*dup) (GAppInfo *appinfo);
100 gboolean (*equal) (GAppInfo *appinfo1,
102 const char * (*get_id) (GAppInfo *appinfo);
103 const char * (*get_name) (GAppInfo *appinfo);
104 const char * (*get_description) (GAppInfo *appinfo);
105 const char * (*get_executable) (GAppInfo *appinfo);
106 GIcon * (*get_icon) (GAppInfo *appinfo);
107 gboolean (*launch) (GAppInfo *appinfo,
109 GAppLaunchContext *launch_context,
111 gboolean (*supports_uris) (GAppInfo *appinfo);
112 gboolean (*launch_uris) (GAppInfo *appinfo,
114 GAppLaunchContext *launch_context,
116 gboolean (*should_show) (GAppInfo *appinfo,
117 const char *desktop_env);
119 /* For changing associations */
120 gboolean (*set_as_default_for_type) (GAppInfo *appinfo,
121 const char *content_type,
123 gboolean (*set_as_default_for_extension) (GAppInfo *appinfo,
124 const char *extension,
126 gboolean (*add_supports_type) (GAppInfo *appinfo,
127 const char *content_type,
129 gboolean (*can_remove_supports_type) (GAppInfo *appinfo);
130 gboolean (*remove_supports_type) (GAppInfo *appinfo,
131 const char *content_type,
135 GType g_app_info_get_type (void) G_GNUC_CONST;
136 GType g_app_launch_context_get_type (void) G_GNUC_CONST;
138 GAppInfo * g_app_info_create_from_commandline (const char *commandline,
139 const char *application_name,
140 GAppInfoCreateFlags flags,
142 GAppInfo * g_app_info_dup (GAppInfo *appinfo);
143 gboolean g_app_info_equal (GAppInfo *appinfo1,
145 const char *g_app_info_get_id (GAppInfo *appinfo);
146 const char *g_app_info_get_name (GAppInfo *appinfo);
147 const char *g_app_info_get_description (GAppInfo *appinfo);
148 const char *g_app_info_get_executable (GAppInfo *appinfo);
149 GIcon * g_app_info_get_icon (GAppInfo *appinfo);
150 gboolean g_app_info_launch (GAppInfo *appinfo,
152 GAppLaunchContext *launch_context,
154 gboolean g_app_info_supports_uris (GAppInfo *appinfo);
155 gboolean g_app_info_launch_uris (GAppInfo *appinfo,
157 GAppLaunchContext *launch_context,
159 gboolean g_app_info_should_show (GAppInfo *appinfo,
160 const char *desktop_env);
162 gboolean g_app_info_set_as_default_for_type (GAppInfo *appinfo,
163 const char *content_type,
165 gboolean g_app_info_set_as_default_for_extension (GAppInfo *appinfo,
166 const char *extension,
168 gboolean g_app_info_add_supports_type (GAppInfo *appinfo,
169 const char *content_type,
171 gboolean g_app_info_can_remove_supports_type (GAppInfo *appinfo);
172 gboolean g_app_info_remove_supports_type (GAppInfo *appinfo,
173 const char *content_type,
176 GList * g_app_info_get_all (void);
177 GList * g_app_info_get_all_for_type (const char *content_type);
178 GAppInfo *g_app_info_get_default_for_type (const char *content_type,
179 gboolean must_support_uris);
180 GAppInfo *g_app_info_get_default_for_uri_scheme (const char *uri_scheme);
184 * @parent_instance: The parent instance.
186 * Integrating the launch with the launching application. This is used to
187 * handle for instance startup notification and launching the new application
188 * on the same screen as the launching window.
190 struct _GAppLaunchContext
192 GObject parent_instance;
195 GAppLaunchContextPrivate *priv;
198 struct _GAppLaunchContextClass
200 GObjectClass parent_class;
202 char * (*get_display) (GAppLaunchContext *context,
205 char * (*get_startup_notify_id) (GAppLaunchContext *context,
208 void (*launch_failed) (GAppLaunchContext *context,
209 const char *startup_notify_id);
211 /* Padding for future expansion */
212 void (*_g_reserved1) (void);
213 void (*_g_reserved2) (void);
214 void (*_g_reserved3) (void);
215 void (*_g_reserved4) (void);
216 void (*_g_reserved5) (void);
219 GAppLaunchContext *g_app_launch_context_new (void);
220 char * g_app_launch_context_get_display (GAppLaunchContext *context,
223 char * g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
226 void g_app_launch_context_launch_failed (GAppLaunchContext *context,
227 const char * startup_notify_id);
231 #endif /* __G_APP_INFO_H__ */