gappinfo.h 17 KB
Newer Older
1
/* GIO - GLib Input, Output and Streaming Library
2
 *
3 4 5 6 7
 * Copyright (C) 2006-2007 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
8
 * version 2.1 of the License, or (at your option) any later version.
9 10 11 12 13 14 15
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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/>.
17 18 19 20
 *
 * Author: Alexander Larsson <alexl@redhat.com>
 */

21 22 23
#ifndef __G_APP_INFO_H__
#define __G_APP_INFO_H__

24 25 26 27
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif

28
#include <gio/giotypes.h>
29 30 31 32 33

G_BEGIN_DECLS

#define G_TYPE_APP_INFO            (g_app_info_get_type ())
#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 36 37 38 39 40 41 42 43 44 45 46
#define G_APP_INFO_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_APP_INFO, GAppInfoIface))

#define G_TYPE_APP_LAUNCH_CONTEXT         (g_app_launch_context_get_type ())
#define G_APP_LAUNCH_CONTEXT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContext))
#define G_APP_LAUNCH_CONTEXT_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
#define G_IS_APP_LAUNCH_CONTEXT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_APP_LAUNCH_CONTEXT))
#define G_IS_APP_LAUNCH_CONTEXT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_APP_LAUNCH_CONTEXT))
#define G_APP_LAUNCH_CONTEXT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))

typedef struct _GAppLaunchContextClass   GAppLaunchContextClass;
typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;

47 48
/**
 * GAppInfo:
49
 *
50 51
 * Information about an installed application and methods to launch
 * it (with file arguments).
52 53 54 55 56 57
 */

/**
 * GAppInfoIface:
 * @g_iface: The parent interface.
 * @dup: Copies a #GAppInfo.
58
 * @equal: Checks two #GAppInfos for equality.
59 60 61
 * @get_id: Gets a string identifier for a #GAppInfo.
 * @get_name: Gets the name of the application for a #GAppInfo.
 * @get_description: Gets a short description for the application described by the #GAppInfo.
62
 * @get_executable: Gets the executable name for the #GAppInfo.
63 64 65
 * @get_icon: Gets the #GIcon for the #GAppInfo.
 * @launch: Launches an application specified by the #GAppInfo.
 * @supports_uris: Indicates whether the application specified supports launching URIs.
66
 * @supports_files: Indicates whether the application specified accepts filename arguments.
67 68
 * @launch_uris: Launches an application with a list of URIs.
 * @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 73 74
 * @add_supports_type: Adds to the #GAppInfo information about supported file types.
 * @can_remove_supports_type: Checks for support for removing supported file types from a #GAppInfo.
 * @remove_supports_type: Removes a supported application type from a #GAppInfo.
75 76
 * @can_delete: Checks if a #GAppInfo can be deleted. Since 2.20
 * @do_delete: Deletes a #GAppInfo. Since 2.20
Matthias Clasen's avatar
Matthias Clasen committed
77
 * @get_commandline: Gets the commandline for the #GAppInfo. Since 2.20
Matthias Clasen's avatar
Matthias Clasen committed
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
 *
82 83
 * Application Information interface, for operating system portability.
 */
84 85 86 87 88 89 90 91
typedef struct _GAppInfoIface    GAppInfoIface;

struct _GAppInfoIface
{
  GTypeInterface g_iface;

  /* Virtual Table */

92 93 94 95 96 97 98 99 100
  GAppInfo *   (* dup)                          (GAppInfo           *appinfo);
  gboolean     (* equal)                        (GAppInfo           *appinfo1,
                                                 GAppInfo           *appinfo2);
  const char * (* get_id)                       (GAppInfo           *appinfo);
  const char * (* get_name)                     (GAppInfo           *appinfo);
  const char * (* get_description)              (GAppInfo           *appinfo);
  const char * (* get_executable)               (GAppInfo           *appinfo);
  GIcon *      (* get_icon)                     (GAppInfo           *appinfo);
  gboolean     (* launch)                       (GAppInfo           *appinfo,
101
                                                 GList              *files,
102
                                                 GAppLaunchContext  *context,
103 104 105 106 107
                                                 GError            **error);
  gboolean     (* supports_uris)                (GAppInfo           *appinfo);
  gboolean     (* supports_files)               (GAppInfo           *appinfo);
  gboolean     (* launch_uris)                  (GAppInfo           *appinfo,
                                                 GList              *uris,
108
                                                 GAppLaunchContext  *context,
109 110
                                                 GError            **error);
  gboolean     (* should_show)                  (GAppInfo           *appinfo);
111 112

