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