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 <glib-object.h>
  31 #include <gio/gicon.h>
  32
  33 G_BEGIN_DECLS
  34
  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))
  39
  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))
  46
  47 /**
  48  * GAppInfoCreateFlags:
  49  * @G_APP_INFO_CREATE_FLAGS_NONE: No flags.
  50  * @G_APP_INFO_CREATE_NEEDS_TERMINAL: Application opens in a terminal window.
  51  *
  52  * Flags used when creating a #GAppInfo.
  53  */
  54 typedef enum {
  55   G_APP_INFO_CREATE_FLAGS_NONE = 0,           /*< nick=none >*/
  56   G_APP_INFO_CREATE_NEEDS_TERMINAL = (1<<0)   /*< nick=needs-terminal >*/
  57 } GAppInfoCreateFlags;
  58
  59 typedef struct _GAppLaunchContext        GAppLaunchContext;
  60 typedef struct _GAppLaunchContextClass   GAppLaunchContextClass;
  61 typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
  62
  63 /**
  64  * GAppInfo:
  65  *
  66  * Information about an installed application and methods to launch
  67  * it (with file arguments).
  68  */
  69 typedef struct _GAppInfo         GAppInfo; /* Dummy typedef */
  70
  71 /**
  72  * GAppInfoIface:
  73  * @g_iface: The parent interface.
  74  * @dup: Copies a #GAppInfo.
  75  * @equal: Checks two #GAppInfo<!-- -->s for equality.
  76  * @get_id: Gets a string identifier for a #GAppInfo.
  77  * @get_name: Gets the name of the application for a #GAppInfo.
  78  * @get_description: Gets a short description for the application described by the #GAppInfo.
  79  * @get_executable: Gets the execuable name for the #GAppInfo.
  80  * @get_icon: Gets the #GIcon for the #GAppInfo.
  81  * @launch: Launches an application specified by the #GAppInfo.
  82  * @supports_uris: Indicates whether the application specified supports launching URIs.
  83  * @launch_uris: Launches an application with a list of URIs.
  84  * @should_show: Returns whether an application should be shown (e.g. when getting a list of installed applications).
  85  * <ulink url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
  86  * <citetitle>FreeDesktop.Org Startup Notification Specification</citetitle></ulink>.
  87  * @set_as_default_for_type: Sets an application as default for a given content type.
  88  * @set_as_default_for_extension: Sets an application as default for a given file extention.
  89  * @add_supports_type: Adds to the #GAppInfo information about supported file types.
  90  * @can_remove_supports_type: Checks for support for removing supported file types from a #GAppInfo.
  91  * @remove_supports_type: Removes a supported application type from a #GAppInfo.
  92  *
  93  * Application Information interface, for operating system portability.
  94  */
  95 typedef struct _GAppInfoIface    GAppInfoIface;
  96
  97 struct _GAppInfoIface
  98 {
  99   GTypeInterface g_iface;
 100
 101   /* Virtual Table */
 102
 103   GAppInfo *          (*dup)                (GAppInfo                *appinfo);
 104   gboolean            (*equal)              (GAppInfo                *appinfo1,
 105                                              GAppInfo                *appinfo2);
 106   const char *        (*get_id)             (GAppInfo                *appinfo);
 107   const char *        (*get_name)           (GAppInfo                *appinfo);
 108   const char *        (*get_description)    (GAppInfo                *appinfo);
 109   const char *        (*get_executable)     (GAppInfo                *appinfo);
 110   GIcon *             (*get_icon)           (GAppInfo                *appinfo);
 111   gboolean            (*launch)             (GAppInfo                *appinfo,
 112                                              GList                   *filenames,
 113                                              GAppLaunchContext       *launch_context,
 114                                              GError                 **error);
 115   gboolean            (*supports_uris)      (GAppInfo                *appinfo);
 116   gboolean            (*launch_uris)        (GAppInfo                *appinfo,
 117                                              GList                   *uris,
 118                                              GAppLaunchContext       *launch_context,
 119                                              GError                 **error);
 120   gboolean            (*should_show)        (GAppInfo                *appinfo,
 121                                              const char              *desktop_env);
 122
 123   /* For changing associations */
 124   gboolean  (*set_as_default_for_type)      (GAppInfo           *appinfo,
 125                                              const char         *content_type,
 126                                              GError            **error);
 127   gboolean  (*set_as_default_for_extension) (GAppInfo           *appinfo,
 128                                              const char         *extension,
 129                                              GError            **error);
 130   gboolean  (*add_supports_type)            (GAppInfo           *appinfo,
 131                                              const char         *content_type,
 132                                              GError            **error);
 133   gboolean  (*can_remove_supports_type)     (GAppInfo           *appinfo);
 134   gboolean  (*remove_supports_type)         (GAppInfo           *appinfo,
 135                                              const char         *content_type,
 136                                              GError            **error);
 137 };
 138
 139 GType g_app_info_get_type (void) G_GNUC_CONST;
 140 GType g_app_launch_context_get_type (void) G_GNUC_CONST;
 141
 142 GAppInfo *  g_app_info_create_from_commandline      (const char           *commandline,
 143                                                      const char           *application_name,
 144                                                      GAppInfoCreateFlags   flags,
 145                                                      GError              **error);
 146 GAppInfo *  g_app_info_dup                          (GAppInfo             *appinfo);
 147 gboolean    g_app_info_equal                        (GAppInfo             *appinfo1,
 148                                                      GAppInfo             *appinfo2);
 149 const char *g_app_info_get_id                       (GAppInfo             *appinfo);
 150 const char *g_app_info_get_name                     (GAppInfo             *appinfo);
 151 const char *g_app_info_get_description              (GAppInfo             *appinfo);
 152 const char *g_app_info_get_executable               (GAppInfo             *appinfo);
 153 GIcon *     g_app_info_get_icon                     (GAppInfo             *appinfo);
 154 gboolean    g_app_info_launch                       (GAppInfo             *appinfo,
 155                                                      GList                *files,
 156                                                      GAppLaunchContext    *launch_context,
 157                                                      GError              **error);
 158 gboolean    g_app_info_supports_uris                (GAppInfo             *appinfo);
 159 gboolean    g_app_info_launch_uris                  (GAppInfo             *appinfo,
 160                                                      GList                *uris,
 161                                                      GAppLaunchContext    *launch_context,
 162                                                      GError              **error);
 163 gboolean    g_app_info_should_show                  (GAppInfo             *appinfo,
 164                                                      const char           *desktop_env);
 165
 166 gboolean    g_app_info_set_as_default_for_type      (GAppInfo             *appinfo,
 167                                                      const char           *content_type,
 168                                                      GError              **error);
 169 gboolean    g_app_info_set_as_default_for_extension (GAppInfo             *appinfo,
 170                                                      const char           *extension,
 171                                                      GError              **error);
 172 gboolean    g_app_info_add_supports_type            (GAppInfo             *appinfo,
 173                                                      const char           *content_type,
 174                                                      GError              **error);
 175 gboolean    g_app_info_can_remove_supports_type     (GAppInfo             *appinfo);
 176 gboolean    g_app_info_remove_supports_type         (GAppInfo             *appinfo,
 177                                                      const char           *content_type,
 178                                                      GError              **error);
 179
 180 GList *   g_app_info_get_all                     (void);
 181 GList *   g_app_info_get_all_for_type            (const char  *content_type);
 182 GAppInfo *g_app_info_get_default_for_type        (const char  *content_type,
 183                                                   gboolean     must_support_uris);
 184 GAppInfo *g_app_info_get_default_for_uri_scheme  (const char  *uri_scheme);
 185
 186 /**
 187  * GAppLaunchContext:
 188  * @parent_instance: The parent instance.
 189  *
 190  * Integrating the launch with the launching application. This is used to
 191  * handle for instance startup notification and launching the new application
 192  * on the same screen as the launching window.
 193  */
 194 struct _GAppLaunchContext
 195 {
 196   GObject parent_instance;
 197
 198   /*< private >*/
 199   GAppLaunchContextPrivate *priv;
 200 };
 201
 202 struct _GAppLaunchContextClass
 203 {
 204   GObjectClass parent_class;
 205
 206   char * (*get_display)           (GAppLaunchContext *context,
 207                                    GAppInfo *info,
 208                                    GList *files);
 209   char * (*get_startup_notify_id) (GAppLaunchContext *context,
 210                                    GAppInfo *info,
 211                                    GList *files);
 212   void   (*launch_failed)         (GAppLaunchContext *context,
 213                                    const char *startup_notify_id);
 214
 215   /* Padding for future expansion */
 216   void (*_g_reserved1) (void);
 217   void (*_g_reserved2) (void);
 218   void (*_g_reserved3) (void);
 219   void (*_g_reserved4) (void);
 220   void (*_g_reserved5) (void);
 221 };
 222
 223 GAppLaunchContext *g_app_launch_context_new                   (void);
 224 char *             g_app_launch_context_get_display           (GAppLaunchContext *context,
 225                                                                GAppInfo          *info,
 226                                                                GList             *files);
 227 char *             g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
 228                                                                GAppInfo          *info,
 229                                                                GList             *files);
 230 void               g_app_launch_context_launch_failed         (GAppLaunchContext *context,
 231                                                                const char *       startup_notify_id);
 232
 233 G_END_DECLS
 234
 235 #endif /* __G_APP_INFO_H__ */