  /* For changing associations */
113 114 115 116 117 118 119 120 121 122 123 124 125
  gboolean     (* set_as_default_for_type)      (GAppInfo           *appinfo,
                                                 const char         *content_type,
                                                 GError            **error);
  gboolean     (* set_as_default_for_extension) (GAppInfo           *appinfo,
                                                 const char         *extension,
                                                 GError            **error);
  gboolean     (* add_supports_type)            (GAppInfo           *appinfo,
                                                 const char         *content_type,
                                                 GError            **error);
  gboolean     (* can_remove_supports_type)     (GAppInfo           *appinfo);
  gboolean     (* remove_supports_type)         (GAppInfo           *appinfo,
                                                 const char         *content_type,
                                                 GError            **error);
126 127
  gboolean     (* can_delete)                   (GAppInfo           *appinfo);
  gboolean     (* do_delete)                    (GAppInfo           *appinfo);
128
  const char * (* get_commandline)              (GAppInfo           *appinfo);
129
  const char * (* get_display_name)             (GAppInfo           *appinfo);
130 131 132
  gboolean     (* set_as_last_used_for_type)    (GAppInfo           *appinfo,
                                                 const char         *content_type,
                                                 GError            **error);
133
  const char ** (* get_supported_types)         (GAppInfo           *appinfo);
134 135
};

136
GLIB_AVAILABLE_IN_ALL
137
GType       g_app_info_get_type                     (void) G_GNUC_CONST;
138
GLIB_AVAILABLE_IN_ALL
139
GAppInfo *  g_app_info_create_from_commandline      (const char           *commandline,
140 141 142
                                                     const char           *application_name,
                                                     GAppInfoCreateFlags   flags,
                                                     GError              **error);
143
GLIB_AVAILABLE_IN_ALL
144
GAppInfo *  g_app_info_dup                          (GAppInfo             *appinfo);
145
GLIB_AVAILABLE_IN_ALL
146
gboolean    g_app_info_equal                        (GAppInfo             *appinfo1,
147
                                                     GAppInfo             *appinfo2);
148
GLIB_AVAILABLE_IN_ALL
149
const char *g_app_info_get_id                       (GAppInfo             *appinfo);
150
GLIB_AVAILABLE_IN_ALL
151
const char *g_app_info_get_name                     (GAppInfo             *appinfo);
152
GLIB_AVAILABLE_IN_ALL
153
const char *g_app_info_get_display_name             (GAppInfo             *appinfo);
154
GLIB_AVAILABLE_IN_ALL
155
const char *g_app_info_get_description              (GAppInfo             *appinfo);
156
GLIB_AVAILABLE_IN_ALL
157
const char *g_app_info_get_executable               (GAppInfo             *appinfo);
158
GLIB_AVAILABLE_IN_ALL
159
const char *g_app_info_get_commandline              (GAppInfo             *appinfo);
160
GLIB_AVAILABLE_IN_ALL
161
GIcon *     g_app_info_get_icon                     (GAppInfo             *appinfo);
162
GLIB_AVAILABLE_IN_ALL
163
gboolean    g_app_info_launch                       (GAppInfo             *appinfo,
164
                                                     GList                *files,
165
                                                     GAppLaunchContext    *context,
166
                                                     GError              **error);
167
GLIB_AVAILABLE_IN_ALL
168
gboolean    g_app_info_supports_uris                (GAppInfo             *appinfo);
169
GLIB_AVAILABLE_IN_ALL
170
gboolean    g_app_info_supports_files               (GAppInfo             *appinfo);
171
GLIB_AVAILABLE_IN_ALL
172
gboolean    g_app_info_launch_uris                  (GAppInfo             *appinfo,
173
                                                     GList                *uris,
174
                                                     GAppLaunchContext    *context,
175
                                                     GError              **error);
176
GLIB_AVAILABLE_IN_ALL
177
gboolean    g_app_info_should_show                  (GAppInfo             *appinfo);
178

179
GLIB_AVAILABLE_IN_ALL
180
gboolean    g_app_info_set_as_default_for_type      (GAppInfo             *appinfo,
181 182
                                                     const char           *content_type,
                                                     GError              **error);
183
GLIB_AVAILABLE_IN_ALL
184
gboolean    g_app_info_set_as_default_for_extension (GAppInfo             *appinfo,
185 186
                                                     const char           *extension,
                                                     GError              **error);
187
GLIB_AVAILABLE_IN_ALL
188
gboolean    g_app_info_add_supports_type            (GAppInfo             *appinfo,
189 190
                                                     const char           *content_type,
                                                     GError              **error);
191
GLIB_AVAILABLE_IN_ALL
192
gboolean    g_app_info_can_remove_supports_type     (GAppInfo             *appinfo);
193
GLIB_AVAILABLE_IN_ALL
194
gboolean    g_app_info_remove_supports_type         (GAppInfo             *appinfo,
195 196
                                                     const char           *content_type,
                                                     GError              **error);
197 198 199
GLIB_AVAILABLE_IN_2_34
const char **g_app_info_get_supported_types         (GAppInfo             *appinfo);

200
GLIB_AVAILABLE_IN_ALL
201
gboolean    g_app_info_can_delete                   (GAppInfo   *appinfo);
202
GLIB_AVAILABLE_IN_ALL
203
gboolean    g_app_info_delete                       (GAppInfo   *appinfo);
204

205
GLIB_AVAILABLE_IN_ALL
206
gboolean    g_app_info_set_as_last_used_for_type    (GAppInfo             *appinfo,
207 208
                                                     const char           *content_type,
                                                     GError              **error);
209

