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 SETTINGS_KEY_LOCATION_MODE       "location-mode"
  38 #define SETTINGS_KEY_SHOW_HIDDEN         "show-hidden"
  39 #define SETTINGS_KEY_SHOW_SIZE_COLUMN    "show-size-column"
  40 #define SETTINGS_KEY_SORT_COLUMN         "sort-column"
  41 #define SETTINGS_KEY_SORT_ORDER          "sort-order"
  42 #define SETTINGS_KEY_WINDOW_POSITION     "window-position"
  43 #define SETTINGS_KEY_WINDOW_SIZE         "window-size"
  44 #define SETTINGS_KEY_SIDEBAR_WIDTH       "sidebar-width"
  45
  46 #define GTK_FILE_CHOOSER_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_FILE_CHOOSER, GtkFileChooserIface))
  47
  48 typedef struct _GtkFileChooserIface GtkFileChooserIface;
  49
  50 struct _GtkFileChooserIface
  51 {
  52   GTypeInterface base_iface;
  53
  54   /* Methods
  55    */
  56   gboolean       (*set_current_folder)     (GtkFileChooser    *chooser,
  57                                             GFile             *file,
  58                                             GError           **error);
  59   GFile *        (*get_current_folder)     (GtkFileChooser    *chooser);
  60   void           (*set_current_name)       (GtkFileChooser    *chooser,
  61                                             const gchar       *name);
  62   gboolean       (*select_file)            (GtkFileChooser    *chooser,
  63                                             GFile             *file,
  64                                             GError           **error);
  65   void           (*unselect_file)          (GtkFileChooser    *chooser,
  66                                             GFile             *file);
  67   void           (*select_all)             (GtkFileChooser    *chooser);
  68   void           (*unselect_all)           (GtkFileChooser    *chooser);
  69   GSList *       (*get_files)              (GtkFileChooser    *chooser);
  70   GFile *        (*get_preview_file)       (GtkFileChooser    *chooser);
  71   GtkFileSystem *(*get_file_system)        (GtkFileChooser    *chooser);
  72   void           (*add_filter)             (GtkFileChooser    *chooser,
  73                                             GtkFileFilter     *filter);
  74   void           (*remove_filter)          (GtkFileChooser    *chooser,
  75                                             GtkFileFilter     *filter);
  76   GSList *       (*list_filters)           (GtkFileChooser    *chooser);
  77   gboolean       (*add_shortcut_folder)    (GtkFileChooser    *chooser,
  78                                             GFile             *file,
  79                                             GError           **error);
  80   gboolean       (*remove_shortcut_folder) (GtkFileChooser    *chooser,
  81                                             GFile             *file,
  82                                             GError           **error);
  83   GSList *       (*list_shortcut_folders)  (GtkFileChooser    *chooser);
  84
  85   /* Signals
  86    */
  87   void (*current_folder_changed) (GtkFileChooser *chooser);
  88   void (*selection_changed)      (GtkFileChooser *chooser);
  89   void (*update_preview)         (GtkFileChooser *chooser);
  90   void (*file_activated)         (GtkFileChooser *chooser);
  91   GtkFileChooserConfirmation (*confirm_overwrite) (GtkFileChooser *chooser);
  92 };
  93
  94 GtkFileSystem *_gtk_file_chooser_get_file_system         (GtkFileChooser    *chooser);
  95 gboolean       _gtk_file_chooser_add_shortcut_folder     (GtkFileChooser    *chooser,
  96                                                           GFile             *folder,
  97                                                           GError           **error);
  98 gboolean       _gtk_file_chooser_remove_shortcut_folder  (GtkFileChooser    *chooser,
  99                                                           GFile             *folder,
 100                                                           GError           **error);
 101 GSList *       _gtk_file_chooser_list_shortcut_folder_files (GtkFileChooser *chooser);
 102
 103 /* GtkFileChooserDialog private */
 104
 105 struct _GtkFileChooserDialogPrivate
 106 {
 107   GtkWidget *widget;
 108
 109   char *file_system;
 110
 111   /* for use with GtkFileChooserEmbed */
 112   gboolean response_requested;
 113 };
 114
 115
 116 /* GtkFileChooserWidget private */
 117
 118 struct _GtkFileChooserWidgetPrivate
 119 {
 120   GtkWidget *impl;
 121
 122   char *file_system;
 123 };
 124
 125
 126 /* GtkFileChooserDefault private */
 127
 128 typedef enum {
 129   LOAD_EMPTY,                   /* There is no model */
 130   LOAD_PRELOAD,                 /* Model is loading and a timer is running; model isn't inserted into the tree yet */
 131   LOAD_LOADING,                 /* Timeout expired, model is inserted into the tree, but not fully loaded yet */
 132   LOAD_FINISHED                 /* Model is fully loaded and inserted into the tree */
 133 } LoadState;
 134
 135 typedef enum {
 136   RELOAD_EMPTY,                 /* No folder has been set */
 137   RELOAD_HAS_FOLDER             /* We have a folder, although it may not be completely loaded yet; no need to reload */
 138 } ReloadState;
 139
 140 typedef enum {
 141   LOCATION_MODE_PATH_BAR,
 142   LOCATION_MODE_FILENAME_ENTRY
 143 } LocationMode;
 144
 145 typedef enum {
 146   OPERATION_MODE_BROWSE,
 147   OPERATION_MODE_SEARCH,
 148   OPERATION_MODE_RECENT
 149 } OperationMode;
 150
 151 struct _GtkFileChooserDefault
 152 {
 153   GtkBox parent_instance;
 154
 155   GtkFileChooserAction action;
 156
 157   GtkFileSystem *file_system;
 158
 159   /* Save mode widgets */
 160   GtkWidget *save_widgets;
 161   GtkWidget *save_widgets_table;
 162
 163   GtkWidget *save_folder_label;
 164
 165   /* The file browsing widgets */
 166   GtkWidget *browse_widgets_box;
 167   GtkWidget *browse_widgets_hpaned;
 168   GtkWidget *browse_header_box;
 169   GtkWidget *browse_shortcuts_tree_view;
 170   GtkWidget *browse_shortcuts_add_button;
 171   GtkWidget *browse_shortcuts_remove_button;
 172   GtkWidget *browse_shortcuts_popup_menu;
 173   GtkWidget *browse_shortcuts_popup_menu_remove_item;
 174   GtkWidget *browse_shortcuts_popup_menu_rename_item;
 175   GtkWidget *browse_files_tree_view;
 176   GtkWidget *browse_files_popup_menu;
 177   GtkWidget *browse_files_popup_menu_add_shortcut_item;
 178   GtkWidget *browse_files_popup_menu_hidden_files_item;
 179   GtkWidget *browse_files_popup_menu_size_column_item;
 180   GtkWidget *browse_files_popup_menu_copy_file_location_item;
 181   GtkWidget *browse_files_popup_menu_visit_file_item;
 182   GtkWidget *browse_new_folder_button;
 183   GtkWidget *browse_path_bar_hbox;
 184   GtkSizeGroup *browse_path_bar_size_group;
 185   GtkWidget *browse_path_bar;
 186   GtkWidget *browse_special_mode_icon;
 187   GtkWidget *browse_special_mode_label;
 188   GtkWidget *browse_select_a_folder_info_bar;
 189   GtkWidget *browse_select_a_folder_label;
 190   GtkWidget *browse_select_a_folder_icon;
 191
 192   GtkFileSystemModel *browse_files_model;
 193   char *browse_files_last_selected_name;
 194
 195   /* OPERATION_MODE_SEARCH */
 196   GtkWidget *search_hbox;
 197   GtkWidget *search_entry;
 198   GtkSearchEngine *search_engine;
 199   GtkQuery *search_query;
 200   GtkFileSystemModel *search_model;
 201
 202   /* OPERATION_MODE_RECENT */
 203   GtkRecentManager *recent_manager;
 204   GtkFileSystemModel *recent_model;
 205   guint load_recent_id;
 206
 207   GtkWidget *filter_combo_hbox;
 208   GtkWidget *filter_combo;
 209   GtkWidget *preview_box;
 210   GtkWidget *preview_label;
 211   GtkWidget *preview_widget;
 212   GtkWidget *extra_align;
 213   GtkWidget *extra_widget;
 214
 215   GtkWidget *location_button;
 216   GtkWidget *location_entry_box;
 217   GtkWidget *location_label;
 218   GtkWidget *location_entry;
 219   LocationMode location_mode;
 220
 221   GtkListStore *shortcuts_model;
 222
 223   /* Filter for the shortcuts pane.  We filter out the "current folder" row and
 224    * the separator that we use for the "Save in folder" combo.
 225    */
 226   GtkTreeModel *shortcuts_pane_filter_model;
 227
 228   /* Handles */
 229   GSList *loading_shortcuts;
 230   GSList *reload_icon_cancellables;
 231   GCancellable *file_list_drag_data_received_cancellable;
 232   GCancellable *update_current_folder_cancellable;
 233   GCancellable *should_respond_get_info_cancellable;
 234   GCancellable *file_exists_get_info_cancellable;
 235   GCancellable *update_from_entry_cancellable;
 236   GCancellable *shortcuts_activate_iter_cancellable;
 237
 238   LoadState load_state;
 239   ReloadState reload_state;
 240   guint load_timeout_id;
 241
 242   OperationMode operation_mode;
 243
 244   GSList *pending_select_files;
 245
 246   GtkFileFilter *current_filter;
 247   GSList *filters;
 248
 249   int num_volumes;
 250   int num_shortcuts;
 251   int num_bookmarks;
 252
 253   gulong volumes_changed_id;
 254   gulong bookmarks_changed_id;
 255
 256   GFile *current_volume_file;
 257   GFile *current_folder;
 258   GFile *preview_file;
 259   char *preview_display_name;
 260
 261   GtkTreeViewColumn *list_name_column;
 262   GtkCellRenderer *list_name_renderer;
 263   GtkTreeViewColumn *list_mtime_column;
 264   GtkTreeViewColumn *list_size_column;
 265
 266   GSource *edited_idle;
 267   char *edited_new_text;
 268
 269   gulong settings_signal_id;
 270   int icon_size;
 271
 272   GSource *focus_entry_idle;
 273
 274   gulong toplevel_set_focus_id;
 275   GtkWidget *toplevel_last_focus_widget;
 276
 277   gint sort_column;
 278   GtkSortType sort_order;
 279
 280 #if 0
 281   GdkDragContext *shortcuts_drag_context;
 282   GSource *shortcuts_drag_outside_idle;
 283 #endif
 284
 285   /* Flags */
 286
 287   guint local_only : 1;
 288   guint preview_widget_active : 1;
 289   guint use_preview_label : 1;
 290   guint select_multiple : 1;
 291   guint show_hidden : 1;
 292   guint do_overwrite_confirmation : 1;
 293   guint list_sort_ascending : 1;
 294   guint changing_folder : 1;
 295   guint shortcuts_current_folder_active : 1;
 296   guint has_home : 1;
 297   guint has_desktop : 1;
 298   guint has_search : 1;
 299   guint has_recent: 1;
 300   guint show_size_column : 1;
 301   guint create_folders : 1;
 302
 303 #if 0
 304   guint shortcuts_drag_outside : 1;
 305 #endif
 306 };
 307
 308
 309 G_END_DECLS
 310
 311 #endif /* __GTK_FILE_CHOOSER_PRIVATE_H__ */