gio/gappinfo.h

   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  *
  79  * Application Information interface, for operating system portability.
  80  */
  81 typedef struct _GAppInfoIface    GAppInfoIface;
  82
  83 struct _GAppInfoIface
  84 {
  85   GTypeInterface g_iface;
  86
  87   /* Virtual Table */
  88
  89   GAppInfo *          (*dup)                (GAppInfo                *appinfo);
  90   gboolean            (*equal)              (GAppInfo                *appinfo1,
  91                                              GAppInfo                *appinfo2);
  92   const char *        (*get_id)             (GAppInfo                *appinfo);
  93   const char *        (*get_name)           (GAppInfo                *appinfo);
  94   const char *        (*get_description)    (GAppInfo                *appinfo);
  95   const char *        (*get_executable)     (GAppInfo                *appinfo);
  96   GIcon *             (*get_icon)           (GAppInfo                *appinfo);
  97   gboolean            (*launch)             (GAppInfo                *appinfo,
  98                                              GList                   *filenames,
  99                                              GAppLaunchContext       *launch_context,
 100                                              GError                 **error);
 101   gboolean            (*supports_uris)      (GAppInfo                *appinfo);
 102   gboolean            (*supports_files)     (GAppInfo                *appinfo);
 103   gboolean            (*launch_uris)        (GAppInfo                *appinfo,
 104                                              GList                   *uris,
 105                                              GAppLaunchContext       *launch_context,
 106                                              GError                 **error);
 107   gboolean            (*should_show)        (GAppInfo                *appinfo);
 108
 109   /* For changing associations */
 110   gboolean  (*set_as_default_for_type)      (GAppInfo           *appinfo,
 111                                              const char         *content_type,
 112                                              GError            **error);
 113   gboolean  (*set_as_default_for_extension) (GAppInfo           *appinfo,
 114                                              const char         *extension,
 115                                              GError            **error);
 116   gboolean  (*add_supports_type)            (GAppInfo           *appinfo,
 117                                              const char         *content_type,
 118                                              GError            **error);
 119   gboolean  (*can_remove_supports_type)     (GAppInfo           *appinfo);
 120   gboolean  (*remove_supports_type)         (GAppInfo           *appinfo,
 121                                              const char         *content_type,
 122                                              GError            **error);
 123 };
 124
 125 GType g_app_info_get_type (void) G_GNUC_CONST;
 126 GType g_app_launch_context_get_type (void) G_GNUC_CONST;
 127
 128 GAppInfo *  g_app_info_create_from_commandline      (const char           *commandline,
 129                                                      const char           *application_name,
 130                                                      GAppInfoCreateFlags   flags,
 131                                                      GError              **error);
 132 GAppInfo *  g_app_info_dup                          (GAppInfo             *appinfo);
 133 gboolean    g_app_info_equal                        (GAppInfo             *appinfo1,
 134                                                      GAppInfo             *appinfo2);
 135 const char *g_app_info_get_id                       (GAppInfo             *appinfo);
 136 const char *g_app_info_get_name                     (GAppInfo             *appinfo);
 137 const char *g_app_info_get_description              (GAppInfo             *appinfo);
 138 const char *g_app_info_get_executable               (GAppInfo             *appinfo);
 139 GIcon *     g_app_info_get_icon                     (GAppInfo             *appinfo);
 140 gboolean    g_app_info_launch                       (GAppInfo             *appinfo,
 141                                                      GList                *files,
 142                                                      GAppLaunchContext    *launch_context,
 143                                                      GError              **error);
 144 gboolean    g_app_info_supports_uris                (GAppInfo             *appinfo);
 145 gboolean    g_app_info_supports_files               (GAppInfo             *appinfo);
 146 gboolean    g_app_info_launch_uris                  (GAppInfo             *appinfo,
 147                                                      GList                *uris,
 148                                                      GAppLaunchContext    *launch_context,
 149                                                      GError              **error);
 150 gboolean    g_app_info_should_show                  (GAppInfo             *appinfo);
 151
 152 gboolean    g_app_info_set_as_default_for_type      (GAppInfo             *appinfo,
 153                                                      const char           *content_type,
 154                                                      GError              **error);
 155 gboolean    g_app_info_set_as_default_for_extension (GAppInfo             *appinfo,
 156                                                      const char           *extension,
 157                                                      GError              **error);
 158 gboolean    g_app_info_add_supports_type            (GAppInfo             *appinfo,
 159                                                      const char           *content_type,
 160                                                      GError              **error);
 161 gboolean    g_app_info_can_remove_supports_type     (GAppInfo             *appinfo);
 162 gboolean    g_app_info_remove_supports_type         (GAppInfo             *appinfo,
 163                                                      const char           *content_type,
 164                                                      GError              **error);
 165
 166 GList *   g_app_info_get_all                     (void);
 167 GList *   g_app_info_get_all_for_type            (const char  *content_type);
 168 GAppInfo *g_app_info_get_default_for_type        (const char  *content_type,
 169                                                   gboolean     must_support_uris);
 170 GAppInfo *g_app_info_get_default_for_uri_scheme  (const char  *uri_scheme);
 171
 172 gboolean  g_app_info_launch_default_for_uri      (const char              *uri,
 173                                                   GAppLaunchContext       *launch_context,
 174                                                   GError                 **error);
 175
 176 /**
 177  * GAppLaunchContext:
 178  * @parent_instance: The parent instance.
 179  *
 180  * Integrating the launch with the launching application. This is used to
 181  * handle for instance startup notification and launching the new application
 182  * on the same screen as the launching window.
 183  */
 184 struct _GAppLaunchContext
 185 {
 186   GObject parent_instance;
 187
 188   /*< private >*/
 189   GAppLaunchContextPrivate *priv;
 190 };
 191
 192 struct _GAppLaunchContextClass
 193 {
 194   GObjectClass parent_class;
 195
 196   char * (*get_display)           (GAppLaunchContext *context,
 197                                    GAppInfo *info,
 198                                    GList *files);
 199   char * (*get_startup_notify_id) (GAppLaunchContext *context,
 200                                    GAppInfo *info,
 201                                    GList *files);
 202   void   (*launch_failed)         (GAppLaunchContext *context,
 203                                    const char *startup_notify_id);
 204
 205   /* Padding for future expansion */
 206   void (*_g_reserved1) (void);
 207   void (*_g_reserved2) (void);
 208   void (*_g_reserved3) (void);
 209   void (*_g_reserved4) (void);
 210   void (*_g_reserved5) (void);
 211 };
 212
 213 GAppLaunchContext *g_app_launch_context_new                   (void);
 214 char *             g_app_launch_context_get_display           (GAppLaunchContext *context,
 215                                                                GAppInfo          *info,
 216                                                                GList             *files);
 217 char *             g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
 218                                                                GAppInfo          *info,
 219                                                                GList             *files);
 220 void               g_app_launch_context_launch_failed         (GAppLaunchContext *context,
 221                                                                const char *       startup_notify_id);
 222
 223 G_END_DECLS
 224
 225 #endif /* __G_APP_INFO_H__ */