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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  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 executable 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 extension.
  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  * @can_delete: Checks if a #GAppInfo can be deleted. Since 2.20
  79  * @do_delete: Deletes a #GAppInfo. Since 2.20
  80  * @get_commandline: Gets the commandline for the #GAppInfo. Since 2.20
  81  * @get_display_name: Gets the display name for the #GAppInfo. Since 2.24
  82  * @set_as_last_used_for_type: Sets the application as the last used. See g_app_info_set_as_last_used_for_type().
  83  *
  84  * Application Information interface, for operating system portability.
  85  */
  86 typedef struct _GAppInfoIface    GAppInfoIface;
  87
  88 struct _GAppInfoIface
  89 {
  90   GTypeInterface g_iface;
  91
  92   /* Virtual Table */
  93
  94   GAppInfo *   (* dup)                          (GAppInfo           *appinfo);
  95   gboolean     (* equal)                        (GAppInfo           *appinfo1,
  96                                                  GAppInfo           *appinfo2);
  97   const char * (* get_id)                       (GAppInfo           *appinfo);
  98   const char * (* get_name)                     (GAppInfo           *appinfo);
  99   const char * (* get_description)              (GAppInfo           *appinfo);
 100   const char * (* get_executable)               (GAppInfo           *appinfo);
 101   GIcon *      (* get_icon)                     (GAppInfo           *appinfo);
 102   gboolean     (* launch)                       (GAppInfo           *appinfo,
 103                                                  GList              *files,
 104                                                  GAppLaunchContext  *launch_context,
 105                                                  GError            **error);
 106   gboolean     (* supports_uris)                (GAppInfo           *appinfo);
 107   gboolean     (* supports_files)               (GAppInfo           *appinfo);
 108   gboolean     (* launch_uris)                  (GAppInfo           *appinfo,
 109                                                  GList              *uris,
 110                                                  GAppLaunchContext  *launch_context,
 111                                                  GError            **error);
 112   gboolean     (* should_show)                  (GAppInfo           *appinfo);
 113
 114   /* For changing associations */
 115   gboolean     (* set_as_default_for_type)      (GAppInfo           *appinfo,
 116                                                  const char         *content_type,
 117                                                  GError            **error);
 118   gboolean     (* set_as_default_for_extension) (GAppInfo           *appinfo,
 119                                                  const char         *extension,
 120                                                  GError            **error);
 121   gboolean     (* add_supports_type)            (GAppInfo           *appinfo,
 122                                                  const char         *content_type,
 123                                                  GError            **error);
 124   gboolean     (* can_remove_supports_type)     (GAppInfo           *appinfo);
 125   gboolean     (* remove_supports_type)         (GAppInfo           *appinfo,
 126                                                  const char         *content_type,
 127                                                  GError            **error);
 128   gboolean     (* can_delete)                   (GAppInfo           *appinfo);
 129   gboolean     (* do_delete)                    (GAppInfo           *appinfo);
 130   const char * (* get_commandline)              (GAppInfo           *appinfo);
 131   const char * (* get_display_name)             (GAppInfo           *appinfo);
 132   gboolean     (* set_as_last_used_for_type)    (GAppInfo           *appinfo,
 133                                                  const char         *content_type,
 134                                                  GError            **error);
 135   const char ** (* get_supported_types)         (GAppInfo           *appinfo);
 136 };
 137
 138 GLIB_AVAILABLE_IN_ALL
 139 GType       g_app_info_get_type                     (void) G_GNUC_CONST;
 140 GLIB_AVAILABLE_IN_ALL
 141 GAppInfo *  g_app_info_create_from_commandline      (const char           *commandline,
 142                                                      const char           *application_name,
 143                                                      GAppInfoCreateFlags   flags,
 144                                                      GError              **error);
 145 GLIB_AVAILABLE_IN_ALL
 146 GAppInfo *  g_app_info_dup                          (GAppInfo             *appinfo);
 147 GLIB_AVAILABLE_IN_ALL
 148 gboolean    g_app_info_equal                        (GAppInfo             *appinfo1,
 149                                                      GAppInfo             *appinfo2);
 150 GLIB_AVAILABLE_IN_ALL
 151 const char *g_app_info_get_id                       (GAppInfo             *appinfo);
 152 GLIB_AVAILABLE_IN_ALL
 153 const char *g_app_info_get_name                     (GAppInfo             *appinfo);
 154 GLIB_AVAILABLE_IN_ALL
 155 const char *g_app_info_get_display_name             (GAppInfo             *appinfo);
 156 GLIB_AVAILABLE_IN_ALL
 157 const char *g_app_info_get_description              (GAppInfo             *appinfo);
 158 GLIB_AVAILABLE_IN_ALL
 159 const char *g_app_info_get_executable               (GAppInfo             *appinfo);
 160 GLIB_AVAILABLE_IN_ALL
 161 const char *g_app_info_get_commandline              (GAppInfo             *appinfo);
 162 GLIB_AVAILABLE_IN_ALL
 163 GIcon *     g_app_info_get_icon                     (GAppInfo             *appinfo);
 164 GLIB_AVAILABLE_IN_ALL
 165 gboolean    g_app_info_launch                       (GAppInfo             *appinfo,
 166                                                      GList                *files,
 167                                                      GAppLaunchContext    *launch_context,
 168                                                      GError              **error);
 169 GLIB_AVAILABLE_IN_ALL
 170 gboolean    g_app_info_supports_uris                (GAppInfo             *appinfo);
 171 GLIB_AVAILABLE_IN_ALL
 172 gboolean    g_app_info_supports_files               (GAppInfo             *appinfo);
 173 GLIB_AVAILABLE_IN_ALL
 174 gboolean    g_app_info_launch_uris                  (GAppInfo             *appinfo,
 175                                                      GList                *uris,
 176                                                      GAppLaunchContext    *launch_context,
 177                                                      GError              **error);
 178 GLIB_AVAILABLE_IN_ALL
 179 gboolean    g_app_info_should_show                  (GAppInfo             *appinfo);
 180
 181 GLIB_AVAILABLE_IN_ALL
 182 gboolean    g_app_info_set_as_default_for_type      (GAppInfo             *appinfo,
 183                                                      const char           *content_type,
 184                                                      GError              **error);
 185 GLIB_AVAILABLE_IN_ALL
 186 gboolean    g_app_info_set_as_default_for_extension (GAppInfo             *appinfo,
 187                                                      const char           *extension,
 188                                                      GError              **error);
 189 GLIB_AVAILABLE_IN_ALL
 190 gboolean    g_app_info_add_supports_type            (GAppInfo             *appinfo,
 191                                                      const char           *content_type,
 192                                                      GError              **error);
 193 GLIB_AVAILABLE_IN_ALL
 194 gboolean    g_app_info_can_remove_supports_type     (GAppInfo             *appinfo);
 195 GLIB_AVAILABLE_IN_ALL
 196 gboolean    g_app_info_remove_supports_type         (GAppInfo             *appinfo,
 197                                                      const char           *content_type,
 198                                                      GError              **error);
 199 GLIB_AVAILABLE_IN_2_34
 200 const char **g_app_info_get_supported_types         (GAppInfo             *appinfo);
 201
 202 GLIB_AVAILABLE_IN_ALL
 203 gboolean    g_app_info_can_delete                   (GAppInfo   *appinfo);
 204 GLIB_AVAILABLE_IN_ALL
 205 gboolean    g_app_info_delete                       (GAppInfo   *appinfo);
 206
 207 GLIB_AVAILABLE_IN_ALL
 208 gboolean    g_app_info_set_as_last_used_for_type    (GAppInfo             *appinfo,
 209                                                      const char           *content_type,
 210                                                      GError              **error);
 211
 212 GLIB_AVAILABLE_IN_ALL
 213 GList *   g_app_info_get_all                     (void);
 214 GLIB_AVAILABLE_IN_ALL
 215 GList *   g_app_info_get_all_for_type            (const char  *content_type);
 216 GLIB_AVAILABLE_IN_ALL
 217 GList *   g_app_info_get_recommended_for_type    (const gchar *content_type);
 218 GLIB_AVAILABLE_IN_ALL
 219 GList *   g_app_info_get_fallback_for_type       (const gchar *content_type);
 220
 221 GLIB_AVAILABLE_IN_ALL
 222 void      g_app_info_reset_type_associations     (const char  *content_type);
 223 GLIB_AVAILABLE_IN_ALL
 224 GAppInfo *g_app_info_get_default_for_type        (const char  *content_type,
 225                                                   gboolean     must_support_uris);
 226 GLIB_AVAILABLE_IN_ALL
 227 GAppInfo *g_app_info_get_default_for_uri_scheme  (const char  *uri_scheme);
 228
 229 GLIB_AVAILABLE_IN_ALL
 230 gboolean  g_app_info_launch_default_for_uri      (const char              *uri,
 231                                                   GAppLaunchContext       *launch_context,
 232                                                   GError                 **error);
 233
 234 /**
 235  * GAppLaunchContext:
 236  *
 237  * Integrating the launch with the launching application. This is used to
 238  * handle for instance startup notification and launching the new application
 239  * on the same screen as the launching window.
 240  */
 241 struct _GAppLaunchContext
 242 {
 243   GObject parent_instance;
 244
 245   /*< private >*/
 246   GAppLaunchContextPrivate *priv;
 247 };
 248
 249 struct _GAppLaunchContextClass
 250 {
 251   GObjectClass parent_class;
 252
 253   char * (* get_display)           (GAppLaunchContext *context,
 254                                     GAppInfo          *info,
 255                                     GList             *files);
 256   char * (* get_startup_notify_id) (GAppLaunchContext *context,
 257                                     GAppInfo          *info,
 258                                     GList             *files);
 259   void   (* launch_failed)         (GAppLaunchContext *context,
 260                                     const char        *startup_notify_id);
 261   void   (* launched)              (GAppLaunchContext *context,
 262                                     GAppInfo          *info,
 263                                     GVariant          *platform_data);
 264
 265   /* Padding for future expansion */
 266   void (*_g_reserved1) (void);
 267   void (*_g_reserved2) (void);
 268   void (*_g_reserved3) (void);
 269   void (*_g_reserved4) (void);
 270 };
 271
 272 GLIB_AVAILABLE_IN_ALL
 273 GType              g_app_launch_context_get_type              (void) G_GNUC_CONST;
 274 GLIB_AVAILABLE_IN_ALL
 275 GAppLaunchContext *g_app_launch_context_new                   (void);
 276
 277 GLIB_AVAILABLE_IN_2_32
 278 void               g_app_launch_context_setenv                (GAppLaunchContext *context,
 279                                                                const char        *variable,
 280                                                                const char        *value);
 281 GLIB_AVAILABLE_IN_2_32
 282 void               g_app_launch_context_unsetenv              (GAppLaunchContext *context,
 283                                                                const char        *variable);
 284 GLIB_AVAILABLE_IN_2_32
 285 char **            g_app_launch_context_get_environment       (GAppLaunchContext *context);
 286
 287 GLIB_AVAILABLE_IN_ALL
 288 char *             g_app_launch_context_get_display           (GAppLaunchContext *context,
 289                                                                GAppInfo          *info,
 290                                                                GList             *files);
 291 GLIB_AVAILABLE_IN_ALL
 292 char *             g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
 293                                                                GAppInfo          *info,
 294                                                                GList             *files);
 295 GLIB_AVAILABLE_IN_ALL
 296 void               g_app_launch_context_launch_failed         (GAppLaunchContext *context,
 297                                                                const char *       startup_notify_id);
 298
 299 G_END_DECLS
 300
 301 #endif /* __G_APP_INFO_H__ */