• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Author: Alexander Larsson <alexl@redhat.com>
21  */
22 
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
25 #endif
26 
27 #ifndef __G_APP_INFO_H__
28 #define __G_APP_INFO_H__
29 
30 #include <gio/giotypes.h>
31 
32 G_BEGIN_DECLS
33 
34 #define G_TYPE_APP_INFO            (g_app_info_get_type ())
35 #define G_APP_INFO(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_APP_INFO, GAppInfo))
36 #define G_IS_APP_INFO(obj)	   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_APP_INFO))
37 #define G_APP_INFO_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_APP_INFO, GAppInfoIface))
38 
39 #define G_TYPE_APP_LAUNCH_CONTEXT         (g_app_launch_context_get_type ())
40 #define G_APP_LAUNCH_CONTEXT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContext))
41 #define G_APP_LAUNCH_CONTEXT_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
42 #define G_IS_APP_LAUNCH_CONTEXT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_APP_LAUNCH_CONTEXT))
43 #define G_IS_APP_LAUNCH_CONTEXT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_APP_LAUNCH_CONTEXT))
44 #define G_APP_LAUNCH_CONTEXT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
45 
46 typedef struct _GAppLaunchContextClass   GAppLaunchContextClass;
47 typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
48 
49 /**
50  * GAppInfo:
51  *
52  * Information about an installed application and methods to launch
53  * it (with file arguments).
54  */
55 
56 /**
57  * GAppInfoIface:
58  * @g_iface: The parent interface.
59  * @dup: Copies a #GAppInfo.
60  * @equal: Checks two #GAppInfo<!-- -->s for equality.
61  * @get_id: Gets a string identifier for a #GAppInfo.
62  * @get_name: Gets the name of the application for a #GAppInfo.
63  * @get_description: Gets a short description for the application described by the #GAppInfo.
64  * @get_executable: Gets the execuable name for the #GAppInfo.
65  * @get_icon: Gets the #GIcon for the #GAppInfo.
66  * @launch: Launches an application specified by the #GAppInfo.
67  * @supports_uris: Indicates whether the application specified supports launching URIs.
68  * @supports_files: Indicates whether the application specified accepts filename arguments.
69  * @launch_uris: Launches an application with a list of URIs.
70  * @should_show: Returns whether an application should be shown (e.g. when getting a list of installed applications).
71  * <ulink url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
72  * <citetitle>FreeDesktop.Org Startup Notification Specification</citetitle></ulink>.
73  * @set_as_default_for_type: Sets an application as default for a given content type.
74  * @set_as_default_for_extension: Sets an application as default for a given file extention.
75  * @add_supports_type: Adds to the #GAppInfo information about supported file types.
76  * @can_remove_supports_type: Checks for support for removing supported file types from a #GAppInfo.
77  * @remove_supports_type: Removes a supported application type from a #GAppInfo.
78  * @can_delete: Checks if a #GAppInfo can be deleted. Since 2.20
79  * @do_delete: Deletes a #GAppInfo. Since 2.20
80  * @get_commandline: Gets the commandline for the #GAppInfo. Since 2.20
81  *
82  * Application Information interface, for operating system portability.
83  */
84 typedef struct _GAppInfoIface    GAppInfoIface;
85 
86 struct _GAppInfoIface
87 {
88   GTypeInterface g_iface;
89 
90   /* Virtual Table */
91 
92   GAppInfo *   (* dup)                          (GAppInfo           *appinfo);
93   gboolean     (* equal)                        (GAppInfo           *appinfo1,
94                                                  GAppInfo           *appinfo2);
95   const char * (* get_id)                       (GAppInfo           *appinfo);
96   const char * (* get_name)                     (GAppInfo           *appinfo);
97   const char * (* get_description)              (GAppInfo           *appinfo);
98   const char * (* get_executable)               (GAppInfo           *appinfo);
99   GIcon *      (* get_icon)                     (GAppInfo           *appinfo);
100   gboolean     (* launch)                       (GAppInfo           *appinfo,
101                                                  GList              *filenames,
102                                                  GAppLaunchContext  *launch_context,
103                                                  GError            **error);
104   gboolean     (* supports_uris)                (GAppInfo           *appinfo);
105   gboolean     (* supports_files)               (GAppInfo           *appinfo);
106   gboolean     (* launch_uris)                  (GAppInfo           *appinfo,
107                                                  GList              *uris,
108                                                  GAppLaunchContext  *launch_context,
109                                                  GError            **error);
110   gboolean     (* should_show)                  (GAppInfo           *appinfo);
111 
112   /* For changing associations */
113   gboolean     (* set_as_default_for_type)      (GAppInfo           *appinfo,
114                                                  const char         *content_type,
115                                                  GError            **error);
116   gboolean     (* set_as_default_for_extension) (GAppInfo           *appinfo,
117                                                  const char         *extension,
118                                                  GError            **error);
119   gboolean     (* add_supports_type)            (GAppInfo           *appinfo,
120                                                  const char         *content_type,
121                                                  GError            **error);
122   gboolean     (* can_remove_supports_type)     (GAppInfo           *appinfo);
123   gboolean     (* remove_supports_type)         (GAppInfo           *appinfo,
124                                                  const char         *content_type,
125                                                  GError            **error);
126   gboolean     (* can_delete)                   (GAppInfo           *appinfo);
127   gboolean     (* do_delete)                    (GAppInfo           *appinfo);
128   const char * (* get_commandline)              (GAppInfo           *appinfo);
129 };
130 
131 GType       g_app_info_get_type                     (void) G_GNUC_CONST;
132 GAppInfo *  g_app_info_create_from_commandline      (const char           *commandline,
133 						     const char           *application_name,
134 						     GAppInfoCreateFlags   flags,
135 						     GError              **error);
136 GAppInfo *  g_app_info_dup                          (GAppInfo             *appinfo);
137 gboolean    g_app_info_equal                        (GAppInfo             *appinfo1,
138 						     GAppInfo             *appinfo2);
139 const char *g_app_info_get_id                       (GAppInfo             *appinfo);
140 const char *g_app_info_get_name                     (GAppInfo             *appinfo);
141 const char *g_app_info_get_description              (GAppInfo             *appinfo);
142 const char *g_app_info_get_executable               (GAppInfo             *appinfo);
143 const char *g_app_info_get_commandline              (GAppInfo             *appinfo);
144 GIcon *     g_app_info_get_icon                     (GAppInfo             *appinfo);
145 gboolean    g_app_info_launch                       (GAppInfo             *appinfo,
146 						     GList                *files,
147 						     GAppLaunchContext    *launch_context,
148 						     GError              **error);
149 gboolean    g_app_info_supports_uris                (GAppInfo             *appinfo);
150 gboolean    g_app_info_supports_files               (GAppInfo             *appinfo);
151 gboolean    g_app_info_launch_uris                  (GAppInfo             *appinfo,
152 						     GList                *uris,
153 						     GAppLaunchContext    *launch_context,
154 						     GError              **error);
155 gboolean    g_app_info_should_show                  (GAppInfo             *appinfo);
156 
157 gboolean    g_app_info_set_as_default_for_type      (GAppInfo             *appinfo,
158 						     const char           *content_type,
159 						     GError              **error);
160 gboolean    g_app_info_set_as_default_for_extension (GAppInfo             *appinfo,
161 						     const char           *extension,
162 						     GError              **error);
163 gboolean    g_app_info_add_supports_type            (GAppInfo             *appinfo,
164 						     const char           *content_type,
165 						     GError              **error);
166 gboolean    g_app_info_can_remove_supports_type     (GAppInfo             *appinfo);
167 gboolean    g_app_info_remove_supports_type         (GAppInfo             *appinfo,
168 						     const char           *content_type,
169 						     GError              **error);
170 gboolean    g_app_info_can_delete                   (GAppInfo   *appinfo);
171 gboolean    g_app_info_delete                       (GAppInfo   *appinfo);
172 
173 GList *   g_app_info_get_all                     (void);
174 GList *   g_app_info_get_all_for_type            (const char  *content_type);
175 void      g_app_info_reset_type_associations     (const char  *content_type);
176 GAppInfo *g_app_info_get_default_for_type        (const char  *content_type,
177 						  gboolean     must_support_uris);
178 GAppInfo *g_app_info_get_default_for_uri_scheme  (const char  *uri_scheme);
179 
180 gboolean  g_app_info_launch_default_for_uri      (const char              *uri,
181 					          GAppLaunchContext       *launch_context,
182 					          GError                 **error);
183 
184 /**
185  * GAppLaunchContext:
186  * @parent_instance: The parent instance.
187  *
188  * Integrating the launch with the launching application. This is used to
189  * handle for instance startup notification and launching the new application
190  * on the same screen as the launching window.
191  */
192 struct _GAppLaunchContext
193 {
194   GObject parent_instance;
195 
196   /*< private >*/
197   GAppLaunchContextPrivate *priv;
198 };
199 
200 struct _GAppLaunchContextClass
201 {
202   GObjectClass parent_class;
203 
204   char * (* get_display)           (GAppLaunchContext *context,
205                                     GAppInfo          *info,
206                                     GList             *files);
207   char * (* get_startup_notify_id) (GAppLaunchContext *context,
208                                     GAppInfo          *info,
209                                     GList             *files);
210   void   (* launch_failed)         (GAppLaunchContext *context,
211                                     const char        *startup_notify_id);
212 
213   /* Padding for future expansion */
214   void (*_g_reserved1) (void);
215   void (*_g_reserved2) (void);
216   void (*_g_reserved3) (void);
217   void (*_g_reserved4) (void);
218   void (*_g_reserved5) (void);
219 };
220 
221 GType              g_app_launch_context_get_type              (void) G_GNUC_CONST;
222 GAppLaunchContext *g_app_launch_context_new                   (void);
223 char *             g_app_launch_context_get_display           (GAppLaunchContext *context,
224 							       GAppInfo          *info,
225 							       GList             *files);
226 char *             g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
227 							       GAppInfo          *info,
228 							       GList             *files);
229 void               g_app_launch_context_launch_failed         (GAppLaunchContext *context,
230 							       const char *       startup_notify_id);
231 
232 G_END_DECLS
233 
234 #endif /* __G_APP_INFO_H__ */
235