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 typedef enum {
  44   G_APP_INFO_CREATE_FLAGS_NONE = 0,
  45   G_APP_INFO_CREATE_NEEDS_TERMINAL = (1<<0)
  46 } GAppInfoCreateFlags;
  47
  48 typedef struct _GAppLaunchContext        GAppLaunchContext;
  49 typedef struct _GAppLaunchContextClass   GAppLaunchContextClass;
  50 typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
  51
  52 typedef struct _GAppInfo         GAppInfo; /* Dummy typedef */
  53 typedef struct _GAppInfoIface    GAppInfoIface;
  54
  55 struct _GAppInfoIface
  56 {
  57   GTypeInterface g_iface;
  58
  59   /* Virtual Table */
  60
  61   GAppInfo *          (*dup)                (GAppInfo                *appinfo);
  62   gboolean            (*equal)              (GAppInfo                *appinfo1,
  63                                              GAppInfo                *appinfo2);
  64   const char *        (*get_id)             (GAppInfo                *appinfo);
  65   const char *        (*get_name)           (GAppInfo                *appinfo);
  66   const char *        (*get_description)    (GAppInfo                *appinfo);
  67   const char *        (*get_executable)     (GAppInfo                *appinfo);
  68   GIcon *             (*get_icon)           (GAppInfo                *appinfo);
  69   gboolean            (*launch)             (GAppInfo                *appinfo,
  70                                              GList                   *filenames,
  71                                              GAppLaunchContext       *launch_context,
  72                                              GError                 **error);
  73   gboolean            (*supports_uris)      (GAppInfo                *appinfo);
  74   gboolean            (*launch_uris)        (GAppInfo                *appinfo,
  75                                              GList                   *uris,
  76                                              GAppLaunchContext       *launch_context,
  77                                              GError                 **error);
  78   gboolean            (*should_show)        (GAppInfo                *appinfo,
  79                                              const char              *desktop_env);
  80   gboolean            (*supports_xdg_startup_notify) (GAppInfo       *appinfo);
  81
  82
  83   /* For changing associations */
  84   gboolean  (*set_as_default_for_type)      (GAppInfo           *appinfo,
  85                                              const char         *content_type,
  86                                              GError            **error);
  87   gboolean  (*set_as_default_for_extension) (GAppInfo           *appinfo,
  88                                              const char         *extension,
  89                                              GError            **error);
  90   gboolean  (*add_supports_type)            (GAppInfo           *appinfo,
  91                                              const char         *content_type,
  92                                              GError            **error);
  93   gboolean  (*can_remove_supports_type)     (GAppInfo           *appinfo);
  94   gboolean  (*remove_supports_type)         (GAppInfo           *appinfo,
  95                                              const char         *content_type,
  96                                              GError            **error);
  97
  98   /* Padding for future expansion */
  99   void (*_g_reserved1) (void);
 100   void (*_g_reserved2) (void);
 101   void (*_g_reserved3) (void);
 102   void (*_g_reserved4) (void);
 103   void (*_g_reserved5) (void);
 104   void (*_g_reserved6) (void);
 105   void (*_g_reserved7) (void);
 106   void (*_g_reserved8) (void);
 107   void (*_g_reserved9) (void);
 108   void (*_g_reserved10) (void);
 109 };
 110
 111 GType g_app_info_get_type (void) G_GNUC_CONST;
 112 GType g_app_launch_context_get_type (void) G_GNUC_CONST;
 113
 114 GAppInfo *  g_app_info_create_from_commandline      (const char           *commandline,
 115                                                      const char           *application_name,
 116                                                      GAppInfoCreateFlags   flags,
 117                                                      GError              **error);
 118 GAppInfo *  g_app_info_dup                          (GAppInfo             *appinfo);
 119 gboolean    g_app_info_equal                        (GAppInfo             *appinfo1,
 120                                                      GAppInfo             *appinfo2);
 121 const char *g_app_info_get_id                       (GAppInfo             *appinfo);
 122 const char *g_app_info_get_name                     (GAppInfo             *appinfo);
 123 const char *g_app_info_get_description              (GAppInfo             *appinfo);
 124 const char *g_app_info_get_executable               (GAppInfo             *appinfo);
 125 GIcon *     g_app_info_get_icon                     (GAppInfo             *appinfo);
 126 gboolean    g_app_info_launch                       (GAppInfo             *appinfo,
 127                                                      GList                *files,
 128                                                      GAppLaunchContext    *launch_context,
 129                                                      GError              **error);
 130 gboolean    g_app_info_supports_uris                (GAppInfo             *appinfo);
 131 gboolean    g_app_info_launch_uris                  (GAppInfo             *appinfo,
 132                                                      GList                *uris,
 133                                                      GAppLaunchContext    *launch_context,
 134                                                      GError              **error);
 135 gboolean    g_app_info_should_show                  (GAppInfo             *appinfo,
 136                                                      const char           *desktop_env);
 137
 138 gboolean    g_app_info_set_as_default_for_type      (GAppInfo             *appinfo,
 139                                                      const char           *content_type,
 140                                                      GError              **error);
 141 gboolean    g_app_info_set_as_default_for_extension (GAppInfo             *appinfo,
 142                                                      const char           *extension,
 143                                                      GError              **error);
 144 gboolean    g_app_info_add_supports_type            (GAppInfo             *appinfo,
 145                                                      const char           *content_type,
 146                                                      GError              **error);
 147 gboolean    g_app_info_can_remove_supports_type     (GAppInfo             *appinfo);
 148 gboolean    g_app_info_remove_supports_type         (GAppInfo             *appinfo,
 149                                                      const char           *content_type,
 150                                                      GError              **error);
 151
 152 GList *   g_app_info_get_all                     (void);
 153 GList *   g_app_info_get_all_for_type            (const char  *content_type);
 154 GAppInfo *g_app_info_get_default_for_type        (const char  *content_type,
 155                                                   gboolean     must_support_uris);
 156 GAppInfo *g_app_info_get_default_for_uri_scheme  (const char  *uri_scheme);
 157
 158 /* TODO: missing operations:
 159    add app as supporting a content type, but don't make it default
 160    implement set_as_default_for_extension
 161
 162    can_remove, remove (as in, don't support a specific mimetype)
 163 */
 164
 165
 166 struct _GAppLaunchContext
 167 {
 168   GObject parent_instance;
 169
 170   GAppLaunchContextPrivate *priv;
 171 };
 172
 173 struct _GAppLaunchContextClass
 174 {
 175   GObjectClass parent_class;
 176
 177   char * (*get_display)           (GAppLaunchContext *context,
 178                                    GAppInfo *info,
 179                                    GList *files);
 180   char * (*get_startup_notify_id) (GAppLaunchContext *context,
 181                                    GAppInfo *info,
 182                                    GList *files);
 183   void   (*launch_failed)         (GAppLaunchContext *context,
 184                                    const char *startup_notify_id);
 185
 186   /* Padding for future expansion */
 187   void (*_g_reserved1) (void);
 188   void (*_g_reserved2) (void);
 189   void (*_g_reserved3) (void);
 190   void (*_g_reserved4) (void);
 191   void (*_g_reserved5) (void);
 192 };
 193
 194 GAppLaunchContext *g_app_launch_context_new                   (void);
 195 char *             g_app_launch_context_get_display           (GAppLaunchContext *context,
 196                                                                GAppInfo          *info,
 197                                                                GList             *files);
 198 char *             g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
 199                                                                GAppInfo          *info,
 200                                                                GList             *files);
 201 void               g_app_launch_context_launch_failed         (GAppLaunchContext *context,
 202                                                                const char *       startup_notify_id);
 203
 204 G_END_DECLS
 205
 206 #endif /* __G_APP_INFO_H__ */