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#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
25#error "Only <gtk/gtk.h> can be included directly."
26#endif
27
28#include <gdk-pixbuf/gdk-pixbuf.h>
29#include <gdk/gdk.h>
30#include <time.h>
31
32G_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
43typedef struct _GtkRecentInfo GtkRecentInfo;
44typedef struct _GtkRecentData GtkRecentData;
45typedef struct _GtkRecentManager GtkRecentManager;
46typedef struct _GtkRecentManagerClass GtkRecentManagerClass;
47typedef 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 **/
69struct _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
84struct _GtkRecentManager
85{
86 /*< private >*/
87 GObject parent_instance;
88
89 GtkRecentManagerPrivate *GSEAL (priv);
90};
91
92struct _GtkRecentManagerClass
93{
94 /*< private >*/
95 GObjectClass parent_class;
96
97 void (*changed) (GtkRecentManager *manager);
98
99 /* padding for future expansion */
100 void (*_gtk_recent1) (void);
101 void (*_gtk_recent2) (void);
102 void (*_gtk_recent3) (void);
103 void (*_gtk_recent4) (void);
104};
105
106/**
107 * GtkRecentManagerError:
108 * @GTK_RECENT_MANAGER_ERROR_NOT_FOUND: the URI specified does not exists in
109 * the recently used resources list.
110 * @GTK_RECENT_MANAGER_ERROR_INVALID_URI: the URI specified is not valid.
111 * @GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING: the supplied string is not
112 * UTF-8 encoded.
113 * @GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED: no application has registered
114 * the specified item.
115 * @GTK_RECENT_MANAGER_ERROR_READ: failure while reading the recently used
116 * resources file.
117 * @GTK_RECENT_MANAGER_ERROR_WRITE: failure while writing the recently used
118 * resources file.
119 * @GTK_RECENT_MANAGER_ERROR_UNKNOWN: unspecified error.
120 *
121 * Error codes for GtkRecentManager operations
122 **/
123typedef enum
124{
125 GTK_RECENT_MANAGER_ERROR_NOT_FOUND,
126 GTK_RECENT_MANAGER_ERROR_INVALID_URI,
127 GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING,
128 GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED,
129 GTK_RECENT_MANAGER_ERROR_READ,
130 GTK_RECENT_MANAGER_ERROR_WRITE,
131 GTK_RECENT_MANAGER_ERROR_UNKNOWN
132} GtkRecentManagerError;
133
134#define GTK_RECENT_MANAGER_ERROR (gtk_recent_manager_error_quark ())
135GQuark gtk_recent_manager_error_quark (void);
136
137
138GType gtk_recent_manager_get_type (void) G_GNUC_CONST;
139
140GtkRecentManager *gtk_recent_manager_new (void);
141GtkRecentManager *gtk_recent_manager_get_default (void);
142
143#ifndef GTK_DISABLE_DEPRECATED
144GtkRecentManager *gtk_recent_manager_get_for_screen (GdkScreen *screen);
145void gtk_recent_manager_set_screen (GtkRecentManager *manager,
146 GdkScreen *screen);
147#endif
148
149gboolean gtk_recent_manager_add_item (GtkRecentManager *manager,
150 const gchar *uri);
151gboolean gtk_recent_manager_add_full (GtkRecentManager *manager,
152 const gchar *uri,
153 const GtkRecentData *recent_data);
154gboolean gtk_recent_manager_remove_item (GtkRecentManager *manager,
155 const gchar *uri,
156 GError **error);
157GtkRecentInfo * gtk_recent_manager_lookup_item (GtkRecentManager *manager,
158 const gchar *uri,
159 GError **error);
160gboolean gtk_recent_manager_has_item (GtkRecentManager *manager,
161 const gchar *uri);
162gboolean gtk_recent_manager_move_item (GtkRecentManager *manager,
163 const gchar *uri,
164 const gchar *new_uri,
165 GError **error);
166void gtk_recent_manager_set_limit (GtkRecentManager *manager,
167 gint limit);
168gint gtk_recent_manager_get_limit (GtkRecentManager *manager);
169GList * gtk_recent_manager_get_items (GtkRecentManager *manager);
170gint gtk_recent_manager_purge_items (GtkRecentManager *manager,
171 GError **error);
172
173
174GType gtk_recent_info_get_type (void) G_GNUC_CONST;
175
176GtkRecentInfo * gtk_recent_info_ref (GtkRecentInfo *info);
177void gtk_recent_info_unref (GtkRecentInfo *info);
178
179const gchar * gtk_recent_info_get_uri (GtkRecentInfo *info);
180const gchar * gtk_recent_info_get_display_name (GtkRecentInfo *info);
181const gchar * gtk_recent_info_get_description (GtkRecentInfo *info);
182const gchar * gtk_recent_info_get_mime_type (GtkRecentInfo *info);
183time_t gtk_recent_info_get_added (GtkRecentInfo *info);
184time_t gtk_recent_info_get_modified (GtkRecentInfo *info);
185time_t gtk_recent_info_get_visited (GtkRecentInfo *info);
186gboolean gtk_recent_info_get_private_hint (GtkRecentInfo *info);
187gboolean gtk_recent_info_get_application_info (GtkRecentInfo *info,
188 const gchar *app_name,
189 const gchar **app_exec,
190 guint *count,
191 time_t *time_);
192gchar ** gtk_recent_info_get_applications (GtkRecentInfo *info,
193 gsize *length) G_GNUC_MALLOC;
194gchar * gtk_recent_info_last_application (GtkRecentInfo *info) G_GNUC_MALLOC;
195gboolean gtk_recent_info_has_application (GtkRecentInfo *info,
196 const gchar *app_name);
197gchar ** gtk_recent_info_get_groups (GtkRecentInfo *info,
198 gsize *length) G_GNUC_MALLOC;
199gboolean gtk_recent_info_has_group (GtkRecentInfo *info,
200 const gchar *group_name);
201GdkPixbuf * gtk_recent_info_get_icon (GtkRecentInfo *info,
202 gint size);
203gchar * gtk_recent_info_get_short_name (GtkRecentInfo *info) G_GNUC_MALLOC;
204gchar * gtk_recent_info_get_uri_display (GtkRecentInfo *info) G_GNUC_MALLOC;
205gint gtk_recent_info_get_age (GtkRecentInfo *info);
206gboolean gtk_recent_info_is_local (GtkRecentInfo *info);
207gboolean gtk_recent_info_exists (GtkRecentInfo *info);
208gboolean gtk_recent_info_match (GtkRecentInfo *info_a,
209 GtkRecentInfo *info_b);
210
211/* private */
212void _gtk_recent_manager_sync (void);
213
214G_END_DECLS
215
216#endif /* __GTK_RECENT_MANAGER_H__ */
217