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
  68 #ifndef G_DISABLE_DEPRECATED
  69
  70 #define G_TYPE_DESKTOP_APP_INFO_LOOKUP           (g_desktop_app_info_lookup_get_type ())
  71 #define G_DESKTOP_APP_INFO_LOOKUP(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP, GDesktopAppInfoLookup))
  72 #define G_IS_DESKTOP_APP_INFO_LOOKUP(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP))
  73 #define G_DESKTOP_APP_INFO_LOOKUP_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP, GDesktopAppInfoLookupIface))
  74
  75 /**
  76  * G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME:
  77  *
  78  * Extension point for default handler to URI association. See
  79  * <link linkend="extending-gio">Extending GIO</link>.
  80  */
  81 #define G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME "gio-desktop-app-info-lookup"
  82
  83 #endif /* G_DISABLE_DEPRECATED */
  84
  85 /**
  86  * GDesktopAppInfoLookup:
  87  *
  88  * Interface that is used by backends to associate default
  89  * handlers with URI schemes.
  90  */
  91 typedef struct _GDesktopAppInfoLookup GDesktopAppInfoLookup;
  92 typedef struct _GDesktopAppInfoLookupIface GDesktopAppInfoLookupIface;
  93
  94 struct _GDesktopAppInfoLookupIface
  95 {
  96   GTypeInterface g_iface;
  97
  98   GAppInfo * (* get_default_for_uri_scheme) (GDesktopAppInfoLookup *lookup,
  99                                              const char            *uri_scheme);
 100 };
 101
 102 GLIB_DEPRECATED
 103 GType     g_desktop_app_info_lookup_get_type                   (void) G_GNUC_CONST;
 104
 105 GLIB_DEPRECATED
 106 GAppInfo *g_desktop_app_info_lookup_get_default_for_uri_scheme (GDesktopAppInfoLookup *lookup,
 107                                                                 const char            *uri_scheme);
 108
 109 /**
 110  * GDesktopAppLaunchCallback:
 111  * @appinfo: a #GDesktopAppInfo
 112  * @pid: Process identifier
 113  * @user_data: User data
 114  *
 115  * During invocation, g_desktop_app_info_launch_uris_as_manager() may
 116  * create one or more child processes.  This callback is invoked once
 117  * for each, providing the process ID.
 118  */
 119 typedef void (*GDesktopAppLaunchCallback) (GDesktopAppInfo  *appinfo,
 120                                            GPid              pid,
 121                                            gpointer          user_data);
 122
 123 gboolean    g_desktop_app_info_launch_uris_as_manager (GDesktopAppInfo            *appinfo,
 124                                                        GList                      *uris,
 125                                                        GAppLaunchContext          *launch_context,
 126                                                        GSpawnFlags                 spawn_flags,
 127                                                        GSpawnChildSetupFunc        user_setup,
 128                                                        gpointer                    user_setup_data,
 129                                                        GDesktopAppLaunchCallback   pid_callback,
 130                                                        gpointer                    pid_callback_data,
 131                                                        GError                    **error);
 132
 133
 134 G_END_DECLS
 135
 136 #endif /* __G_DESKTOP_APP_INFO_H__ */