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 #ifndef __G_APP_INFO_H__
  24 #define __G_APP_INFO_H__
  25
  26 #include <glib-object.h>
  27 #include <gio/gicon.h>
  28
  29 G_BEGIN_DECLS
  30
  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))
  35
  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))
  42
  43 /**
  44  * GAppInfoCreateFlags:
  45  * @G_APP_INFO_CREATE_FLAGS_NONE: No flags.
  46  * @G_APP_INFO_CREATE_NEEDS_TERMINAL: Application opens with a terminal window.
  47  *
  48  * Flags used when creating a #GAppInfo.
  49  */
  50 typedef enum {
  51   G_APP_INFO_CREATE_FLAGS_NONE = 0,           /*< nick=none >*/
  52   G_APP_INFO_CREATE_NEEDS_TERMINAL = (1<<0)   /*< nick=needs-terminal >*/
  53 } GAppInfoCreateFlags;
  54
  55 typedef struct _GAppLaunchContext        GAppLaunchContext;
  56 typedef struct _GAppLaunchContextClass   GAppLaunchContextClass;
  57 typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
  58
  59 /**
  60  * GAppInfo:
  61  *
  62  * Information about an installed application.
  63  */
  64 typedef struct _GAppInfo         GAppInfo; /* Dummy typedef */
  65
  66 /**
  67  * GAppInfoIface:
  68  * @g_iface: The parent interface.
  69  * @dup: Copies a #GAppInfo.
  70  * @equal: Checks two #GAppInfo<!-- -->s for equality.
  71  * @get_id: Gets a string identifier for a #GAppInfo.
  72  * @get_name: Gets the name of the application for a #GAppInfo.
  73  * @get_description: Gets a short description for the application described by the #GAppInfo.
  74  * @get_executable: Gets the execuable name for the #GAppInfo.
  75  * @get_icon: Gets the #GIcon for the #GAppInfo.
  76  * @launch: Launches an application specified by the #GAppInfo.
  77  * @supports_uris: Indicates whether the application specified supports launching URIs.
  78  * @launch_uris: Launches an application with a list of URIs.
  79  * @should_show: Returns whether an application should be shown (e.g. when getting a list of installed applications).
  80  * @supports_xdg_startup_notify: Indicates whether the application supports the
  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.
  88  *
  89  * Application Information interface, for operating system portability.
  90  */
  91 typedef struct _GAppInfoIface    GAppInfoIface;
  92
  93 struct _GAppInfoIface
  94 {
  95   GTypeInterface g_iface;
  96
  97   /* Virtual Table */
  98
  99   GAppInfo *          (*dup)                (GAppInfo                *appinfo);
 100   gboolean            (*equal)              (GAppInfo                *appinfo1,
 101                                              GAppInfo                *appinfo2);
 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,
 108                                              GList                   *filenames,
 109                                              GAppLaunchContext       *launch_context,
 110                                              GError                 **error);
 111   gboolean            (*supports_uris)      (GAppInfo                *appinfo);
 112   gboolean            (*launch_uris)        (GAppInfo                *appinfo,
 113                                              GList                   *uris,
 114                                              GAppLaunchContext       *launch_context,
 115                                              GError                 **error);
 116   gboolean            (*should_show)        (GAppInfo                *appinfo,
 117                                              const char              *desktop_env);
 118   gboolean            (*supports_xdg_startup_notify) (GAppInfo       *appinfo);
 119
 120
 121   /* For changing associations */
 122   gboolean  (*set_as_default_for_type)      (GAppInfo           *appinfo,
 123                                              const char         *content_type,
 124                                              GError            **error);
 125   gboolean  (*set_as_default_for_extension) (GAppInfo           *appinfo,
 126                                              const char         *extension,
 127                                              GError            **error);
 128   gboolean  (*add_supports_type)            (GAppInfo           *appinfo,
 129                                              const char         *content_type,
 130                                              GError            **error);
 131   gboolean  (*can_remove_supports_type)     (GAppInfo           *appinfo);
 132   gboolean  (*remove_supports_type)         (GAppInfo           *appinfo,
 133                                              const char         *content_type,
 134                                              GError            **error);
 135   /*< private >*/
 136   /* Padding for future expansion */
 137   void (*_g_reserved1) (void);
 138   void (*_g_reserved2) (void);
 139   void (*_g_reserved3) (void);
 140   void (*_g_reserved4) (void);
 141   void (*_g_reserved5) (void);
 142   void (*_g_reserved6) (void);
 143   void (*_g_reserved7) (void);
 144   void (*_g_reserved8) (void);
 145   void (*_g_reserved9) (void);
 146   void (*_g_reserved10) (void);
 147 };
 148
 149 GType g_app_info_get_type (void) G_GNUC_CONST;
 150 GType g_app_launch_context_get_type (void) G_GNUC_CONST;
 151
 152 GAppInfo *  g_app_info_create_from_commandline      (const char           *commandline,
 153                                                      const char           *application_name,
 154                                                      GAppInfoCreateFlags   flags,
 155                                                      GError              **error);
 156 GAppInfo *  g_app_info_dup                          (GAppInfo             *appinfo);
 157 gboolean    g_app_info_equal                        (GAppInfo             *appinfo1,
 158                                                      GAppInfo             *appinfo2);
 159 const char *g_app_info_get_id                       (GAppInfo             *appinfo);
 160 const char *g_app_info_get_name                     (GAppInfo             *appinfo);
 161 const char *g_app_info_get_description              (GAppInfo             *appinfo);
 162 const char *g_app_info_get_executable               (GAppInfo             *appinfo);
 163 GIcon *     g_app_info_get_icon                     (GAppInfo             *appinfo);
 164 gboolean    g_app_info_launch                       (GAppInfo             *appinfo,
 165                                                      GList                *files,
 166                                                      GAppLaunchContext    *launch_context,
 167                                                      GError              **error);
 168 gboolean    g_app_info_supports_uris                (GAppInfo             *appinfo);
 169 gboolean    g_app_info_launch_uris                  (GAppInfo             *appinfo,
 170                                                      GList                *uris,
 171                                                      GAppLaunchContext    *launch_context,
 172                                                      GError              **error);
 173 gboolean    g_app_info_should_show                  (GAppInfo             *appinfo,
 174                                                      const char           *desktop_env);
 175
 176 gboolean    g_app_info_set_as_default_for_type      (GAppInfo             *appinfo,
 177                                                      const char           *content_type,
 178                                                      GError              **error);
 179 gboolean    g_app_info_set_as_default_for_extension (GAppInfo             *appinfo,
 180                                                      const char           *extension,
 181                                                      GError              **error);
 182 gboolean    g_app_info_add_supports_type            (GAppInfo             *appinfo,
 183                                                      const char           *content_type,
 184                                                      GError              **error);
 185 gboolean    g_app_info_can_remove_supports_type     (GAppInfo             *appinfo);
 186 gboolean    g_app_info_remove_supports_type         (GAppInfo             *appinfo,
 187                                                      const char           *content_type,
 188                                                      GError              **error);
 189
 190 GList *   g_app_info_get_all                     (void);
 191 GList *   g_app_info_get_all_for_type            (const char  *content_type);
 192 GAppInfo *g_app_info_get_default_for_type        (const char  *content_type,
 193                                                   gboolean     must_support_uris);
 194 GAppInfo *g_app_info_get_default_for_uri_scheme  (const char  *uri_scheme);
 195
 196 /* TODO: missing operations:
 197    add app as supporting a content type, but don't make it default
 198    implement set_as_default_for_extension
 199
 200    can_remove, remove (as in, don't support a specific mimetype)
 201 */
 202
 203 /**
 204  * GAppLaunchContext:
 205  * @parent_instance: The parent instance.
 206  *
 207  * Gets feedback from the system when launching an application.
 208  */
 209 struct _GAppLaunchContext
 210 {
 211   GObject parent_instance;
 212
 213   /*< private >*/
 214   GAppLaunchContextPrivate *priv;
 215 };
 216
 217 struct _GAppLaunchContextClass
 218 {
 219   GObjectClass parent_class;
 220
 221   char * (*get_display)           (GAppLaunchContext *context,
 222                                    GAppInfo *info,
 223                                    GList *files);
 224   char * (*get_startup_notify_id) (GAppLaunchContext *context,
 225                                    GAppInfo *info,
 226                                    GList *files);
 227   void   (*launch_failed)         (GAppLaunchContext *context,
 228                                    const char *startup_notify_id);
 229
 230   /* Padding for future expansion */
 231   void (*_g_reserved1) (void);
 232   void (*_g_reserved2) (void);
 233   void (*_g_reserved3) (void);
 234   void (*_g_reserved4) (void);
 235   void (*_g_reserved5) (void);
 236 };
 237
 238 GAppLaunchContext *g_app_launch_context_new                   (void);
 239 char *             g_app_launch_context_get_display           (GAppLaunchContext *context,
 240                                                                GAppInfo          *info,
 241                                                                GList             *files);
 242 char *             g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
 243                                                                GAppInfo          *info,
 244                                                                GList             *files);
 245 void               g_app_launch_context_launch_failed         (GAppLaunchContext *context,
 246                                                                const char *       startup_notify_id);
 247
 248 G_END_DECLS
 249
 250 #endif /* __G_APP_INFO_H__ */