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 GLIB_AVAILABLE_IN_2_38
  90 const gchar * const *   g_desktop_app_info_list_actions                 (GDesktopAppInfo   *info);
  91
  92 GLIB_AVAILABLE_IN_2_38
  93 void                    g_desktop_app_info_launch_action                (GDesktopAppInfo   *info,
  94                                                                          const gchar       *action_name,
  95                                                                          GAppLaunchContext *launch_context);
  96
  97 GLIB_AVAILABLE_IN_2_38
  98 gchar *                 g_desktop_app_info_get_action_name              (GDesktopAppInfo   *info,
  99                                                                          const gchar       *action_name);
 100
 101 #ifndef G_DISABLE_DEPRECATED
 102
 103 #define G_TYPE_DESKTOP_APP_INFO_LOOKUP           (g_desktop_app_info_lookup_get_type ())
 104 #define G_DESKTOP_APP_INFO_LOOKUP(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP, GDesktopAppInfoLookup))
 105 #define G_IS_DESKTOP_APP_INFO_LOOKUP(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP))
 106 #define G_DESKTOP_APP_INFO_LOOKUP_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_DESKTOP_APP_INFO_LOOKUP, GDesktopAppInfoLookupIface))
 107
 108 /**
 109  * G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME:
 110  *
 111  * Extension point for default handler to URI association. See
 112  * <link linkend="extending-gio">Extending GIO</link>.
 113  */
 114 #define G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME "gio-desktop-app-info-lookup"
 115
 116 #endif /* G_DISABLE_DEPRECATED */
 117
 118 /**
 119  * GDesktopAppInfoLookup:
 120  *
 121  * Interface that is used by backends to associate default
 122  * handlers with URI schemes.
 123  */
 124 typedef struct _GDesktopAppInfoLookup GDesktopAppInfoLookup;
 125 typedef struct _GDesktopAppInfoLookupIface GDesktopAppInfoLookupIface;
 126
 127 struct _GDesktopAppInfoLookupIface
 128 {
 129   GTypeInterface g_iface;
 130
 131   GAppInfo * (* get_default_for_uri_scheme) (GDesktopAppInfoLookup *lookup,
 132                                              const char            *uri_scheme);
 133 };
 134
 135 GLIB_DEPRECATED
 136 GType     g_desktop_app_info_lookup_get_type                   (void) G_GNUC_CONST;
 137
 138 GLIB_DEPRECATED
 139 GAppInfo *g_desktop_app_info_lookup_get_default_for_uri_scheme (GDesktopAppInfoLookup *lookup,
 140                                                                 const char            *uri_scheme);
 141
 142 /**
 143  * GDesktopAppLaunchCallback:
 144  * @appinfo: a #GDesktopAppInfo
 145  * @pid: Process identifier
 146  * @user_data: User data
 147  *
 148  * During invocation, g_desktop_app_info_launch_uris_as_manager() may
 149  * create one or more child processes.  This callback is invoked once
 150  * for each, providing the process ID.
 151  */
 152 typedef void (*GDesktopAppLaunchCallback) (GDesktopAppInfo  *appinfo,
 153                                            GPid              pid,
 154                                            gpointer          user_data);
 155
 156 GLIB_AVAILABLE_IN_2_28
 157 gboolean    g_desktop_app_info_launch_uris_as_manager (GDesktopAppInfo            *appinfo,
 158                                                        GList                      *uris,
 159                                                        GAppLaunchContext          *launch_context,
 160                                                        GSpawnFlags                 spawn_flags,
 161                                                        GSpawnChildSetupFunc        user_setup,
 162                                                        gpointer                    user_setup_data,
 163                                                        GDesktopAppLaunchCallback   pid_callback,
 164                                                        gpointer                    pid_callback_data,
 165                                                        GError                    **error);
 166
 167 GLIB_AVAILABLE_IN_2_40
 168 gchar *** g_desktop_app_info_search (const gchar *search_string);
 169
 170 G_END_DECLS
 171
 172 #endif /* __G_DESKTOP_APP_INFO_H__ */