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