gio/gdesktopappinfo.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.1 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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #ifndef __G_DESKTOP_APP_INFO_H__
  22 #define __G_DESKTOP_APP_INFO_H__
  23
  24 #include <gio/gio.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define G_TYPE_DESKTOP_APP_INFO         (g_desktop_app_info_get_type ())
  29 #define G_DESKTOP_APP_INFO(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DESKTOP_APP_INFO, GDesktopAppInfo))
  30 #define G_DESKTOP_APP_INFO_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DESKTOP_APP_INFO, GDesktopAppInfoClass))
  31 #define G_IS_DESKTOP_APP_INFO(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DESKTOP_APP_INFO))
  32 #define G_IS_DESKTOP_APP_INFO_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DESKTOP_APP_INFO))
  33 #define G_DESKTOP_APP_INFO_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DESKTOP_APP_INFO, GDesktopAppInfoClass))
  34
  35 typedef struct _GDesktopAppInfo        GDesktopAppInfo;
  36 typedef struct _GDesktopAppInfoClass   GDesktopAppInfoClass;
  37
  38 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GDesktopAppInfo, g_object_unref)
  39
  40 struct _GDesktopAppInfoClass
  41 {
  42   GObjectClass parent_class;
  43 };
  44
  45
  46 GLIB_AVAILABLE_IN_ALL
  47 GType            g_desktop_app_info_get_type          (void) G_GNUC_CONST;
  48
  49 GLIB_AVAILABLE_IN_ALL
  50 GDesktopAppInfo *g_desktop_app_info_new_from_filename (const char      *filename);
  51 GLIB_AVAILABLE_IN_ALL
  52 GDesktopAppInfo *g_desktop_app_info_new_from_keyfile  (GKeyFile        *key_file);
  53
  54 GLIB_AVAILABLE_IN_ALL
  55 const char *     g_desktop_app_info_get_filename      (GDesktopAppInfo *info);
  56
  57 GLIB_AVAILABLE_IN_2_30
  58 const char *     g_desktop_app_info_get_generic_name  (GDesktopAppInfo *info);
  59 GLIB_AVAILABLE_IN_2_30
  60 const char *     g_desktop_app_info_get_categories    (GDesktopAppInfo *info);
  61 GLIB_AVAILABLE_IN_2_30
  62 const char * const *g_desktop_app_info_get_keywords   (GDesktopAppInfo *info);
  63 GLIB_AVAILABLE_IN_2_30
  64 gboolean         g_desktop_app_info_get_nodisplay     (GDesktopAppInfo *info);
  65 GLIB_AVAILABLE_IN_2_30
  66 gboolean         g_desktop_app_info_get_show_in       (GDesktopAppInfo *info,
  67                                                        const gchar     *desktop_env);
  68 GLIB_AVAILABLE_IN_2_34
  69 const char *     g_desktop_app_info_get_startup_wm_class (GDesktopAppInfo *info);
  70
  71 GLIB_AVAILABLE_IN_ALL
  72 GDesktopAppInfo *g_desktop_app_info_new               (const char      *desktop_id);
  73 GLIB_AVAILABLE_IN_ALL
  74 gboolean         g_desktop_app_info_get_is_hidden     (GDesktopAppInfo *info);
  75
  76 GLIB_DEPRECATED_IN_2_42
  77 void             g_desktop_app_info_set_desktop_env   (const char      *desktop_env);
  78
  79 GLIB_AVAILABLE_IN_2_36
  80 gboolean         g_desktop_app_info_has_key           (GDesktopAppInfo *info,
  81                                                        const char      *key);
  82 GLIB_AVAILABLE_IN_2_36
  83 char *           g_desktop_app_info_get_string        (GDesktopAppInfo *info,
  84                                                        const char      *key);
  85 GLIB_AVAILABLE_IN_2_56
  86 char *           g_desktop_app_info_get_locale_string (GDesktopAppInfo *info,
  87                                                        const char      *key);
  88 GLIB_AVAILABLE_IN_2_36
  89 gboolean         g_desktop_app_info_get_boolean       (GDesktopAppInfo *info,
  90                                                        const char      *key);
  91
  92 GLIB_AVAILABLE_IN_2_38
  93 const gchar * const *   g_desktop_app_info_list_actions                 (GDesktopAppInfo   *info);
  94
  95 GLIB_AVAILABLE_IN_2_38
  96 void                    g_desktop_app_info_launch_action                (GDesktopAppInfo   *info,
  97                                                                          const gchar       *action_name,
  98                                                                          GAppLaunchContext *launch_context);
  99
 100 GLIB_AVAILABLE_IN_2_38
 101 gchar *                 g_desktop_app_info_get_action_name              (GDesktopAppInfo   *info,
 102                                                                          const gchar       *action_name);
 103
 104 #ifndef G_DISABLE_DEPRECATED
 105
 106 #define G_TYPE_DESKTOP_APP_INFO_LOOKUP           (g_desktop_app_info_lookup_get_type ())
 107 #define G_DESKTOP_APP_INFO_LOOKUP(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP, GDesktopAppInfoLookup))
 108 #define G_IS_DESKTOP_APP_INFO_LOOKUP(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP))
 109 #define G_DESKTOP_APP_INFO_LOOKUP_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP, GDesktopAppInfoLookupIface))
 110
 111 /**
 112  * G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME:
 113  *
 114  * Extension point for default handler to URI association. See
 115  * [Extending GIO][extending-gio].
 116  */
 117 #define G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME "gio-desktop-app-info-lookup"
 118
 119 #endif /* G_DISABLE_DEPRECATED */
 120
 121 /**
 122  * GDesktopAppInfoLookupIface:
 123  * @get_default_for_uri_scheme: Virtual method for
 124  *  g_desktop_app_info_lookup_get_default_for_uri_scheme().
 125  *
 126  * Interface that is used by backends to associate default
 127  * handlers with URI schemes.
 128  */
 129 typedef struct _GDesktopAppInfoLookup GDesktopAppInfoLookup;
 130 typedef struct _GDesktopAppInfoLookupIface GDesktopAppInfoLookupIface;
 131
 132 struct _GDesktopAppInfoLookupIface
 133 {
 134   GTypeInterface g_iface;
 135
 136   GAppInfo * (* get_default_for_uri_scheme) (GDesktopAppInfoLookup *lookup,
 137                                              const char            *uri_scheme);
 138 };
 139
 140 GLIB_DEPRECATED
 141 GType     g_desktop_app_info_lookup_get_type                   (void) G_GNUC_CONST;
 142
 143 GLIB_DEPRECATED
 144 GAppInfo *g_desktop_app_info_lookup_get_default_for_uri_scheme (GDesktopAppInfoLookup *lookup,
 145                                                                 const char            *uri_scheme);
 146
 147 /**
 148  * GDesktopAppLaunchCallback:
 149  * @appinfo: a #GDesktopAppInfo
 150  * @pid: Process identifier
 151  * @user_data: User data
 152  *
 153  * During invocation, g_desktop_app_info_launch_uris_as_manager() may
 154  * create one or more child processes.  This callback is invoked once
 155  * for each, providing the process ID.
 156  */
 157 typedef void (*GDesktopAppLaunchCallback) (GDesktopAppInfo  *appinfo,
 158                                            GPid              pid,
 159                                            gpointer          user_data);
 160
 161 GLIB_AVAILABLE_IN_2_28
 162 gboolean    g_desktop_app_info_launch_uris_as_manager (GDesktopAppInfo            *appinfo,
 163                                                        GList                      *uris,
 164                                                        GAppLaunchContext          *launch_context,
 165                                                        GSpawnFlags                 spawn_flags,
 166                                                        GSpawnChildSetupFunc        user_setup,
 167                                                        gpointer                    user_setup_data,
 168                                                        GDesktopAppLaunchCallback   pid_callback,
 169                                                        gpointer                    pid_callback_data,
 170                                                        GError                    **error);
 171
 172 GLIB_AVAILABLE_IN_2_58
 173 gboolean    g_desktop_app_info_launch_uris_as_manager_with_fds (GDesktopAppInfo            *appinfo,
 174                                                                 GList                      *uris,
 175                                                                 GAppLaunchContext          *launch_context,
 176                                                                 GSpawnFlags                 spawn_flags,
 177                                                                 GSpawnChildSetupFunc        user_setup,
 178                                                                 gpointer                    user_setup_data,
 179                                                                 GDesktopAppLaunchCallback   pid_callback,
 180                                                                 gpointer                    pid_callback_data,
 181                                                                 gint                        stdin_fd,
 182                                                                 gint                        stdout_fd,
 183                                                                 gint                        stderr_fd,
 184                                                                 GError                    **error);
 185
 186 GLIB_AVAILABLE_IN_2_40
 187 gchar *** g_desktop_app_info_search (const gchar *search_string);
 188
 189 GLIB_AVAILABLE_IN_2_42
 190 GList *g_desktop_app_info_get_implementations (const gchar *interface);
 191
 192 G_END_DECLS
 193
 194 #endif /* __G_DESKTOP_APP_INFO_H__ */