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 #ifndef __GTK_RECENT_MANAGER_H__
  22 #define __GTK_RECENT_MANAGER_H__
  23
  24 #include <glib-object.h>
  25 #include <gdk/gdkscreen.h>
  26 #include <gdk-pixbuf/gdk-pixbuf.h>
  27 #include <time.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define GTK_TYPE_RECENT_INFO                    (gtk_recent_info_get_type ())
  32
  33 #define GTK_TYPE_RECENT_MANAGER                 (gtk_recent_manager_get_type ())
  34 #define GTK_RECENT_MANAGER(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_RECENT_MANAGER, GtkRecentManager))
  35 #define GTK_IS_RECENT_MANAGER(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_RECENT_MANAGER))
  36 #define GTK_RECENT_MANAGER_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_RECENT_MANAGER, GtkRecentManagerClass))
  37 #define GTK_IS_RECENT_MANAGER_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_RECENT_MANAGER))
  38 #define GTK_RECENT_MANAGER_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_RECENT_MANAGER, GtkRecentManagerClass))
  39
  40 typedef struct _GtkRecentInfo           GtkRecentInfo;
  41 typedef struct _GtkRecentData           GtkRecentData;
  42 typedef struct _GtkRecentManager        GtkRecentManager;
  43 typedef struct _GtkRecentManagerClass   GtkRecentManagerClass;
  44 typedef struct _GtkRecentManagerPrivate GtkRecentManagerPrivate;
  45
  46 /**
  47  * GtkRecentData:
  48  *
  49  * @display_name: a UTF-8 encoded string, containing the name of the recently
  50  *   used resource to be displayed, or %NULL;
  51  * @description: a UTF-8 encoded string, containing a short description of
  52  *   the resource, or %NULL;
  53  * @mime_type: the MIME type of the resource;
  54  * @app_name: the name of the application that is registering this recently
  55  *   used resource;
  56  * @app_exec: command line used to launch this resource; may contain the
  57  *   "%f" and "%u" escape characters which will be expanded to the resource
  58  *   file path and URI respectively when the command line is retrieved;
  59  * @groups: a vector of strings containing groups names;
  60  * @is_private: whether this resource should be displayed only by the
  61  *   applications that have registered it or not.
  62  *
  63  * Meta-data to be passed to gtk_recent_manager_add_full() when
  64  * registering a recently used resource.
  65  **/
  66 struct _GtkRecentData
  67 {
  68   gchar *display_name;
  69   gchar *description;
  70
  71   gchar *mime_type;
  72
  73   gchar *app_name;
  74   gchar *app_exec;
  75
  76   gchar **groups;
  77
  78   gboolean is_private;
  79 };
  80
  81 struct _GtkRecentManager
  82 {
  83   /*< private >*/
  84   GObject parent_instance;
  85
  86   GtkRecentManagerPrivate *priv;
  87 };
  88
  89 struct _GtkRecentManagerClass
  90 {
  91   /*< private >*/
  92   GObjectClass parent_class;
  93
  94   void (*changed) (GtkRecentManager *manager);
  95
  96   /* padding for future expansion */
  97   void (*_gtk_recent1) (void);
  98   void (*_gtk_recent2) (void);
  99   void (*_gtk_recent3) (void);
 100   void (*_gtk_recent4) (void);
 101 };
 102
 103 /**
 104  * GtkRecentManagerError:
 105  * @GTK_RECENT_MANAGER_ERROR_NOT_FOUND: the URI specified does not exists in
 106  *   the recently used resources list.
 107  * @GTK_RECENT_MANAGER_ERROR_INVALID_URI: the URI specified is not valid.
 108  * @GTK_RECENT_MANAGER_ERROR_INVALID_MIME: the MIME type specified is not
 109  *   valid.
 110  * @GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING: the supplied string is not
 111  *   UTF-8 encoded.
 112  * @GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED: no application has registered
 113  *   the specified item.
 114  * @GTK_RECENT_MANAGER_ERROR_READ: failure while reading the recently used
 115  *   resources file.
 116  * @GTK_RECENT_MANAGER_ERROR_WRITE: failure while writing the recently used
 117  *   resources file.
 118  * @GTK_RECENT_MANAGER_ERROR_UNKNOWN: unspecified error.
 119  *
 120  * Error codes for GtkRecentManager operations
 121  **/
 122 typedef enum
 123 {
 124   GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
 125   GTK_RECENT_MANAGER_ERROR_INVALID_URI,
 126   GTK_RECENT_MANAGER_ERROR_INVALID_MIME,
 127   GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING,
 128   GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED,
 129   GTK_RECENT_MANAGER_ERROR_BAD_EXEC_STRING,
 130   GTK_RECENT_MANAGER_ERROR_READ,
 131   GTK_RECENT_MANAGER_ERROR_WRITE,
 132   GTK_RECENT_MANAGER_ERROR_UNKNOWN
 133 } GtkRecentManagerError;
 134
 135 #define GTK_RECENT_MANAGER_ERROR        (gtk_recent_manager_error_quark ())
 136 GQuark  gtk_recent_manager_error_quark (void);
 137
 138
 139 GType             gtk_recent_manager_get_type       (void) G_GNUC_CONST;
 140
 141 GtkRecentManager *gtk_recent_manager_new            (void);
 142 GtkRecentManager *gtk_recent_manager_get_default    (void);
 143 GtkRecentManager *gtk_recent_manager_get_for_screen (GdkScreen            *screen);
 144
 145 void              gtk_recent_manager_set_screen     (GtkRecentManager     *manager,
 146                                                      GdkScreen            *screen);
 147
 148 gboolean          gtk_recent_manager_add_item       (GtkRecentManager     *manager,
 149                                                      const gchar          *uri,
 150                                                      GError              **error);
 151 gboolean          gtk_recent_manager_add_full       (GtkRecentManager     *manager,
 152                                                      const gchar          *uri,
 153                                                      const GtkRecentData  *recent_data,
 154                                                      GError              **error);
 155 gboolean          gtk_recent_manager_remove_item    (GtkRecentManager     *manager,
 156                                                      const gchar          *uri,
 157                                                      GError              **error);
 158 GtkRecentInfo *   gtk_recent_manager_lookup_item    (GtkRecentManager     *manager,
 159                                                      const gchar          *uri,
 160                                                      GError              **error);
 161 gboolean          gtk_recent_manager_has_item       (GtkRecentManager     *manager,
 162                                                      const gchar          *uri);
 163 gboolean          gtk_recent_manager_move_item      (GtkRecentManager     *manager,
 164                                                      const gchar          *uri,
 165                                                      const gchar          *new_uri,
 166                                                      GError              **error);
 167 void              gtk_recent_manager_set_limit      (GtkRecentManager     *manager,
 168                                                      gint                  limit);
 169 gint              gtk_recent_manager_get_limit      (GtkRecentManager     *manager);
 170 GList *           gtk_recent_manager_get_items      (GtkRecentManager     *manager);
 171 gint              gtk_recent_manager_purge_items    (GtkRecentManager     *manager,
 172                                                      GError              **error);
 173
 174
 175 GType                 gtk_recent_info_get_type             (void) G_GNUC_CONST;
 176
 177 GtkRecentInfo *       gtk_recent_info_ref                  (GtkRecentInfo  *info);
 178 void                  gtk_recent_info_unref                (GtkRecentInfo  *info);
 179
 180 G_CONST_RETURN gchar *gtk_recent_info_get_uri              (GtkRecentInfo  *info);
 181 G_CONST_RETURN gchar *gtk_recent_info_get_display_name     (GtkRecentInfo  *info);
 182 G_CONST_RETURN gchar *gtk_recent_info_get_description      (GtkRecentInfo  *info);
 183 G_CONST_RETURN gchar *gtk_recent_info_get_mime_type        (GtkRecentInfo  *info);
 184 time_t                gtk_recent_info_get_added            (GtkRecentInfo  *info);
 185 time_t                gtk_recent_info_get_modified         (GtkRecentInfo  *info);
 186 time_t                gtk_recent_info_get_visited          (GtkRecentInfo  *info);
 187 gboolean              gtk_recent_info_get_private_hint     (GtkRecentInfo  *info);
 188 gboolean              gtk_recent_info_get_application_info (GtkRecentInfo  *info,
 189                                                             const gchar    *app_name,
 190                                                             gchar         **app_exec,
 191                                                             guint          *count,
 192                                                             time_t         *time);
 193 gchar **              gtk_recent_info_get_applications     (GtkRecentInfo  *info,
 194                                                             gsize          *length) G_GNUC_MALLOC;
 195 gchar *               gtk_recent_info_last_application     (GtkRecentInfo  *info) G_GNUC_MALLOC;
 196 gboolean              gtk_recent_info_has_application      (GtkRecentInfo  *info,
 197                                                             const gchar    *app_name);
 198 gchar **              gtk_recent_info_get_groups           (GtkRecentInfo  *info,
 199                                                             gsize          *length) G_GNUC_MALLOC;
 200 gboolean              gtk_recent_info_has_group            (GtkRecentInfo  *info,
 201                                                             const gchar    *group_name);
 202 GdkPixbuf *           gtk_recent_info_get_icon             (GtkRecentInfo  *info,
 203                                                             gint            size);
 204 gchar *               gtk_recent_info_get_short_name       (GtkRecentInfo  *info) G_GNUC_MALLOC;
 205 gchar *               gtk_recent_info_get_uri_display      (GtkRecentInfo  *info) G_GNUC_MALLOC;
 206 gint                  gtk_recent_info_get_age              (GtkRecentInfo  *info);
 207 gboolean              gtk_recent_info_is_local             (GtkRecentInfo  *info);
 208 gboolean              gtk_recent_info_exists               (GtkRecentInfo  *info);
 209 gboolean              gtk_recent_info_match                (GtkRecentInfo  *info_a,
 210                                                             GtkRecentInfo  *info_b);
 211
 212 G_END_DECLS
 213
 214 #endif /* __GTK_RECENT_MANAGER_H__ */