gio/gappinfo.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  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 #GAppInfos 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  * [FreeDesktop.Org Startup Notification Specification](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt).
  72  * @set_as_default_for_type: Sets an application as default for a given content type.
  73  * @set_as_default_for_extension: Sets an application as default for a given file extension.
  74  * @add_supports_type: Adds to the #GAppInfo information about supported file types.
  75  * @can_remove_supports_type: Checks for support for removing supported file types from a #GAppInfo.
  76  * @remove_supports_type: Removes a supported application type from a #GAppInfo.
  77  * @can_delete: Checks if a #GAppInfo can be deleted. Since 2.20
  78  * @do_delete: Deletes a #GAppInfo. Since 2.20
  79  * @get_commandline: Gets the commandline for the #GAppInfo. Since 2.20
  80  * @get_display_name: Gets the display name for the #GAppInfo. Since 2.24
  81  * @set_as_last_used_for_type: Sets the application as the last used. See g_app_info_set_as_last_used_for_type().
  82  * @get_supported_types: Retrieves the list of content types that @app_info claims to support.
  83  * @launch_uris_async: Asynchronously launches an application with a list of URIs. (Since: 2.60)
  84  * @launch_uris_finish: Finishes an operation started with @launch_uris_async. (Since: 2.60)
  85
  86  * Application Information interface, for operating system portability.
  87  */
  88 typedef struct _GAppInfoIface    GAppInfoIface;
  89
  90 struct _GAppInfoIface
  91 {
  92   GTypeInterface g_iface;
  93
  94   /* Virtual Table */
  95
  96   GAppInfo *   (* dup)                          (GAppInfo           *appinfo);
  97   gboolean     (* equal)                        (GAppInfo           *appinfo1,
  98                                                  GAppInfo           *appinfo2);
  99   const char * (* get_id)                       (GAppInfo           *appinfo);
 100   const char * (* get_name)                     (GAppInfo           *appinfo);
 101   const char * (* get_description)              (GAppInfo           *appinfo);
 102   const char * (* get_executable)               (GAppInfo           *appinfo);
 103   GIcon *      (* get_icon)                     (GAppInfo           *appinfo);
 104   gboolean     (* launch)                       (GAppInfo           *appinfo,
 105                                                  GList              *files,
 106                                                  GAppLaunchContext  *context,
 107                                                  GError            **error);
 108   gboolean     (* supports_uris)                (GAppInfo           *appinfo);
 109   gboolean     (* supports_files)               (GAppInfo           *appinfo);
 110   gboolean     (* launch_uris)                  (GAppInfo           *appinfo,
 111                                                  GList              *uris,
 112                                                  GAppLaunchContext  *context,
 113                                                  GError            **error);
 114   gboolean     (* should_show)                  (GAppInfo           *appinfo);
 115
 116   /* For changing associations */
 117   gboolean     (* set_as_default_for_type)      (GAppInfo           *appinfo,
 118                                                  const char         *content_type,
 119                                                  GError            **error);
 120   gboolean     (* set_as_default_for_extension) (GAppInfo           *appinfo,
 121                                                  const char         *extension,
 122                                                  GError            **error);
 123   gboolean     (* add_supports_type)            (GAppInfo           *appinfo,
 124                                                  const char         *content_type,
 125                                                  GError            **error);
 126   gboolean     (* can_remove_supports_type)     (GAppInfo           *appinfo);
 127   gboolean     (* remove_supports_type)         (GAppInfo           *appinfo,
 128                                                  const char         *content_type,
 129                                                  GError            **error);
 130   gboolean     (* can_delete)                   (GAppInfo           *appinfo);
 131   gboolean     (* do_delete)                    (GAppInfo           *appinfo);
 132   const char * (* get_commandline)              (GAppInfo           *appinfo);
 133   const char * (* get_display_name)             (GAppInfo           *appinfo);
 134   gboolean     (* set_as_last_used_for_type)    (GAppInfo           *appinfo,
 135                                                  const char         *content_type,
 136                                                  GError            **error);
 137   const char ** (* get_supported_types)         (GAppInfo           *appinfo);
 138   void         (* launch_uris_async)            (GAppInfo           *appinfo,
 139                                                  GList              *uris,
 140                                                  GAppLaunchContext  *context,
 141                                                  GCancellable       *cancellable,
 142                                                  GAsyncReadyCallback callback,
 143                                                  gpointer            user_data);
 144   gboolean     (* launch_uris_finish)           (GAppInfo           *appinfo,
 145                                                  GAsyncResult       *result,
 146                                                  GError            **error);
 147 };
 148
 149 GLIB_AVAILABLE_IN_ALL
 150 GType       g_app_info_get_type                     (void) G_GNUC_CONST;
 151 GLIB_AVAILABLE_IN_ALL
 152 GAppInfo *  g_app_info_create_from_commandline      (const char           *commandline,
 153                                                      const char           *application_name,
 154                                                      GAppInfoCreateFlags   flags,
 155                                                      GError              **error);
 156 GLIB_AVAILABLE_IN_ALL
 157 GAppInfo *  g_app_info_dup                          (GAppInfo             *appinfo);
 158 GLIB_AVAILABLE_IN_ALL
 159 gboolean    g_app_info_equal                        (GAppInfo             *appinfo1,
 160                                                      GAppInfo             *appinfo2);
 161 GLIB_AVAILABLE_IN_ALL
 162 const char *g_app_info_get_id                       (GAppInfo             *appinfo);
 163 GLIB_AVAILABLE_IN_ALL
 164 const char *g_app_info_get_name                     (GAppInfo             *appinfo);
 165 GLIB_AVAILABLE_IN_ALL
 166 const char *g_app_info_get_display_name             (GAppInfo             *appinfo);
 167 GLIB_AVAILABLE_IN_ALL
 168 const char *g_app_info_get_description              (GAppInfo             *appinfo);
 169 GLIB_AVAILABLE_IN_ALL
 170 const char *g_app_info_get_executable               (GAppInfo             *appinfo);
 171 GLIB_AVAILABLE_IN_ALL
 172 const char *g_app_info_get_commandline              (GAppInfo             *appinfo);
 173 GLIB_AVAILABLE_IN_ALL
 174 GIcon *     g_app_info_get_icon                     (GAppInfo             *appinfo);
 175 GLIB_AVAILABLE_IN_ALL
 176 gboolean    g_app_info_launch                       (GAppInfo             *appinfo,
 177                                                      GList                *files,
 178                                                      GAppLaunchContext    *context,
 179                                                      GError              **error);
 180 GLIB_AVAILABLE_IN_ALL
 181 gboolean    g_app_info_supports_uris                (GAppInfo             *appinfo);
 182 GLIB_AVAILABLE_IN_ALL
 183 gboolean    g_app_info_supports_files               (GAppInfo             *appinfo);
 184 GLIB_AVAILABLE_IN_ALL
 185 gboolean    g_app_info_launch_uris                  (GAppInfo             *appinfo,
 186                                                      GList                *uris,
 187                                                      GAppLaunchContext    *context,
 188                                                      GError              **error);
 189 GLIB_AVAILABLE_IN_2_60
 190 void        g_app_info_launch_uris_async            (GAppInfo             *appinfo,
 191                                                      GList                *uris,
 192                                                      GAppLaunchContext    *context,
 193                                                      GCancellable         *cancellable,
 194                                                      GAsyncReadyCallback   callback,
 195                                                      gpointer              user_data);
 196 GLIB_AVAILABLE_IN_2_60
 197 gboolean    g_app_info_launch_uris_finish           (GAppInfo             *appinfo,
 198                                                      GAsyncResult         *result,
 199                                                      GError              **error);
 200
 201 GLIB_AVAILABLE_IN_ALL
 202 gboolean    g_app_info_should_show                  (GAppInfo             *appinfo);
 203
 204 GLIB_AVAILABLE_IN_ALL
 205 gboolean    g_app_info_set_as_default_for_type      (GAppInfo             *appinfo,
 206                                                      const char           *content_type,
 207                                                      GError              **error);
 208 GLIB_AVAILABLE_IN_ALL
 209 gboolean    g_app_info_set_as_default_for_extension (GAppInfo             *appinfo,
 210                                                      const char           *extension,
 211                                                      GError              **error);
 212 GLIB_AVAILABLE_IN_ALL
 213 gboolean    g_app_info_add_supports_type            (GAppInfo             *appinfo,
 214                                                      const char           *content_type,
 215                                                      GError              **error);
 216 GLIB_AVAILABLE_IN_ALL
 217 gboolean    g_app_info_can_remove_supports_type     (GAppInfo             *appinfo);
 218 GLIB_AVAILABLE_IN_ALL
 219 gboolean    g_app_info_remove_supports_type         (GAppInfo             *appinfo,
 220                                                      const char           *content_type,
 221                                                      GError              **error);
 222 GLIB_AVAILABLE_IN_2_34
 223 const char **g_app_info_get_supported_types         (GAppInfo             *appinfo);
 224
 225 GLIB_AVAILABLE_IN_ALL
 226 gboolean    g_app_info_can_delete                   (GAppInfo   *appinfo);
 227 GLIB_AVAILABLE_IN_ALL
 228 gboolean    g_app_info_delete                       (GAppInfo   *appinfo);
 229
 230 GLIB_AVAILABLE_IN_ALL
 231 gboolean    g_app_info_set_as_last_used_for_type    (GAppInfo             *appinfo,
 232                                                      const char           *content_type,
 233                                                      GError              **error);
 234
 235 GLIB_AVAILABLE_IN_ALL
 236 GList *   g_app_info_get_all                     (void);
 237 GLIB_AVAILABLE_IN_ALL
 238 GList *   g_app_info_get_all_for_type            (const char  *content_type);
 239 GLIB_AVAILABLE_IN_ALL
 240 GList *   g_app_info_get_recommended_for_type    (const gchar *content_type);
 241 GLIB_AVAILABLE_IN_ALL
 242 GList *   g_app_info_get_fallback_for_type       (const gchar *content_type);
 243
 244 GLIB_AVAILABLE_IN_ALL
 245 void      g_app_info_reset_type_associations     (const char  *content_type);
 246 GLIB_AVAILABLE_IN_ALL
 247 GAppInfo *g_app_info_get_default_for_type        (const char  *content_type,
 248                                                   gboolean     must_support_uris);
 249 GLIB_AVAILABLE_IN_2_74
 250 void      g_app_info_get_default_for_type_async  (const char          *content_type,
 251                                                   gboolean             must_support_uris,
 252                                                   GCancellable        *cancellable,
 253                                                   GAsyncReadyCallback  callback,
 254                                                   gpointer             user_data);
 255 GLIB_AVAILABLE_IN_2_74
 256 GAppInfo *g_app_info_get_default_for_type_finish (GAsyncResult         *result,
 257                                                   GError              **error);
 258 GLIB_AVAILABLE_IN_ALL
 259 GAppInfo *g_app_info_get_default_for_uri_scheme  (const char  *uri_scheme);
 260
 261 GLIB_AVAILABLE_IN_2_74
 262 void      g_app_info_get_default_for_uri_scheme_async (const char          *uri_scheme,
 263                                                        GCancellable        *cancellable,
 264                                                        GAsyncReadyCallback  callback,
 265                                                        gpointer             user_data);
 266 GLIB_AVAILABLE_IN_2_74
 267 GAppInfo *g_app_info_get_default_for_uri_scheme_finish (GAsyncResult         *result,
 268                                                         GError              **error);
 269
 270 GLIB_AVAILABLE_IN_ALL
 271 gboolean  g_app_info_launch_default_for_uri      (const char              *uri,
 272                                                   GAppLaunchContext       *context,
 273                                                   GError                 **error);
 274
 275 GLIB_AVAILABLE_IN_2_50
 276 void      g_app_info_launch_default_for_uri_async  (const char           *uri,
 277                                                     GAppLaunchContext    *context,
 278                                                     GCancellable         *cancellable,
 279                                                     GAsyncReadyCallback   callback,
 280                                                     gpointer              user_data);
 281 GLIB_AVAILABLE_IN_2_50
 282 gboolean  g_app_info_launch_default_for_uri_finish (GAsyncResult         *result,
 283                                                     GError              **error);
 284
 285
 286 /**
 287  * GAppLaunchContext:
 288  *
 289  * Integrating the launch with the launching application. This is used to
 290  * handle for instance startup notification and launching the new application
 291  * on the same screen as the launching window.
 292  */
 293 struct _GAppLaunchContext
 294 {
 295   GObject parent_instance;
 296
 297   /*< private >*/
 298   GAppLaunchContextPrivate *priv;
 299 };
 300
 301 struct _GAppLaunchContextClass
 302 {
 303   GObjectClass parent_class;
 304
 305   char * (* get_display)           (GAppLaunchContext *context,
 306                                     GAppInfo          *info,
 307                                     GList             *files);
 308   char * (* get_startup_notify_id) (GAppLaunchContext *context,
 309                                     GAppInfo          *info,
 310                                     GList             *files);
 311   void   (* launch_failed)         (GAppLaunchContext *context,
 312                                     const char        *startup_notify_id);
 313   void   (* launched)              (GAppLaunchContext *context,
 314                                     GAppInfo          *info,
 315                                     GVariant          *platform_data);
 316   void   (* launch_started)        (GAppLaunchContext *context,
 317                                     GAppInfo          *info,
 318                                     GVariant          *platform_data);
 319
 320   /* Padding for future expansion */
 321   void (*_g_reserved1) (void);
 322   void (*_g_reserved2) (void);
 323   void (*_g_reserved3) (void);
 324 };
 325
 326 GLIB_AVAILABLE_IN_ALL
 327 GType              g_app_launch_context_get_type              (void) G_GNUC_CONST;
 328 GLIB_AVAILABLE_IN_ALL
 329 GAppLaunchContext *g_app_launch_context_new                   (void);
 330
 331 GLIB_AVAILABLE_IN_2_32
 332 void               g_app_launch_context_setenv                (GAppLaunchContext *context,
 333                                                                const char        *variable,
 334                                                                const char        *value);
 335 GLIB_AVAILABLE_IN_2_32
 336 void               g_app_launch_context_unsetenv              (GAppLaunchContext *context,
 337                                                                const char        *variable);
 338 GLIB_AVAILABLE_IN_2_32
 339 char **            g_app_launch_context_get_environment       (GAppLaunchContext *context);
 340
 341 GLIB_AVAILABLE_IN_ALL
 342 char *             g_app_launch_context_get_display           (GAppLaunchContext *context,
 343                                                                GAppInfo          *info,
 344                                                                GList             *files);
 345 GLIB_AVAILABLE_IN_ALL
 346 char *             g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
 347                                                                GAppInfo          *info,
 348                                                                GList             *files);
 349 GLIB_AVAILABLE_IN_ALL
 350 void               g_app_launch_context_launch_failed         (GAppLaunchContext *context,
 351                                                                const char *       startup_notify_id);
 352
 353 #define G_TYPE_APP_INFO_MONITOR                             (g_app_info_monitor_get_type ())
 354 #define G_APP_INFO_MONITOR(inst)                            (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
 355                                                              G_TYPE_APP_INFO_MONITOR, GAppInfoMonitor))
 356 #define G_IS_APP_INFO_MONITOR(inst)                         (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
 357                                                              G_TYPE_APP_INFO_MONITOR))
 358
 359 typedef struct _GAppInfoMonitor                             GAppInfoMonitor;
 360
 361 GLIB_AVAILABLE_IN_2_40
 362 GType                   g_app_info_monitor_get_type                     (void);
 363
 364 GLIB_AVAILABLE_IN_2_40
 365 GAppInfoMonitor *       g_app_info_monitor_get                          (void);
 366
 367 G_END_DECLS
 368
 369 #endif /* __G_APP_INFO_H__ */