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