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, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef __GTK_FILE_CHOOSER_PRIVATE_H__
  20 #define __GTK_FILE_CHOOSER_PRIVATE_H__
  21
  22 #include "gtkfilechooser.h"
  23 #include "gtkfilesystem.h"
  24 #include "gtkfilesystemmodel.h"
  25 #include "gtkliststore.h"
  26 #include "gtkrecentmanager.h"
  27 #include "gtksearchengine.h"
  28 #include "gtkquery.h"
  29 #include "gtksizegroup.h"
  30 #include "gtktreemodelsort.h"
  31 #include "gtktreestore.h"
  32 #include "gtktreeview.h"
  33 #include "gtkbox.h"
  34
  35 G_BEGIN_DECLS
  36
  37 #define GTK_FILE_CHOOSER_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_FILE_CHOOSER, GtkFileChooserIface))
  38
  39 typedef struct _GtkFileChooserIface GtkFileChooserIface;
  40
  41 struct _GtkFileChooserIface
  42 {
  43   GTypeInterface base_iface;
  44
  45   /* Methods
  46    */
  47   gboolean       (*set_current_folder)     (GtkFileChooser    *chooser,
  48                                             GFile             *file,
  49                                             GError           **error);
  50   GFile *        (*get_current_folder)     (GtkFileChooser    *chooser);
  51   void           (*set_current_name)       (GtkFileChooser    *chooser,
  52                                             const gchar       *name);
  53   gboolean       (*select_file)            (GtkFileChooser    *chooser,
  54                                             GFile             *file,
  55                                             GError           **error);
  56   void           (*unselect_file)          (GtkFileChooser    *chooser,
  57                                             GFile             *file);
  58   void           (*select_all)             (GtkFileChooser    *chooser);
  59   void           (*unselect_all)           (GtkFileChooser    *chooser);
  60   GSList *       (*get_files)              (GtkFileChooser    *chooser);
  61   GFile *        (*get_preview_file)       (GtkFileChooser    *chooser);
  62   GtkFileSystem *(*get_file_system)        (GtkFileChooser    *chooser);
  63   void           (*add_filter)             (GtkFileChooser    *chooser,
  64                                             GtkFileFilter     *filter);
  65   void           (*remove_filter)          (GtkFileChooser    *chooser,
  66                                             GtkFileFilter     *filter);
  67   GSList *       (*list_filters)           (GtkFileChooser    *chooser);
  68   gboolean       (*add_shortcut_folder)    (GtkFileChooser    *chooser,
  69                                             GFile             *file,
  70                                             GError           **error);
  71   gboolean       (*remove_shortcut_folder) (GtkFileChooser    *chooser,
  72                                             GFile             *file,
  73                                             GError           **error);
  74   GSList *       (*list_shortcut_folders)  (GtkFileChooser    *chooser);
  75
  76   /* Signals
  77    */
  78   void (*current_folder_changed) (GtkFileChooser *chooser);
  79   void (*selection_changed)      (GtkFileChooser *chooser);
  80   void (*update_preview)         (GtkFileChooser *chooser);
  81   void (*file_activated)         (GtkFileChooser *chooser);
  82   GtkFileChooserConfirmation (*confirm_overwrite) (GtkFileChooser *chooser);
  83 };
  84
  85 GtkFileSystem *_gtk_file_chooser_get_file_system         (GtkFileChooser    *chooser);
  86 gboolean       _gtk_file_chooser_set_current_folder_file (GtkFileChooser    *chooser,
  87                                                           GFile             *file,
  88                                                           GError           **error);
  89 GFile *        _gtk_file_chooser_get_current_folder_file (GtkFileChooser    *chooser);
  90 gboolean       _gtk_file_chooser_select_file             (GtkFileChooser    *chooser,
  91                                                           GFile             *file,
  92                                                           GError           **error);
  93 void           _gtk_file_chooser_unselect_file           (GtkFileChooser    *chooser,
  94                                                           GFile             *file);
  95 GSList *       _gtk_file_chooser_get_files               (GtkFileChooser    *chooser);
  96 GFile *        _gtk_file_chooser_get_preview_file        (GtkFileChooser    *chooser);
  97 gboolean       _gtk_file_chooser_add_shortcut_folder     (GtkFileChooser    *chooser,
  98                                                           GFile             *folder,
  99                                                           GError           **error);
 100 gboolean       _gtk_file_chooser_remove_shortcut_folder  (GtkFileChooser    *chooser,
 101                                                           GFile             *folder,
 102                                                           GError           **error);
 103 GSList *       _gtk_file_chooser_list_shortcut_folder_files (GtkFileChooser *chooser);
 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 } ReloadState;
 141
 142 typedef enum {
 143   LOCATION_MODE_PATH_BAR,
 144   LOCATION_MODE_FILENAME_ENTRY
 145 } LocationMode;
 146
 147 typedef enum {
 148   OPERATION_MODE_BROWSE,
 149   OPERATION_MODE_SEARCH,
 150   OPERATION_MODE_RECENT
 151 } OperationMode;
 152
 153 struct _GtkFileChooserDefault
 154 {
 155   GtkBox parent_instance;
 156
 157   GtkFileChooserAction action;
 158
 159   GtkFileSystem *file_system;
 160
 161   /* Save mode widgets */
 162   GtkWidget *save_widgets;
 163   GtkWidget *save_widgets_table;
 164
 165   GtkWidget *save_folder_label;
 166
 167   /* The file browsing widgets */
 168   GtkWidget *browse_widgets_box;
 169   GtkWidget *browse_widgets_hpaned;
 170   GtkWidget *browse_header_box;
 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_files_popup_menu_size_column_item;
 182   GtkWidget *browse_files_popup_menu_copy_file_location_item;
 183   GtkWidget *browse_files_popup_menu_visit_file_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   GtkWidget *browse_special_mode_icon;
 189   GtkWidget *browse_special_mode_label;
 190   GtkWidget *browse_select_a_folder_info_bar;
 191   GtkWidget *browse_select_a_folder_label;
 192   GtkWidget *browse_select_a_folder_icon;
 193
 194   GtkFileSystemModel *browse_files_model;
 195   char *browse_files_last_selected_name;
 196
 197   /* OPERATION_MODE_SEARCH */
 198   GtkWidget *search_hbox;
 199   GtkWidget *search_entry;
 200   GtkSearchEngine *search_engine;
 201   GtkQuery *search_query;
 202   GtkFileSystemModel *search_model;
 203
 204   /* OPERATION_MODE_RECENT */
 205   GtkRecentManager *recent_manager;
 206   GtkFileSystemModel *recent_model;
 207   guint load_recent_id;
 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   /* Handles */
 231   GSList *loading_shortcuts;
 232   GSList *reload_icon_cancellables;
 233   GCancellable *file_list_drag_data_received_cancellable;
 234   GCancellable *update_current_folder_cancellable;
 235   GCancellable *should_respond_get_info_cancellable;
 236   GCancellable *file_exists_get_info_cancellable;
 237   GCancellable *update_from_entry_cancellable;
 238   GCancellable *shortcuts_activate_iter_cancellable;
 239   GSList *pending_cancellables;
 240
 241   LoadState load_state;
 242   ReloadState reload_state;
 243   guint load_timeout_id;
 244
 245   OperationMode operation_mode;
 246
 247   GSList *pending_select_files;
 248
 249   GtkFileFilter *current_filter;
 250   GSList *filters;
 251
 252   int num_volumes;
 253   int num_shortcuts;
 254   int num_bookmarks;
 255
 256   gulong volumes_changed_id;
 257   gulong bookmarks_changed_id;
 258
 259   GFile *current_volume_file;
 260   GFile *current_folder;
 261   GFile *preview_file;
 262   char *preview_display_name;
 263
 264   GtkTreeViewColumn *list_name_column;
 265   GtkCellRenderer *list_name_renderer;
 266   GtkTreeViewColumn *list_mtime_column;
 267   GtkTreeViewColumn *list_size_column;
 268
 269   GSource *edited_idle;
 270   char *edited_new_text;
 271
 272   gulong settings_signal_id;
 273   int icon_size;
 274
 275   GSource *focus_entry_idle;
 276
 277   gulong toplevel_set_focus_id;
 278   GtkWidget *toplevel_last_focus_widget;
 279
 280   gint sort_column;
 281   GtkSortType sort_order;
 282
 283 #if 0
 284   GdkDragContext *shortcuts_drag_context;
 285   GSource *shortcuts_drag_outside_idle;
 286 #endif
 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 has_home : 1;
 300   guint has_desktop : 1;
 301   guint has_search : 1;
 302   guint show_size_column : 1;
 303   guint create_folders : 1;
 304
 305 #if 0
 306   guint shortcuts_drag_outside : 1;
 307 #endif
 308 };
 309
 310
 311 G_END_DECLS
 312
 313 #endif /* __GTK_FILE_CHOOSER_PRIVATE_H__ */