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  * GAppInfoIface:
  51  * @g_iface: The parent interface.
  52  * @dup: Copies a #GAppInfo.
  53  * @equal: Checks two #GAppInfos for equality.
  54  * @get_id: Gets a string identifier for a #GAppInfo.
  55  * @get_name: Gets the name of the application for a #GAppInfo.
  56  * @get_description: Gets a short description for the application described by the #GAppInfo.
  57  * @get_executable: Gets the executable name for the #GAppInfo.
  58  * @get_icon: Gets the #GIcon for the #GAppInfo.
  59  * @launch: Launches an application specified by the #GAppInfo.
  60  * @supports_uris: Indicates whether the application specified supports launching URIs.
  61  * @supports_files: Indicates whether the application specified accepts filename arguments.
  62  * @launch_uris: Launches an application with a list of URIs.
  63  * @should_show: Returns whether an application should be shown (e.g. when getting a list of installed applications).
  64  * [FreeDesktop.Org Startup Notification Specification](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt).
  65  * @set_as_default_for_type: Sets an application as default for a given content type.
  66  * @set_as_default_for_extension: Sets an application as default for a given file extension.
  67  * @add_supports_type: Adds to the #GAppInfo information about supported file types.
  68  * @can_remove_supports_type: Checks for support for removing supported file types from a #GAppInfo.
  69  * @remove_supports_type: Removes a supported application type from a #GAppInfo.
  70  * @can_delete: Checks if a #GAppInfo can be deleted. Since 2.20
  71  * @do_delete: Deletes a #GAppInfo. Since 2.20
  72  * @get_commandline: Gets the commandline for the #GAppInfo. Since 2.20
  73  * @get_display_name: Gets the display name for the #GAppInfo. Since 2.24
  74  * @set_as_last_used_for_type: Sets the application as the last used. See g_app_info_set_as_last_used_for_type().
  75  * @get_supported_types: Retrieves the list of content types that @app_info claims to support.
  76  * @launch_uris_async: Asynchronously launches an application with a list of URIs. (Since: 2.60)
  77  * @launch_uris_finish: Finishes an operation started with @launch_uris_async. (Since: 2.60)
  78
  79  * Application Information interface, for operating system portability.
  80  */
  81 typedef struct _GAppInfoIface    GAppInfoIface;
  82
  83 struct _GAppInfoIface
  84 {
  85   GTypeInterface g_iface;
  86
  87   /* Virtual Table */
  88
  89   GAppInfo *   (* dup)                          (GAppInfo           *appinfo);
  90   gboolean     (* equal)                        (GAppInfo           *appinfo1,
  91                                                  GAppInfo           *appinfo2);
  92   const char * (* get_id)                       (GAppInfo           *appinfo);
  93   const char * (* get_name)                     (GAppInfo           *appinfo);
  94   const char * (* get_description)              (GAppInfo           *appinfo);
  95   const char * (* get_executable)               (GAppInfo           *appinfo);
  96   GIcon *      (* get_icon)                     (GAppInfo           *appinfo);
  97   gboolean     (* launch)                       (GAppInfo           *appinfo,
  98                                                  GList              *files,
  99                                                  GAppLaunchContext  *context,
 100                                                  GError            **error);
 101   gboolean     (* supports_uris)                (GAppInfo           *appinfo);
 102   gboolean     (* supports_files)               (GAppInfo           *appinfo);
 103   gboolean     (* launch_uris)                  (GAppInfo           *appinfo,
 104                                                  GList              *uris,
 105                                                  GAppLaunchContext  *context,
 106                                                  GError            **error);
 107   gboolean     (* should_show)                  (GAppInfo           *appinfo);
 108
 109   /* For changing associations */
 110   gboolean     (* set_as_default_for_type)      (GAppInfo           *appinfo,
 111                                                  const char         *content_type,
 112                                                  GError            **error);
 113   gboolean     (* set_as_default_for_extension) (GAppInfo           *appinfo,
 114                                                  const char         *extension,
 115                                                  GError            **error);
 116   gboolean     (* add_supports_type)            (GAppInfo           *appinfo,
 117                                                  const char         *content_type,
 118                                                  GError            **error);
 119   gboolean     (* can_remove_supports_type)     (GAppInfo           *appinfo);
 120   gboolean     (* remove_supports_type)         (GAppInfo           *appinfo,
 121                                                  const char         *content_type,
 122                                                  GError            **error);
 123   gboolean     (* can_delete)                   (GAppInfo           *appinfo);
 124   gboolean     (* do_delete)                    (GAppInfo           *appinfo);
 125   const char * (* get_commandline)              (GAppInfo           *appinfo);
 126   const char * (* get_display_name)             (GAppInfo           *appinfo);
 127   gboolean     (* set_as_last_used_for_type)    (GAppInfo           *appinfo,
 128                                                  const char         *content_type,
 129                                                  GError            **error);
 130   const char ** (* get_supported_types)         (GAppInfo           *appinfo);
 131   void         (* launch_uris_async)            (GAppInfo           *appinfo,
 132                                                  GList              *uris,
 133                                                  GAppLaunchContext  *context,
 134                                                  GCancellable       *cancellable,
 135                                                  GAsyncReadyCallback callback,
 136                                                  gpointer            user_data);
 137   gboolean     (* launch_uris_finish)           (GAppInfo           *appinfo,
 138                                                  GAsyncResult       *result,
 139                                                  GError            **error);
 140 };
 141
 142 GIO_AVAILABLE_IN_ALL
 143 GType       g_app_info_get_type                     (void) G_GNUC_CONST;
 144 GIO_AVAILABLE_IN_ALL
 145 GAppInfo *  g_app_info_create_from_commandline      (const char           *commandline,
 146                                                      const char           *application_name,
 147                                                      GAppInfoCreateFlags   flags,
 148                                                      GError              **error);
 149 GIO_AVAILABLE_IN_ALL
 150 GAppInfo *  g_app_info_dup                          (GAppInfo             *appinfo);
 151 GIO_AVAILABLE_IN_ALL
 152 gboolean    g_app_info_equal                        (GAppInfo             *appinfo1,
 153                                                      GAppInfo             *appinfo2);
 154 GIO_AVAILABLE_IN_ALL
 155 const char *g_app_info_get_id                       (GAppInfo             *appinfo);
 156 GIO_AVAILABLE_IN_ALL
 157 const char *g_app_info_get_name                     (GAppInfo             *appinfo);
 158 GIO_AVAILABLE_IN_ALL
 159 const char *g_app_info_get_display_name             (GAppInfo             *appinfo);
 160 GIO_AVAILABLE_IN_ALL
 161 const char *g_app_info_get_description              (GAppInfo             *appinfo);
 162 GIO_AVAILABLE_IN_ALL
 163 const char *g_app_info_get_executable               (GAppInfo             *appinfo);
 164 GIO_AVAILABLE_IN_ALL
 165 const char *g_app_info_get_commandline              (GAppInfo             *appinfo);
 166 GIO_AVAILABLE_IN_ALL
 167 GIcon *     g_app_info_get_icon                     (GAppInfo             *appinfo);
 168 GIO_AVAILABLE_IN_ALL
 169 gboolean    g_app_info_launch                       (GAppInfo             *appinfo,
 170                                                      GList                *files,
 171                                                      GAppLaunchContext    *context,
 172                                                      GError              **error);
 173 GIO_AVAILABLE_IN_ALL
 174 gboolean    g_app_info_supports_uris                (GAppInfo             *appinfo);
 175 GIO_AVAILABLE_IN_ALL
 176 gboolean    g_app_info_supports_files               (GAppInfo             *appinfo);
 177 GIO_AVAILABLE_IN_ALL
 178 gboolean    g_app_info_launch_uris                  (GAppInfo             *appinfo,
 179                                                      GList                *uris,
 180                                                      GAppLaunchContext    *context,
 181                                                      GError              **error);
 182 GIO_AVAILABLE_IN_2_60
 183 void        g_app_info_launch_uris_async            (GAppInfo             *appinfo,
 184                                                      GList                *uris,
 185                                                      GAppLaunchContext    *context,
 186                                                      GCancellable         *cancellable,
 187                                                      GAsyncReadyCallback   callback,
 188                                                      gpointer              user_data);
 189 GIO_AVAILABLE_IN_2_60
 190 gboolean    g_app_info_launch_uris_finish           (GAppInfo             *appinfo,
 191                                                      GAsyncResult         *result,
 192                                                      GError              **error);
 193
 194 GIO_AVAILABLE_IN_ALL
 195 gboolean    g_app_info_should_show                  (GAppInfo             *appinfo);
 196
 197 GIO_AVAILABLE_IN_ALL
 198 gboolean    g_app_info_set_as_default_for_type      (GAppInfo             *appinfo,
 199                                                      const char           *content_type,
 200                                                      GError              **error);
 201 GIO_AVAILABLE_IN_ALL
 202 gboolean    g_app_info_set_as_default_for_extension (GAppInfo             *appinfo,
 203                                                      const char           *extension,
 204                                                      GError              **error);
 205 GIO_AVAILABLE_IN_ALL
 206 gboolean    g_app_info_add_supports_type            (GAppInfo             *appinfo,
 207                                                      const char           *content_type,
 208                                                      GError              **error);
 209 GIO_AVAILABLE_IN_ALL
 210 gboolean    g_app_info_can_remove_supports_type     (GAppInfo             *appinfo);
 211 GIO_AVAILABLE_IN_ALL
 212 gboolean    g_app_info_remove_supports_type         (GAppInfo             *appinfo,
 213                                                      const char           *content_type,
 214                                                      GError              **error);
 215 GIO_AVAILABLE_IN_2_34
 216 const char **g_app_info_get_supported_types         (GAppInfo             *appinfo);
 217
 218 GIO_AVAILABLE_IN_ALL
 219 gboolean    g_app_info_can_delete                   (GAppInfo   *appinfo);
 220 GIO_AVAILABLE_IN_ALL
 221 gboolean    g_app_info_delete                       (GAppInfo   *appinfo);
 222
 223 GIO_AVAILABLE_IN_ALL
 224 gboolean    g_app_info_set_as_last_used_for_type    (GAppInfo             *appinfo,
 225                                                      const char           *content_type,
 226                                                      GError              **error);
 227
 228 GIO_AVAILABLE_IN_ALL
 229 GList *   g_app_info_get_all                     (void);
 230 GIO_AVAILABLE_IN_ALL
 231 GList *   g_app_info_get_all_for_type            (const char  *content_type);
 232 GIO_AVAILABLE_IN_ALL
 233 GList *   g_app_info_get_recommended_for_type    (const gchar *content_type);
 234 GIO_AVAILABLE_IN_ALL
 235 GList *   g_app_info_get_fallback_for_type       (const gchar *content_type);
 236
 237 GIO_AVAILABLE_IN_ALL
 238 void      g_app_info_reset_type_associations     (const char  *content_type);
 239 GIO_AVAILABLE_IN_ALL
 240 GAppInfo *g_app_info_get_default_for_type        (const char  *content_type,
 241                                                   gboolean     must_support_uris);
 242 GIO_AVAILABLE_IN_2_74
 243 void      g_app_info_get_default_for_type_async  (const char          *content_type,
 244                                                   gboolean             must_support_uris,
 245                                                   GCancellable        *cancellable,
 246                                                   GAsyncReadyCallback  callback,
 247                                                   gpointer             user_data);
 248 GIO_AVAILABLE_IN_2_74
 249 GAppInfo *g_app_info_get_default_for_type_finish (GAsyncResult         *result,
 250                                                   GError              **error);
 251 GIO_AVAILABLE_IN_ALL
 252 GAppInfo *g_app_info_get_default_for_uri_scheme  (const char  *uri_scheme);
 253
 254 GIO_AVAILABLE_IN_2_74
 255 void      g_app_info_get_default_for_uri_scheme_async (const char          *uri_scheme,
 256                                                        GCancellable        *cancellable,
 257                                                        GAsyncReadyCallback  callback,
 258                                                        gpointer             user_data);
 259 GIO_AVAILABLE_IN_2_74
 260 GAppInfo *g_app_info_get_default_for_uri_scheme_finish (GAsyncResult         *result,
 261                                                         GError              **error);
 262
 263 GIO_AVAILABLE_IN_ALL
 264 gboolean  g_app_info_launch_default_for_uri      (const char              *uri,
 265                                                   GAppLaunchContext       *context,
 266                                                   GError                 **error);
 267
 268 GIO_AVAILABLE_IN_2_50
 269 void      g_app_info_launch_default_for_uri_async  (const char           *uri,
 270                                                     GAppLaunchContext    *context,
 271                                                     GCancellable         *cancellable,
 272                                                     GAsyncReadyCallback   callback,
 273                                                     gpointer              user_data);
 274 GIO_AVAILABLE_IN_2_50
 275 gboolean  g_app_info_launch_default_for_uri_finish (GAsyncResult         *result,
 276                                                     GError              **error);
 277
 278
 279 /**
 280  * GAppLaunchContext:
 281  *
 282  * Integrating the launch with the launching application. This is used to
 283  * handle for instance startup notification and launching the new application
 284  * on the same screen as the launching window.
 285  */
 286 struct _GAppLaunchContext
 287 {
 288   GObject parent_instance;
 289
 290   /*< private >*/
 291   GAppLaunchContextPrivate *priv;
 292 };
 293
 294 struct _GAppLaunchContextClass
 295 {
 296   GObjectClass parent_class;
 297
 298   char * (* get_display)           (GAppLaunchContext *context,
 299                                     GAppInfo          *info,
 300                                     GList             *files);
 301   char * (* get_startup_notify_id) (GAppLaunchContext *context,
 302                                     GAppInfo          *info,
 303                                     GList             *files);
 304   void   (* launch_failed)         (GAppLaunchContext *context,
 305                                     const char        *startup_notify_id);
 306   void   (* launched)              (GAppLaunchContext *context,
 307                                     GAppInfo          *info,
 308                                     GVariant          *platform_data);
 309   void   (* launch_started)        (GAppLaunchContext *context,
 310                                     GAppInfo          *info,
 311                                     GVariant          *platform_data);
 312
 313   /* Padding for future expansion */
 314   void (*_g_reserved1) (void);
 315   void (*_g_reserved2) (void);
 316   void (*_g_reserved3) (void);
 317 };
 318
 319 GIO_AVAILABLE_IN_ALL
 320 GType              g_app_launch_context_get_type              (void) G_GNUC_CONST;
 321 GIO_AVAILABLE_IN_ALL
 322 GAppLaunchContext *g_app_launch_context_new                   (void);
 323
 324 GIO_AVAILABLE_IN_2_32
 325 void               g_app_launch_context_setenv                (GAppLaunchContext *context,
 326                                                                const char        *variable,
 327                                                                const char        *value);
 328 GIO_AVAILABLE_IN_2_32
 329 void               g_app_launch_context_unsetenv              (GAppLaunchContext *context,
 330                                                                const char        *variable);
 331 GIO_AVAILABLE_IN_2_32
 332 char **            g_app_launch_context_get_environment       (GAppLaunchContext *context);
 333
 334 GIO_AVAILABLE_IN_ALL
 335 char *             g_app_launch_context_get_display           (GAppLaunchContext *context,
 336                                                                GAppInfo          *info,
 337                                                                GList             *files);
 338 GIO_AVAILABLE_IN_ALL
 339 char *             g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
 340                                                                GAppInfo          *info,
 341                                                                GList             *files);
 342 GIO_AVAILABLE_IN_ALL
 343 void               g_app_launch_context_launch_failed         (GAppLaunchContext *context,
 344                                                                const char *       startup_notify_id);
 345
 346 #define G_TYPE_APP_INFO_MONITOR                             (g_app_info_monitor_get_type ())
 347 #define G_APP_INFO_MONITOR(inst)                            (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
 348                                                              G_TYPE_APP_INFO_MONITOR, GAppInfoMonitor))
 349 #define G_IS_APP_INFO_MONITOR(inst)                         (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
 350                                                              G_TYPE_APP_INFO_MONITOR))
 351
 352 typedef struct _GAppInfoMonitor                             GAppInfoMonitor;
 353
 354 GIO_AVAILABLE_IN_2_40
 355 GType                   g_app_info_monitor_get_type                     (void);
 356
 357 GIO_AVAILABLE_IN_2_40
 358 GAppInfoMonitor *       g_app_info_monitor_get                          (void);
 359
 360 G_END_DECLS
 361
 362 #endif /* __G_APP_INFO_H__ */