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 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 struct _GDesktopAppInfoClass
  39 {
  40   GObjectClass parent_class;
  41 };
  42
  43
  44 GLIB_AVAILABLE_IN_ALL
  45 GType            g_desktop_app_info_get_type          (void) G_GNUC_CONST;
  46
  47 GLIB_AVAILABLE_IN_ALL
  48 GDesktopAppInfo *g_desktop_app_info_new_from_filename (const char      *filename);
  49 GLIB_AVAILABLE_IN_ALL
  50 GDesktopAppInfo *g_desktop_app_info_new_from_keyfile  (GKeyFile        *key_file);
  51
  52 GLIB_AVAILABLE_IN_ALL
  53 const char *     g_desktop_app_info_get_filename      (GDesktopAppInfo *info);
  54
  55 GLIB_AVAILABLE_IN_2_30
  56 const char *     g_desktop_app_info_get_generic_name  (GDesktopAppInfo *info);
  57 GLIB_AVAILABLE_IN_2_30
  58 const char *     g_desktop_app_info_get_categories    (GDesktopAppInfo *info);
  59 GLIB_AVAILABLE_IN_2_30
  60 const char * const *g_desktop_app_info_get_keywords   (GDesktopAppInfo *info);
  61 GLIB_AVAILABLE_IN_2_30
  62 gboolean         g_desktop_app_info_get_nodisplay     (GDesktopAppInfo *info);
  63 GLIB_AVAILABLE_IN_2_30
  64 gboolean         g_desktop_app_info_get_show_in       (GDesktopAppInfo *info,
  65                                                        const gchar     *desktop_env);
  66 GLIB_AVAILABLE_IN_2_34
  67 const char *     g_desktop_app_info_get_startup_wm_class (GDesktopAppInfo *info);
  68
  69 GLIB_AVAILABLE_IN_ALL
  70 GDesktopAppInfo *g_desktop_app_info_new               (const char      *desktop_id);
  71 GLIB_AVAILABLE_IN_ALL
  72 gboolean         g_desktop_app_info_get_is_hidden     (GDesktopAppInfo *info);
  73
  74 GLIB_AVAILABLE_IN_ALL
  75 void             g_desktop_app_info_set_desktop_env   (const char      *desktop_env);
  76
  77 GLIB_AVAILABLE_IN_2_36
  78 gboolean         g_desktop_app_info_has_key           (GDesktopAppInfo *info,
  79                                                        const char      *key);
  80 GLIB_AVAILABLE_IN_2_36
  81 char *           g_desktop_app_info_get_string        (GDesktopAppInfo *info,
  82                                                        const char      *key);
  83 GLIB_AVAILABLE_IN_2_36
  84 gboolean         g_desktop_app_info_get_boolean       (GDesktopAppInfo *info,
  85                                                        const char      *key);
  86
  87 GLIB_AVAILABLE_IN_2_38
  88 const gchar * const *   g_desktop_app_info_list_actions                 (GDesktopAppInfo   *info);
  89
  90 GLIB_AVAILABLE_IN_2_38
  91 void                    g_desktop_app_info_launch_action                (GDesktopAppInfo   *info,
  92                                                                          const gchar       *action_name,
  93                                                                          GAppLaunchContext *launch_context);
  94
  95 GLIB_AVAILABLE_IN_2_38
  96 gchar *                 g_desktop_app_info_get_action_name              (GDesktopAppInfo   *info,
  97                                                                          const gchar       *action_name);
  98
  99 #ifndef G_DISABLE_DEPRECATED
 100
 101 #define G_TYPE_DESKTOP_APP_INFO_LOOKUP           (g_desktop_app_info_lookup_get_type ())
 102 #define G_DESKTOP_APP_INFO_LOOKUP(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP, GDesktopAppInfoLookup))
 103 #define G_IS_DESKTOP_APP_INFO_LOOKUP(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP))
 104 #define G_DESKTOP_APP_INFO_LOOKUP_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP, GDesktopAppInfoLookupIface))
 105
 106 /**
 107  * G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME:
 108  *
 109  * Extension point for default handler to URI association. See
 110  * <link linkend="extending-gio">Extending GIO</link>.
 111  */
 112 #define G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME "gio-desktop-app-info-lookup"
 113
 114 #endif /* G_DISABLE_DEPRECATED */
 115
 116 /**
 117  * GDesktopAppInfoLookup:
 118  *
 119  * Interface that is used by backends to associate default
 120  * handlers with URI schemes.
 121  */
 122 typedef struct _GDesktopAppInfoLookup GDesktopAppInfoLookup;
 123 typedef struct _GDesktopAppInfoLookupIface GDesktopAppInfoLookupIface;
 124
 125 struct _GDesktopAppInfoLookupIface
 126 {
 127   GTypeInterface g_iface;
 128
 129   GAppInfo * (* get_default_for_uri_scheme) (GDesktopAppInfoLookup *lookup,
 130                                              const char            *uri_scheme);
 131 };
 132
 133 GLIB_DEPRECATED
 134 GType     g_desktop_app_info_lookup_get_type                   (void) G_GNUC_CONST;
 135
 136 GLIB_DEPRECATED
 137 GAppInfo *g_desktop_app_info_lookup_get_default_for_uri_scheme (GDesktopAppInfoLookup *lookup,
 138                                                                 const char            *uri_scheme);
 139
 140 /**
 141  * GDesktopAppLaunchCallback:
 142  * @appinfo: a #GDesktopAppInfo
 143  * @pid: Process identifier
 144  * @user_data: User data
 145  *
 146  * During invocation, g_desktop_app_info_launch_uris_as_manager() may
 147  * create one or more child processes.  This callback is invoked once
 148  * for each, providing the process ID.
 149  */
 150 typedef void (*GDesktopAppLaunchCallback) (GDesktopAppInfo  *appinfo,
 151                                            GPid              pid,
 152                                            gpointer          user_data);
 153
 154 GLIB_AVAILABLE_IN_2_28
 155 gboolean    g_desktop_app_info_launch_uris_as_manager (GDesktopAppInfo            *appinfo,
 156                                                        GList                      *uris,
 157                                                        GAppLaunchContext          *launch_context,
 158                                                        GSpawnFlags                 spawn_flags,
 159                                                        GSpawnChildSetupFunc        user_setup,
 160                                                        gpointer                    user_setup_data,
 161                                                        GDesktopAppLaunchCallback   pid_callback,
 162                                                        gpointer                    pid_callback_data,
 163                                                        GError                    **error);
 164
 165 GLIB_AVAILABLE_IN_2_40
 166 gchar *** g_desktop_app_info_search (const gchar *search_string);
 167
 168 G_END_DECLS
 169
 170 #endif /* __G_DESKTOP_APP_INFO_H__ */