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, 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_DESKTOP_APP_INFO_H__
  24 #define __G_DESKTOP_APP_INFO_H__
  25
  26 #include <gio/gio.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define G_TYPE_DESKTOP_APP_INFO         (g_desktop_app_info_get_type ())
  31 #define G_DESKTOP_APP_INFO(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DESKTOP_APP_INFO, GDesktopAppInfo))
  32 #define G_DESKTOP_APP_INFO_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DESKTOP_APP_INFO, GDesktopAppInfoClass))
  33 #define G_IS_DESKTOP_APP_INFO(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DESKTOP_APP_INFO))
  34 #define G_IS_DESKTOP_APP_INFO_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DESKTOP_APP_INFO))
  35 #define G_DESKTOP_APP_INFO_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DESKTOP_APP_INFO, GDesktopAppInfoClass))
  36
  37 typedef struct _GDesktopAppInfo        GDesktopAppInfo;
  38 typedef struct _GDesktopAppInfoClass   GDesktopAppInfoClass;
  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_AVAILABLE_IN_ALL
  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_36
  86 gboolean         g_desktop_app_info_get_boolean       (GDesktopAppInfo *info,
  87                                                        const char      *key);
  88
  89 #ifndef G_DISABLE_DEPRECATED
  90
  91 #define G_TYPE_DESKTOP_APP_INFO_LOOKUP           (g_desktop_app_info_lookup_get_type ())
  92 #define G_DESKTOP_APP_INFO_LOOKUP(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP, GDesktopAppInfoLookup))
  93 #define G_IS_DESKTOP_APP_INFO_LOOKUP(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP))
  94 #define G_DESKTOP_APP_INFO_LOOKUP_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP, GDesktopAppInfoLookupIface))
  95
  96 /**
  97  * G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME:
  98  *
  99  * Extension point for default handler to URI association. See
 100  * <link linkend="extending-gio">Extending GIO</link>.
 101  */
 102 #define G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME "gio-desktop-app-info-lookup"
 103
 104 #endif /* G_DISABLE_DEPRECATED */
 105
 106 /**
 107  * GDesktopAppInfoLookup:
 108  *
 109  * Interface that is used by backends to associate default
 110  * handlers with URI schemes.
 111  */
 112 typedef struct _GDesktopAppInfoLookup GDesktopAppInfoLookup;
 113 typedef struct _GDesktopAppInfoLookupIface GDesktopAppInfoLookupIface;
 114
 115 struct _GDesktopAppInfoLookupIface
 116 {
 117   GTypeInterface g_iface;
 118
 119   GAppInfo * (* get_default_for_uri_scheme) (GDesktopAppInfoLookup *lookup,
 120                                              const char            *uri_scheme);
 121 };
 122
 123 GLIB_DEPRECATED
 124 GType     g_desktop_app_info_lookup_get_type                   (void) G_GNUC_CONST;
 125
 126 GLIB_DEPRECATED
 127 GAppInfo *g_desktop_app_info_lookup_get_default_for_uri_scheme (GDesktopAppInfoLookup *lookup,
 128                                                                 const char            *uri_scheme);
 129
 130 /**
 131  * GDesktopAppLaunchCallback:
 132  * @appinfo: a #GDesktopAppInfo
 133  * @pid: Process identifier
 134  * @user_data: User data
 135  *
 136  * During invocation, g_desktop_app_info_launch_uris_as_manager() may
 137  * create one or more child processes.  This callback is invoked once
 138  * for each, providing the process ID.
 139  */
 140 typedef void (*GDesktopAppLaunchCallback) (GDesktopAppInfo  *appinfo,
 141                                            GPid              pid,
 142                                            gpointer          user_data);
 143
 144 GLIB_AVAILABLE_IN_2_28
 145 gboolean    g_desktop_app_info_launch_uris_as_manager (GDesktopAppInfo            *appinfo,
 146                                                        GList                      *uris,
 147                                                        GAppLaunchContext          *launch_context,
 148                                                        GSpawnFlags                 spawn_flags,
 149                                                        GSpawnChildSetupFunc        user_setup,
 150                                                        gpointer                    user_setup_data,
 151                                                        GDesktopAppLaunchCallback   pid_callback,
 152                                                        gpointer                    pid_callback_data,
 153                                                        GError                    **error);
 154
 155
 156 G_END_DECLS
 157
 158 #endif /* __G_DESKTOP_APP_INFO_H__ */