210
GLIB_AVAILABLE_IN_ALL
211
GList *   g_app_info_get_all                     (void);
212
GLIB_AVAILABLE_IN_ALL
213
GList *   g_app_info_get_all_for_type            (const char  *content_type);
214
GLIB_AVAILABLE_IN_ALL
215
GList *   g_app_info_get_recommended_for_type    (const gchar *content_type);
216
GLIB_AVAILABLE_IN_ALL
217 218
GList *   g_app_info_get_fallback_for_type       (const gchar *content_type);

219
GLIB_AVAILABLE_IN_ALL
220
void      g_app_info_reset_type_associations     (const char  *content_type);
221
GLIB_AVAILABLE_IN_ALL
222
GAppInfo *g_app_info_get_default_for_type        (const char  *content_type,
223
                                                  gboolean     must_support_uris);
224
GLIB_AVAILABLE_IN_ALL
225 226
GAppInfo *g_app_info_get_default_for_uri_scheme  (const char  *uri_scheme);

227
GLIB_AVAILABLE_IN_ALL
228
gboolean  g_app_info_launch_default_for_uri      (const char              *uri,
229
                                                  GAppLaunchContext       *context,
230
                                                  GError                 **error);
231

232 233
GLIB_AVAILABLE_IN_2_50
void      g_app_info_launch_default_for_uri_async  (const char           *uri,
234
                                                    GAppLaunchContext    *context,
235 236 237 238 239 240 241 242
                                                    GCancellable         *cancellable,
                                                    GAsyncReadyCallback   callback,
                                                    gpointer              user_data);
GLIB_AVAILABLE_IN_2_50
gboolean  g_app_info_launch_default_for_uri_finish (GAsyncResult         *result,
                                                    GError              **error);


243 244
/**
 * GAppLaunchContext:
245
 *
246 247 248
 * Integrating the launch with the launching application. This is used to
 * handle for instance startup notification and launching the new application
 * on the same screen as the launching window.
249
 */
250 251 252 253
struct _GAppLaunchContext
{
  GObject parent_instance;

254
  /*< private >*/
255 256 257 258 259 260 261
  GAppLaunchContextPrivate *priv;
};

struct _GAppLaunchContextClass
{
  GObjectClass parent_class;

262 263 264 265 266 267 268 269
  char * (* get_display)           (GAppLaunchContext *context,
                                    GAppInfo          *info,
                                    GList             *files);
  char * (* get_startup_notify_id) (GAppLaunchContext *context,
                                    GAppInfo          *info,
                                    GList             *files);
  void   (* launch_failed)         (GAppLaunchContext *context,
                                    const char        *startup_notify_id);
270 271 272
  void   (* launched)              (GAppLaunchContext *context,
                                    GAppInfo          *info,
                                    GVariant          *platform_data);
273 274 275 276 277 278 279 280

  /* Padding for future expansion */
  void (*_g_reserved1) (void);
  void (*_g_reserved2) (void);
  void (*_g_reserved3) (void);
  void (*_g_reserved4) (void);
};

281
GLIB_AVAILABLE_IN_ALL
282
GType              g_app_launch_context_get_type              (void) G_GNUC_CONST;
283
GLIB_AVAILABLE_IN_ALL
284
GAppLaunchContext *g_app_launch_context_new                   (void);
285

286
GLIB_AVAILABLE_IN_2_32
287 288 289
void               g_app_launch_context_setenv                (GAppLaunchContext *context,
                                                               const char        *variable,
                                                               const char        *value);
290
GLIB_AVAILABLE_IN_2_32
291 292
void               g_app_launch_context_unsetenv              (GAppLaunchContext *context,
                                                               const char        *variable);
293
GLIB_AVAILABLE_IN_2_32
294 295
char **            g_app_launch_context_get_environment       (GAppLaunchContext *context);

296
GLIB_AVAILABLE_IN_ALL
297
char *             g_app_launch_context_get_display           (GAppLaunchContext *context,
298 299
                                                               GAppInfo          *info,
                                                               GList             *files);
300
GLIB_AVAILABLE_IN_ALL
301
char *             g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
302 303
                                                               GAppInfo          *info,
                                                               GList             *files);
304
GLIB_AVAILABLE_IN_ALL
305
void               g_app_launch_context_launch_failed         (GAppLaunchContext *context,
306
                                                               const char *       startup_notify_id);
307

308 309 310 311 312 313 314 315 316 317 318 319 320 321
#define G_TYPE_APP_INFO_MONITOR                             (g_app_info_monitor_get_type ())
#define G_APP_INFO_MONITOR(inst)                            (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
                                                             G_TYPE_APP_INFO_MONITOR, GAppInfoMonitor))
#define G_IS_APP_INFO_MONITOR(inst)                         (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
                                                             G_TYPE_APP_INFO_MONITOR))

typedef struct _GAppInfoMonitor                             GAppInfoMonitor;

GLIB_AVAILABLE_IN_2_40
GType                   g_app_info_monitor_get_type                     (void);

GLIB_AVAILABLE_IN_2_40
GAppInfoMonitor *       g_app_info_monitor_get                          (void);

322 323 324
G_END_DECLS

#endif /* __G_APP_INFO_H__ */