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

   1 /* GTK - The GIMP Toolkit
   2  * gtkrecentchooser.h - Abstract interface for recent file selectors GUIs
   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 Lesser 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  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef __GTK_RECENT_CHOOSER_H__
  23 #define __GTK_RECENT_CHOOSER_H__
  24
  25 #include <gtk/gtkwidget.h>
  26
  27 #include "gtkrecentmanager.h"
  28 #include "gtkrecentfilter.h"
  29
  30 G_BEGIN_DECLS
  31
  32 #define GTK_TYPE_RECENT_CHOOSER                 (gtk_recent_chooser_get_type ())
  33 #define GTK_RECENT_CHOOSER(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_RECENT_CHOOSER, GtkRecentChooser))
  34 #define GTK_IS_RECENT_CHOOSER(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_RECENT_CHOOSER))
  35 #define GTK_RECENT_CHOOSER_GET_IFACE(inst)      (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_RECENT_CHOOSER, GtkRecentChooserIface))
  36
  37 /**
  38  * GtkRecentSortType:
  39  * @GTK_RECENT_SORT_NONE: Do not sort the returned list of recently used
  40  *   resources.
  41  * @GTK_RECENT_SORT_MRU: Sort the returned list with the most recently used
  42  *   items first.
  43  * @GTK_RECENT_SORT_LRU: Sort the returned list with the least recently used
  44  *   items first.
  45  * @GTK_RECENT_SORT_CUSTOM: Sort the returned list using a custom sorting
  46  *   function passed using gtk_recent_manager_set_sort_func().
  47  *
  48  * Used to specify the sorting method to be applyed to the recently
  49  * used resource list.
  50  **/
  51 typedef enum
  52 {
  53   GTK_RECENT_SORT_NONE = 0,
  54   GTK_RECENT_SORT_MRU,
  55   GTK_RECENT_SORT_LRU,
  56   GTK_RECENT_SORT_CUSTOM
  57 } GtkRecentSortType;
  58
  59 typedef gint (*GtkRecentSortFunc) (GtkRecentInfo *a,
  60                                    GtkRecentInfo *b,
  61                                    gpointer       user_data);
  62
  63
  64 typedef struct _GtkRecentChooser      GtkRecentChooser; /* dummy */
  65 typedef struct _GtkRecentChooserIface GtkRecentChooserIface;
  66
  67 #define GTK_RECENT_CHOOSER_ERROR        (gtk_recent_chooser_error_quark ())
  68
  69 typedef enum
  70 {
  71   GTK_RECENT_CHOOSER_ERROR_NOT_FOUND,
  72   GTK_RECENT_CHOOSER_ERROR_INVALID_URI
  73 } GtkRecentChooserError;
  74
  75 GQuark  gtk_recent_chooser_error_quark (void);
  76
  77
  78 struct _GtkRecentChooserIface
  79 {
  80   GTypeInterface base_iface;
  81
  82   /*
  83    * Methods
  84    */
  85   gboolean          (* set_current_uri)    (GtkRecentChooser  *chooser,
  86                                             const gchar       *uri,
  87                                             GError           **error);
  88   gchar *           (* get_current_uri)    (GtkRecentChooser  *chooser);
  89   gboolean          (* select_uri)         (GtkRecentChooser  *chooser,
  90                                             const gchar       *uri,
  91                                             GError           **error);
  92   void              (* unselect_uri)       (GtkRecentChooser  *chooser,
  93                                             const gchar       *uri);
  94   void              (* select_all)         (GtkRecentChooser  *chooser);
  95   void              (* unselect_all)       (GtkRecentChooser  *chooser);
  96   GList *           (* get_items)          (GtkRecentChooser  *chooser);
  97   GtkRecentManager *(* get_recent_manager) (GtkRecentChooser  *chooser);
  98   void              (* add_filter)         (GtkRecentChooser  *chooser,
  99                                             GtkRecentFilter   *filter);
 100   void              (* remove_filter)      (GtkRecentChooser  *chooser,
 101                                             GtkRecentFilter   *filter);
 102   GSList *          (* list_filters)       (GtkRecentChooser  *chooser);
 103   void              (* set_sort_func)      (GtkRecentChooser  *chooser,
 104                                             GtkRecentSortFunc  sort_func,
 105                                             gpointer           data,
 106                                             GDestroyNotify     destroy);
 107
 108   /*
 109    * Signals
 110    */
 111   void              (* item_activated)     (GtkRecentChooser  *chooser);
 112   void              (* selection_changed)  (GtkRecentChooser  *chooser);
 113 };
 114
 115 GType   gtk_recent_chooser_get_type    (void) G_GNUC_CONST;
 116
 117 /*
 118  * Configuration
 119  */
 120 void              gtk_recent_chooser_set_show_private    (GtkRecentChooser  *chooser,
 121                                                           gboolean           show_private);
 122 gboolean          gtk_recent_chooser_get_show_private    (GtkRecentChooser  *chooser);
 123 void              gtk_recent_chooser_set_show_not_found  (GtkRecentChooser  *chooser,
 124                                                           gboolean           show_not_found);
 125 gboolean          gtk_recent_chooser_get_show_not_found  (GtkRecentChooser  *chooser);
 126 void              gtk_recent_chooser_set_select_multiple (GtkRecentChooser  *chooser,
 127                                                           gboolean           select_multiple);
 128 gboolean          gtk_recent_chooser_get_select_multiple (GtkRecentChooser  *chooser);
 129 void              gtk_recent_chooser_set_limit           (GtkRecentChooser  *chooser,
 130                                                           gint               limit);
 131 gint              gtk_recent_chooser_get_limit           (GtkRecentChooser  *chooser);
 132 void              gtk_recent_chooser_set_local_only      (GtkRecentChooser  *chooser,
 133                                                           gboolean           local_only);
 134 gboolean          gtk_recent_chooser_get_local_only      (GtkRecentChooser  *chooser);
 135 void              gtk_recent_chooser_set_show_tips       (GtkRecentChooser  *chooser,
 136                                                           gboolean           show_tips);
 137 gboolean          gtk_recent_chooser_get_show_tips       (GtkRecentChooser  *chooser);
 138 void              gtk_recent_chooser_set_show_numbers    (GtkRecentChooser  *chooser,
 139                                                           gboolean           show_numbers);
 140 gboolean          gtk_recent_chooser_get_show_numbers    (GtkRecentChooser  *chooser);
 141 void              gtk_recent_chooser_set_show_icons      (GtkRecentChooser  *chooser,
 142                                                           gboolean           show_icons);
 143 gboolean          gtk_recent_chooser_get_show_icons      (GtkRecentChooser  *chooser);
 144 void              gtk_recent_chooser_set_sort_type       (GtkRecentChooser  *chooser,
 145                                                           GtkRecentSortType  sort_type);
 146 GtkRecentSortType gtk_recent_chooser_get_sort_type       (GtkRecentChooser  *chooser);
 147 void              gtk_recent_chooser_set_sort_func       (GtkRecentChooser  *chooser,
 148                                                           GtkRecentSortFunc  sort_func,
 149                                                           gpointer           sort_data,
 150                                                           GDestroyNotify     data_destroy);
 151
 152 /*
 153  * Items handling
 154  */
 155 gboolean       gtk_recent_chooser_set_current_uri  (GtkRecentChooser  *chooser,
 156                                                     const gchar       *uri,
 157                                                     GError           **error);
 158 gchar *        gtk_recent_chooser_get_current_uri  (GtkRecentChooser  *chooser);
 159 GtkRecentInfo *gtk_recent_chooser_get_current_item (GtkRecentChooser  *chooser);
 160 gboolean       gtk_recent_chooser_select_uri       (GtkRecentChooser  *chooser,
 161                                                     const gchar       *uri,
 162                                                     GError           **error);
 163 void           gtk_recent_chooser_unselect_uri     (GtkRecentChooser  *chooser,
 164                                                     const gchar       *uri);
 165 void           gtk_recent_chooser_select_all       (GtkRecentChooser  *chooser);
 166 void           gtk_recent_chooser_unselect_all     (GtkRecentChooser  *chooser);
 167 GList *        gtk_recent_chooser_get_items        (GtkRecentChooser  *chooser);
 168 gchar **       gtk_recent_chooser_get_uris         (GtkRecentChooser  *chooser,
 169                                                     gsize             *length);
 170
 171 /*
 172  * Filters
 173  */
 174 void             gtk_recent_chooser_add_filter    (GtkRecentChooser *chooser,
 175                                                    GtkRecentFilter  *filter);
 176 void             gtk_recent_chooser_remove_filter (GtkRecentChooser *chooser,
 177                                                    GtkRecentFilter  *filter);
 178 GSList *         gtk_recent_chooser_list_filters  (GtkRecentChooser *chooser);
 179 void             gtk_recent_chooser_set_filter    (GtkRecentChooser *chooser,
 180                                                    GtkRecentFilter  *filter);
 181 GtkRecentFilter *gtk_recent_chooser_get_filter    (GtkRecentChooser *chooser);
 182
 183
 184 G_END_DECLS
 185
 186 #endif /* __GTK_RECENT_CHOOSER_H__ */