Pileus Git - ~andy/gtk/blob - gtk/gtkrecentmanager.h

   1 /* GTK - The GIMP Toolkit
   2  * gtkrecentmanager.h: a manager for the recently used resources
   3  *
   4  * Copyright (C) 2006 Emmanuele Bassi
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  */
  20
  21 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  22 #error "Only <gtk/gtk.h> can be included directly."
  23 #endif
  24
  25 #ifndef __GTK_RECENT_MANAGER_H__
  26 #define __GTK_RECENT_MANAGER_H__
  27
  28 #include <gdk-pixbuf/gdk-pixbuf.h>
  29 #include <gdk/gdk.h>
  30 #include <time.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define GTK_TYPE_RECENT_INFO                    (gtk_recent_info_get_type ())
  35
  36 #define GTK_TYPE_RECENT_MANAGER                 (gtk_recent_manager_get_type ())
  37 #define GTK_RECENT_MANAGER(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_RECENT_MANAGER, GtkRecentManager))
  38 #define GTK_IS_RECENT_MANAGER(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_RECENT_MANAGER))
  39 #define GTK_RECENT_MANAGER_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_RECENT_MANAGER, GtkRecentManagerClass))
  40 #define GTK_IS_RECENT_MANAGER_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_RECENT_MANAGER))
  41 #define GTK_RECENT_MANAGER_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_RECENT_MANAGER, GtkRecentManagerClass))
  42
  43 typedef struct _GtkRecentInfo           GtkRecentInfo;
  44 typedef struct _GtkRecentData           GtkRecentData;
  45 typedef struct _GtkRecentManager        GtkRecentManager;
  46 typedef struct _GtkRecentManagerClass   GtkRecentManagerClass;
  47 typedef struct _GtkRecentManagerPrivate GtkRecentManagerPrivate;
  48
  49 /**
  50  * GtkRecentData:
  51  * @display_name: a UTF-8 encoded string, containing the name of the recently
  52  *   used resource to be displayed, or %NULL;
  53  * @description: a UTF-8 encoded string, containing a short description of
  54  *   the resource, or %NULL;
  55  * @mime_type: the MIME type of the resource;
  56  * @app_name: the name of the application that is registering this recently
  57  *   used resource;
  58  * @app_exec: command line used to launch this resource; may contain the
  59  *   "&percnt;f" and "&percnt;u" escape characters which will be expanded
  60  *   to the resource file path and URI respectively when the command line
  61  *   is retrieved;
  62  * @groups: a vector of strings containing groups names;
  63  * @is_private: whether this resource should be displayed only by the
  64  *   applications that have registered it or not.
  65  *
  66  * Meta-data to be passed to gtk_recent_manager_add_full() when
  67  * registering a recently used resource.
  68  **/
  69 struct _GtkRecentData
  70 {
  71   gchar *display_name;
  72   gchar *description;
  73
  74   gchar *mime_type;
  75
  76   gchar *app_name;
  77   gchar *app_exec;
  78
  79   gchar **groups;
  80
  81   gboolean is_private;
  82 };
  83
  84 /**
  85  * GtkRecentManager:
  86  *
  87  * <structname>GtkRecentManager</structname> contains only private data
  88  * and should be accessed using the provided API.
  89  *
  90  * Since: 2.10
  91  */
  92 struct _GtkRecentManager
  93 {
  94   /* <private> */
  95   GObject parent_instance;
  96
  97   GtkRecentManagerPrivate *priv;
  98 };
  99
 100 /**
 101  * GtkRecentManagerClass:
 102  *
 103  * <structname>GtkRecentManagerClass</structname> contains only private data.
 104  *
 105  * Since: 2.10
 106  */
 107 struct _GtkRecentManagerClass
 108 {
 109   /*< private >*/
 110   GObjectClass parent_class;
 111
 112   void (*changed) (GtkRecentManager *manager);
 113
 114   /* padding for future expansion */
 115   void (*_gtk_recent1) (void);
 116   void (*_gtk_recent2) (void);
 117   void (*_gtk_recent3) (void);
 118   void (*_gtk_recent4) (void);
 119 };
 120
 121 /**
 122  * GtkRecentManagerError:
 123  * @GTK_RECENT_MANAGER_ERROR_NOT_FOUND: the URI specified does not exists in
 124  *   the recently used resources list.
 125  * @GTK_RECENT_MANAGER_ERROR_INVALID_URI: the URI specified is not valid.
 126  * @GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING: the supplied string is not
 127  *   UTF-8 encoded.
 128  * @GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED: no application has registered
 129  *   the specified item.
 130  * @GTK_RECENT_MANAGER_ERROR_READ: failure while reading the recently used
 131  *   resources file.
 132  * @GTK_RECENT_MANAGER_ERROR_WRITE: failure while writing the recently used
 133  *   resources file.
 134  * @GTK_RECENT_MANAGER_ERROR_UNKNOWN: unspecified error.
 135  *
 136  * Error codes for #GtkRecentManager operations
 137  *
 138  * Since: 2.10
 139  */
 140 typedef enum
 141 {
 142   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
 143   GTK_RECENT_MANAGER_ERROR_INVALID_URI,
 144   GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING,
 145   GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED,
 146   GTK_RECENT_MANAGER_ERROR_READ,
 147   GTK_RECENT_MANAGER_ERROR_WRITE,
 148   GTK_RECENT_MANAGER_ERROR_UNKNOWN
 149 } GtkRecentManagerError;
 150
 151 /**
 152  * GTK_RECENT_MANAGER_ERROR:
 153  *
 154  * The #GError domain for #GtkRecentManager errors.
 155  *
 156  * Since: 2.10
 157  */
 158 #define GTK_RECENT_MANAGER_ERROR        (gtk_recent_manager_error_quark ())
 159 GQuark  gtk_recent_manager_error_quark (void);
 160
 161
 162 GType             gtk_recent_manager_get_type       (void) G_GNUC_CONST;
 163
 164 GtkRecentManager *gtk_recent_manager_new            (void);
 165 GtkRecentManager *gtk_recent_manager_get_default    (void);
 166
 167 gboolean          gtk_recent_manager_add_item       (GtkRecentManager     *manager,
 168                                                      const gchar          *uri);
 169 gboolean          gtk_recent_manager_add_full       (GtkRecentManager     *manager,
 170                                                      const gchar          *uri,
 171                                                      const GtkRecentData  *recent_data);
 172 gboolean          gtk_recent_manager_remove_item    (GtkRecentManager     *manager,
 173                                                      const gchar          *uri,
 174                                                      GError              **error);
 175 GtkRecentInfo *   gtk_recent_manager_lookup_item    (GtkRecentManager     *manager,
 176                                                      const gchar          *uri,
 177                                                      GError              **error);
 178 gboolean          gtk_recent_manager_has_item       (GtkRecentManager     *manager,
 179                                                      const gchar          *uri);
 180 gboolean          gtk_recent_manager_move_item      (GtkRecentManager     *manager,
 181                                                      const gchar          *uri,
 182                                                      const gchar          *new_uri,
 183                                                      GError              **error);
 184 GList *           gtk_recent_manager_get_items      (GtkRecentManager     *manager);
 185 gint              gtk_recent_manager_purge_items    (GtkRecentManager     *manager,
 186                                                      GError              **error);
 187
 188
 189 GType                 gtk_recent_info_get_type             (void) G_GNUC_CONST;
 190
 191 GtkRecentInfo *       gtk_recent_info_ref                  (GtkRecentInfo  *info);
 192 void                  gtk_recent_info_unref                (GtkRecentInfo  *info);
 193
 194 G_CONST_RETURN gchar *gtk_recent_info_get_uri              (GtkRecentInfo  *info);
 195 G_CONST_RETURN gchar *gtk_recent_info_get_display_name     (GtkRecentInfo  *info);
 196 G_CONST_RETURN gchar *gtk_recent_info_get_description      (GtkRecentInfo  *info);
 197 G_CONST_RETURN gchar *gtk_recent_info_get_mime_type        (GtkRecentInfo  *info);
 198 time_t                gtk_recent_info_get_added            (GtkRecentInfo  *info);
 199 time_t                gtk_recent_info_get_modified         (GtkRecentInfo  *info);
 200 time_t                gtk_recent_info_get_visited          (GtkRecentInfo  *info);
 201 gboolean              gtk_recent_info_get_private_hint     (GtkRecentInfo  *info);
 202 gboolean              gtk_recent_info_get_application_info (GtkRecentInfo  *info,
 203                                                             const gchar    *app_name,
 204                                                             const gchar   **app_exec,
 205                                                             guint          *count,
 206                                                             time_t         *time_);
 207 gchar **              gtk_recent_info_get_applications     (GtkRecentInfo  *info,
 208                                                             gsize          *length) G_GNUC_MALLOC;
 209 gchar *               gtk_recent_info_last_application     (GtkRecentInfo  *info) G_GNUC_MALLOC;
 210 gboolean              gtk_recent_info_has_application      (GtkRecentInfo  *info,
 211                                                             const gchar    *app_name);
 212 gchar **              gtk_recent_info_get_groups           (GtkRecentInfo  *info,
 213                                                             gsize          *length) G_GNUC_MALLOC;
 214 gboolean              gtk_recent_info_has_group            (GtkRecentInfo  *info,
 215                                                             const gchar    *group_name);
 216 GdkPixbuf *           gtk_recent_info_get_icon             (GtkRecentInfo  *info,
 217                                                             gint            size);
 218 gchar *               gtk_recent_info_get_short_name       (GtkRecentInfo  *info) G_GNUC_MALLOC;
 219 gchar *               gtk_recent_info_get_uri_display      (GtkRecentInfo  *info) G_GNUC_MALLOC;
 220 gint                  gtk_recent_info_get_age              (GtkRecentInfo  *info);
 221 gboolean              gtk_recent_info_is_local             (GtkRecentInfo  *info);
 222 gboolean              gtk_recent_info_exists               (GtkRecentInfo  *info);
 223 gboolean              gtk_recent_info_match                (GtkRecentInfo  *info_a,
 224                                                             GtkRecentInfo  *info_b);
 225
 226 /* private */
 227 void _gtk_recent_manager_sync (void);
 228
 229 G_END_DECLS
 230
 231 #endif /* __GTK_RECENT_MANAGER_H__ */