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 "gtkrecentmanager.h"
  29 #include "gtksearchengine.h"
  30 #include "gtkquery.h"
  31 #include "gtksizegroup.h"
  32 #include "gtktreemodelsort.h"
  33 #include "gtktreestore.h"
  34 #include "gtktreeview.h"
  35 #include "gtkvbox.h"
  36
  37 G_BEGIN_DECLS
  38
  39 #define GTK_FILE_CHOOSER_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_FILE_CHOOSER, GtkFileChooserIface))
  40
  41 typedef struct _GtkFileChooserIface GtkFileChooserIface;
  42
  43 struct _GtkFileChooserIface
  44 {
  45   GTypeInterface base_iface;
  46
  47   /* Methods
  48    */
  49   gboolean       (*set_current_folder)     (GtkFileChooser    *chooser,
  50                                             GFile             *file,
  51                                             GError           **error);
  52   GFile *        (*get_current_folder)     (GtkFileChooser    *chooser);
  53   void           (*set_current_name)       (GtkFileChooser    *chooser,
  54                                             const gchar       *name);
  55   gboolean       (*select_file)            (GtkFileChooser    *chooser,
  56                                             GFile             *file,
  57                                             GError           **error);
  58   void           (*unselect_file)          (GtkFileChooser    *chooser,
  59                                             GFile             *file);
  60   void           (*select_all)             (GtkFileChooser    *chooser);
  61   void           (*unselect_all)           (GtkFileChooser    *chooser);
  62   GSList *       (*get_files)              (GtkFileChooser    *chooser);
  63   GFile *        (*get_preview_file)       (GtkFileChooser    *chooser);
  64   GtkFileSystem *(*get_file_system)        (GtkFileChooser    *chooser);
  65   void           (*add_filter)             (GtkFileChooser    *chooser,
  66                                             GtkFileFilter     *filter);
  67   void           (*remove_filter)          (GtkFileChooser    *chooser,
  68                                             GtkFileFilter     *filter);
  69   GSList *       (*list_filters)           (GtkFileChooser    *chooser);
  70   gboolean       (*add_shortcut_folder)    (GtkFileChooser    *chooser,
  71                                             GFile             *file,
  72                                             GError           **error);
  73   gboolean       (*remove_shortcut_folder) (GtkFileChooser    *chooser,
  74                                             GFile             *file,
  75                                             GError           **error);
  76   GSList *       (*list_shortcut_folders)  (GtkFileChooser    *chooser);
  77
  78   /* Signals
  79    */
  80   void (*current_folder_changed) (GtkFileChooser *chooser);
  81   void (*selection_changed)      (GtkFileChooser *chooser);
  82   void (*update_preview)         (GtkFileChooser *chooser);
  83   void (*file_activated)         (GtkFileChooser *chooser);
  84   GtkFileChooserConfirmation (*confirm_overwrite) (GtkFileChooser *chooser);
  85 };
  86
  87 GtkFileSystem *_gtk_file_chooser_get_file_system         (GtkFileChooser    *chooser);
  88 gboolean       _gtk_file_chooser_set_current_folder_file (GtkFileChooser    *chooser,
  89                                                           GFile             *file,
  90                                                           GError           **error);
  91 GFile *        _gtk_file_chooser_get_current_folder_file (GtkFileChooser    *chooser);
  92 gboolean       _gtk_file_chooser_select_file             (GtkFileChooser    *chooser,
  93                                                           GFile             *file,
  94                                                           GError           **error);
  95 void           _gtk_file_chooser_unselect_file           (GtkFileChooser    *chooser,
  96                                                           GFile             *file);
  97 GSList *       _gtk_file_chooser_get_files               (GtkFileChooser    *chooser);
  98 GFile *        _gtk_file_chooser_get_preview_file        (GtkFileChooser    *chooser);
  99 gboolean       _gtk_file_chooser_add_shortcut_folder     (GtkFileChooser    *chooser,
 100                                                           GFile             *folder,
 101                                                           GError           **error);
 102 gboolean       _gtk_file_chooser_remove_shortcut_folder  (GtkFileChooser    *chooser,
 103                                                           GFile             *folder,
 104                                                           GError           **error);
 105 GSList *       _gtk_file_chooser_list_shortcut_folder_files (GtkFileChooser *chooser);
 106
 107 /* GtkFileChooserDialog private */
 108
 109 struct _GtkFileChooserDialogPrivate
 110 {
 111   GtkWidget *widget;
 112
 113   char *file_system;
 114
 115   /* for use with GtkFileChooserEmbed */
 116   gboolean response_requested;
 117 };
 118
 119
 120 /* GtkFileChooserWidget private */
 121
 122 struct _GtkFileChooserWidgetPrivate
 123 {
 124   GtkWidget *impl;
 125
 126   char *file_system;
 127 };
 128
 129
 130 /* GtkFileChooserDefault private */
 131
 132 typedef enum {
 133   LOAD_EMPTY,                   /* There is no model */
 134   LOAD_PRELOAD,                 /* Model is loading and a timer is running; model isn't inserted into the tree yet */
 135   LOAD_LOADING,                 /* Timeout expired, model is inserted into the tree, but not fully loaded yet */
 136   LOAD_FINISHED                 /* Model is fully loaded and inserted into the tree */
 137 } LoadState;
 138
 139 typedef enum {
 140   RELOAD_EMPTY,                 /* No folder has been set */
 141   RELOAD_HAS_FOLDER,            /* We have a folder, although it may not be completely loaded yet; no need to reload */
 142   RELOAD_WAS_UNMAPPED           /* We had a folder but got unmapped; reload is needed */
 143 } ReloadState;
 144
 145 typedef enum {
 146   LOCATION_MODE_PATH_BAR,
 147   LOCATION_MODE_FILENAME_ENTRY
 148 } LocationMode;
 149
 150 typedef enum {
 151   OPERATION_MODE_BROWSE,
 152   OPERATION_MODE_SEARCH,
 153   OPERATION_MODE_RECENT
 154 } OperationMode;
 155
 156 struct _GtkFileChooserDefault
 157 {
 158   GtkVBox parent_instance;
 159
 160   GtkFileChooserAction action;
 161
 162   GtkFileSystem *file_system;
 163
 164   /* Save mode widgets */
 165   GtkWidget *save_widgets;
 166
 167   GtkWidget *save_folder_label;
 168   GtkWidget *save_folder_combo;
 169   GtkWidget *save_expander;
 170
 171   /* The file browsing widgets */
 172   GtkWidget *browse_widgets;
 173   GtkWidget *browse_shortcuts_tree_view;
 174   GtkWidget *browse_shortcuts_add_button;
 175   GtkWidget *browse_shortcuts_remove_button;
 176   GtkWidget *browse_shortcuts_popup_menu;
 177   GtkWidget *browse_shortcuts_popup_menu_remove_item;
 178   GtkWidget *browse_shortcuts_popup_menu_rename_item;
 179   GtkWidget *browse_files_tree_view;
 180   GtkWidget *browse_files_popup_menu;
 181   GtkWidget *browse_files_popup_menu_add_shortcut_item;
 182   GtkWidget *browse_files_popup_menu_hidden_files_item;
 183   GtkWidget *browse_files_popup_menu_size_column_item;
 184   GtkWidget *browse_new_folder_button;
 185   GtkWidget *browse_path_bar_hbox;
 186   GtkSizeGroup *browse_path_bar_size_group;
 187   GtkWidget *browse_path_bar;
 188
 189   GtkFileSystemModel *browse_files_model;
 190   char *browse_files_last_selected_name;
 191
 192   /* OPERATION_MODE_SEARCH */
 193   GtkWidget *search_hbox;
 194   GtkWidget *search_entry;
 195   GtkSearchEngine *search_engine;
 196   GtkQuery *search_query;
 197   GtkListStore *search_model;
 198   GtkTreeModelFilter *search_model_filter;
 199   GtkTreeModelSort *search_model_sort;
 200
 201   /* OPERATION_MODE_RECENT */
 202   GtkWidget *recent_hbox;
 203   GtkRecentManager *recent_manager;
 204   GtkListStore *recent_model;
 205   guint load_recent_id;
 206   GtkTreeModelFilter *recent_model_filter;
 207   GtkTreeModelSort *recent_model_sort;
 208
 209   GtkWidget *filter_combo_hbox;
 210   GtkWidget *filter_combo;
 211   GtkWidget *preview_box;
 212   GtkWidget *preview_label;
 213   GtkWidget *preview_widget;
 214   GtkWidget *extra_align;
 215   GtkWidget *extra_widget;
 216
 217   GtkWidget *location_button;
 218   GtkWidget *location_entry_box;
 219   GtkWidget *location_label;
 220   GtkWidget *location_entry;
 221   LocationMode location_mode;
 222
 223   GtkListStore *shortcuts_model;
 224
 225   /* Filter for the shortcuts pane.  We filter out the "current folder" row and
 226    * the separator that we use for the "Save in folder" combo.
 227    */
 228   GtkTreeModel *shortcuts_pane_filter_model;
 229
 230   /* Filter for the "Save in folder" combo.  We filter out the Search row and
 231    * its separator.
 232    */
 233   GtkTreeModel *shortcuts_combo_filter_model;
 234
 235   GtkTreeModelSort *sort_model;
 236
 237   /* Handles */
 238   GSList *loading_shortcuts;
 239   GSList *reload_icon_cancellables;
 240   GCancellable *file_list_drag_data_received_cancellable;
 241   GCancellable *update_current_folder_cancellable;
 242   GCancellable *show_and_select_files_cancellable;
 243   GCancellable *should_respond_get_info_cancellable;
 244   GCancellable *file_exists_get_info_cancellable;
 245   GCancellable *update_from_entry_cancellable;
 246   GCancellable *shortcuts_activate_iter_cancellable;
 247   GSList *pending_cancellables;
 248
 249   LoadState load_state;
 250   ReloadState reload_state;
 251   guint load_timeout_id;
 252
 253   OperationMode operation_mode;
 254
 255   GSList *pending_select_files;
 256
 257   GtkFileFilter *current_filter;
 258   GSList *filters;
 259
 260   int num_volumes;
 261   int num_shortcuts;
 262   int num_bookmarks;
 263
 264   gulong volumes_changed_id;
 265   gulong bookmarks_changed_id;
 266
 267   GFile *current_volume_file;
 268   GFile *current_folder;
 269   GFile *preview_file;
 270   char *preview_display_name;
 271
 272   GtkTreeViewColumn *list_name_column;
 273   GtkCellRenderer *list_name_renderer;
 274   GtkTreeViewColumn *list_mtime_column;
 275   GtkTreeViewColumn *list_size_column;
 276
 277   GSource *edited_idle;
 278   char *edited_new_text;
 279
 280   gulong settings_signal_id;
 281   int icon_size;
 282
 283   gulong toplevel_set_focus_id;
 284   GtkWidget *toplevel_last_focus_widget;
 285
 286   gint sort_column;
 287   GtkSortType sort_order;
 288
 289 #if 0
 290   GdkDragContext *shortcuts_drag_context;
 291   GSource *shortcuts_drag_outside_idle;
 292 #endif
 293
 294   /* Flags */
 295
 296   guint local_only : 1;
 297   guint preview_widget_active : 1;
 298   guint use_preview_label : 1;
 299   guint select_multiple : 1;
 300   guint show_hidden : 1;
 301   guint do_overwrite_confirmation : 1;
 302   guint list_sort_ascending : 1;
 303   guint changing_folder : 1;
 304   guint shortcuts_current_folder_active : 1;
 305   guint expand_folders : 1;
 306   guint has_home : 1;
 307   guint has_desktop : 1;
 308   guint has_search : 1;
 309   guint has_recent : 1;
 310   guint show_size_column : 1;
 311
 312 #if 0
 313   guint shortcuts_drag_outside : 1;
 314 #endif
 315 };
 316
 317
 318 /* GtkFileSystemModel private */
 319
 320 typedef struct _FileModelNode           FileModelNode;
 321
 322 struct _GtkFileSystemModel
 323 {
 324   GObject parent_instance;
 325
 326   GtkFileSystem  *file_system;
 327   gchar          *attributes;
 328   FileModelNode  *roots;
 329   GtkFolder      *root_folder;
 330   GFile          *root_file;
 331
 332   GtkFileSystemModelFilter filter_func;
 333   gpointer filter_data;
 334
 335   GSList *idle_clears;
 336   GSource *idle_clear_source;
 337
 338   gushort max_depth;
 339
 340   GSList *pending_cancellables;
 341
 342   guint show_hidden : 1;
 343   guint show_folders : 1;
 344   guint show_files : 1;
 345   guint folders_only : 1;
 346   guint has_editable : 1;
 347 };
 348
 349 struct _FileModelNode
 350 {
 351   GFile *file;
 352   FileModelNode *next;
 353
 354   GFileInfo *info;
 355   GtkFolder *folder;
 356
 357   FileModelNode *children;
 358   FileModelNode *parent;
 359   GtkFileSystemModel *model;
 360
 361   guint ref_count;
 362   guint n_referenced_children;
 363
 364   gushort depth;
 365
 366   guint has_dummy : 1;
 367   guint is_dummy : 1;
 368   guint is_visible : 1;
 369   guint loaded : 1;
 370   guint idle_clear : 1;
 371   guint load_pending : 1;
 372 };
 373
 374
 375 G_END_DECLS
 376
 377 #endif /* __GTK_FILE_CHOOSER_PRIVATE_H__ */