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

   1 /* GTK - The GIMP Toolkit
   2  * gtkfilechooserprivate.h: Interface definition for file selector GUIs
   3  * Copyright (C) 2003, 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 Public
  16  * 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
  21 #ifndef __GTK_FILE_CHOOSER_PRIVATE_H__
  22 #define __GTK_FILE_CHOOSER_PRIVATE_H__
  23
  24 #include "gtkfilechooser.h"
  25 #include "gtkfilesystem.h"
  26 #include "gtkfilesystemmodel.h"
  27 #include "gtkliststore.h"
  28 #include "gtktooltips.h"
  29 #include "gtktreemodelsort.h"
  30 #include "gtktreestore.h"
  31 #include "gtktreeview.h"
  32 #include "gtkvbox.h"
  33
  34 G_BEGIN_DECLS
  35
  36 #define GTK_FILE_CHOOSER_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_FILE_CHOOSER, GtkFileChooserIface))
  37
  38 typedef struct _GtkFileChooserIface GtkFileChooserIface;
  39
  40 struct _GtkFileChooserIface
  41 {
  42   GTypeInterface base_iface;
  43
  44   /* Methods
  45    */
  46   gboolean       (*set_current_folder)     (GtkFileChooser    *chooser,
  47                                             const GtkFilePath *path,
  48                                             GError           **error);
  49   GtkFilePath *  (*get_current_folder)     (GtkFileChooser    *chooser);
  50   void           (*set_current_name)       (GtkFileChooser    *chooser,
  51                                             const gchar       *name);
  52   gboolean       (*select_path)            (GtkFileChooser    *chooser,
  53                                             const GtkFilePath *path,
  54                                             GError           **error);
  55   void           (*unselect_path)          (GtkFileChooser    *chooser,
  56                                             const GtkFilePath *path);
  57   void           (*select_all)             (GtkFileChooser    *chooser);
  58   void           (*unselect_all)           (GtkFileChooser    *chooser);
  59   GSList *       (*get_paths)              (GtkFileChooser    *chooser);
  60   GtkFilePath *  (*get_preview_path)       (GtkFileChooser    *chooser);
  61   GtkFileSystem *(*get_file_system)        (GtkFileChooser    *chooser);
  62   void           (*add_filter)             (GtkFileChooser    *chooser,
  63                                             GtkFileFilter     *filter);
  64   void           (*remove_filter)          (GtkFileChooser    *chooser,
  65                                             GtkFileFilter     *filter);
  66   GSList *       (*list_filters)           (GtkFileChooser    *chooser);
  67   gboolean       (*add_shortcut_folder)    (GtkFileChooser    *chooser,
  68                                             const GtkFilePath *path,
  69                                             GError           **error);
  70   gboolean       (*remove_shortcut_folder) (GtkFileChooser    *chooser,
  71                                             const GtkFilePath *path,
  72                                             GError           **error);
  73   GSList *       (*list_shortcut_folders)  (GtkFileChooser    *chooser);
  74
  75   /* Signals
  76    */
  77   void (*current_folder_changed) (GtkFileChooser *chooser);
  78   void (*selection_changed)      (GtkFileChooser *chooser);
  79   void (*update_preview)         (GtkFileChooser *chooser);
  80   void (*file_activated)         (GtkFileChooser *chooser);
  81   GtkFileChooserConfirmation (*confirm_overwrite) (GtkFileChooser *chooser);
  82 };
  83
  84 GtkFileSystem *_gtk_file_chooser_get_file_system         (GtkFileChooser    *chooser);
  85 gboolean       _gtk_file_chooser_set_current_folder_path (GtkFileChooser    *chooser,
  86                                                           const GtkFilePath *path,
  87                                                           GError           **error);
  88 GtkFilePath *  _gtk_file_chooser_get_current_folder_path (GtkFileChooser    *chooser);
  89 gboolean       _gtk_file_chooser_select_path             (GtkFileChooser    *chooser,
  90                                                           const GtkFilePath *path,
  91                                                           GError           **error);
  92 void           _gtk_file_chooser_unselect_path           (GtkFileChooser    *chooser,
  93                                                           const GtkFilePath *path);
  94 GSList *       _gtk_file_chooser_get_paths               (GtkFileChooser    *chooser);
  95 GtkFilePath *  _gtk_file_chooser_get_preview_path        (GtkFileChooser    *chooser);
  96 gboolean       _gtk_file_chooser_add_shortcut_folder     (GtkFileChooser    *chooser,
  97                                                           const GtkFilePath *path,
  98                                                           GError           **error);
  99 gboolean       _gtk_file_chooser_remove_shortcut_folder  (GtkFileChooser    *chooser,
 100                                                           const GtkFilePath *path,
 101                                                           GError           **error);
 102
 103 /* GtkFileChooserDialog private */
 104
 105 struct _GtkFileChooserDialogPrivate
 106 {
 107   GtkWidget *widget;
 108
 109   char *file_system;
 110
 111   /* for use with GtkFileChooserEmbed */
 112   gint default_width;
 113   gint default_height;
 114   gboolean resize_horizontally;
 115   gboolean resize_vertically;
 116 };
 117
 118
 119 /* GtkFileChooserWidget private */
 120
 121 struct _GtkFileChooserWidgetPrivate
 122 {
 123   GtkWidget *impl;
 124
 125   char *file_system;
 126 };
 127
 128
 129 /* GtkFileChooserDefault private */
 130
 131 typedef enum {
 132   LOAD_EMPTY,                   /* There is no model */
 133   LOAD_PRELOAD,                 /* Model is loading and a timer is running; model isn't inserted into the tree yet */
 134   LOAD_LOADING,                 /* Timeout expired, model is inserted into the tree, but not fully loaded yet */
 135   LOAD_FINISHED                 /* Model is fully loaded and inserted into the tree */
 136 } LoadState;
 137
 138 typedef enum {
 139   RELOAD_EMPTY,                 /* No folder has been set */
 140   RELOAD_HAS_FOLDER,            /* We have a folder, although it may not be completely loaded yet; no need to reload */
 141   RELOAD_WAS_UNMAPPED           /* We had a folder but got unmapped; reload is needed */
 142 } ReloadState;
 143
 144 struct _GtkFileChooserDefault
 145 {
 146   GtkVBox parent_instance;
 147
 148   GtkFileChooserAction action;
 149
 150   GtkFileSystem *file_system;
 151
 152   /* Save mode widgets */
 153   GtkWidget *save_widgets;
 154
 155   GtkWidget *save_file_name_entry;
 156   GtkWidget *save_folder_label;
 157   GtkWidget *save_folder_combo;
 158   GtkWidget *save_expander;
 159
 160   /* The file browsing widgets */
 161   GtkWidget *browse_widgets;
 162   GtkWidget *browse_shortcuts_tree_view;
 163   GtkWidget *browse_shortcuts_add_button;
 164   GtkWidget *browse_shortcuts_remove_button;
 165   GtkWidget *browse_shortcuts_popup_menu;
 166   GtkWidget *browse_shortcuts_popup_menu_remove_item;
 167   GtkWidget *browse_shortcuts_popup_menu_rename_item;
 168   GtkWidget *browse_files_tree_view;
 169   GtkWidget *browse_files_popup_menu;
 170   GtkWidget *browse_files_popup_menu_add_shortcut_item;
 171   GtkWidget *browse_files_popup_menu_hidden_files_item;
 172   GtkWidget *browse_new_folder_button;
 173   GtkWidget *browse_path_bar;
 174
 175   GtkFileSystemModel *browse_files_model;
 176
 177   GtkWidget *filter_combo_hbox;
 178   GtkWidget *filter_combo;
 179   GtkWidget *preview_box;
 180   GtkWidget *preview_label;
 181   GtkWidget *preview_widget;
 182   GtkWidget *extra_align;
 183   GtkWidget *extra_widget;
 184
 185   GtkListStore *shortcuts_model;
 186   GtkTreeModel *shortcuts_filter_model;
 187
 188   GtkTreeModelSort *sort_model;
 189
 190   LoadState load_state;
 191   ReloadState reload_state;
 192   guint load_timeout_id;
 193
 194   GSList *pending_select_paths;
 195
 196   GtkFileFilter *current_filter;
 197   GSList *filters;
 198
 199   GtkTooltips *tooltips;
 200
 201   gboolean has_home;
 202   gboolean has_desktop;
 203
 204   int num_volumes;
 205   int num_shortcuts;
 206   int num_bookmarks;
 207
 208   gulong volumes_changed_id;
 209   gulong bookmarks_changed_id;
 210
 211   GtkFilePath *current_volume_path;
 212   GtkFilePath *current_folder;
 213   GtkFilePath *preview_path;
 214   char *preview_display_name;
 215
 216   GtkTreeViewColumn *list_name_column;
 217   GtkCellRenderer *list_name_renderer;
 218
 219   GSource *edited_idle;
 220   char *edited_new_text;
 221
 222   gulong settings_signal_id;
 223   int icon_size;
 224
 225   gulong toplevel_set_focus_id;
 226   GtkWidget *toplevel_last_focus_widget;
 227
 228 #if 0
 229   GdkDragContext *shortcuts_drag_context;
 230   GSource *shortcuts_drag_outside_idle;
 231 #endif
 232
 233   /* Flags */
 234
 235   guint local_only : 1;
 236   guint preview_widget_active : 1;
 237   guint use_preview_label : 1;
 238   guint select_multiple : 1;
 239   guint show_hidden : 1;
 240   guint do_overwrite_confirmation : 1;
 241   guint list_sort_ascending : 1;
 242   guint changing_folder : 1;
 243   guint shortcuts_current_folder_active : 1;
 244
 245 #if 0
 246   guint shortcuts_drag_outside : 1;
 247 #endif
 248 };
 249
 250
 251 /* GtkFileSystemModel private */
 252
 253 typedef struct _FileModelNode           FileModelNode;
 254
 255 struct _GtkFileSystemModel
 256 {
 257   GObject parent_instance;
 258
 259   GtkFileSystem  *file_system;
 260   GtkFileInfoType types;
 261   FileModelNode  *roots;
 262   GtkFileFolder  *root_folder;
 263   GtkFilePath    *root_path;
 264
 265   GtkFileSystemModelFilter filter_func;
 266   gpointer filter_data;
 267
 268   GSList *idle_clears;
 269   GSource *idle_clear_source;
 270   GSource *idle_finished_loading_source;
 271
 272   gushort max_depth;
 273
 274   guint show_hidden : 1;
 275   guint show_folders : 1;
 276   guint show_files : 1;
 277   guint folders_only : 1;
 278   guint has_editable : 1;
 279 };
 280
 281 struct _FileModelNode
 282 {
 283   GtkFilePath *path;
 284   FileModelNode *next;
 285
 286   GtkFileInfo *info;
 287   GtkFileFolder *folder;
 288
 289   FileModelNode *children;
 290   FileModelNode *parent;
 291   GtkFileSystemModel *model;
 292
 293   guint ref_count;
 294   guint n_referenced_children;
 295
 296   gushort depth;
 297
 298   guint has_dummy : 1;
 299   guint is_dummy : 1;
 300   guint is_visible : 1;
 301   guint loaded : 1;
 302   guint idle_clear : 1;
 303 };
 304
 305
 306 G_END_DECLS
 307
 308 #endif /* __GTK_FILE_CHOOSER_PRIVATE_H__ */