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_set_current_folder_file (GtkFileChooser    *chooser,
  96                                                           GFile             *file,
  97                                                           GError           **error);
  98 GFile *        _gtk_file_chooser_get_current_folder_file (GtkFileChooser    *chooser);
  99 gboolean       _gtk_file_chooser_select_file             (GtkFileChooser    *chooser,
 100                                                           GFile             *file,
 101                                                           GError           **error);
 102 void           _gtk_file_chooser_unselect_file           (GtkFileChooser    *chooser,
 103                                                           GFile             *file);
 104 GSList *       _gtk_file_chooser_get_files               (GtkFileChooser    *chooser);
 105 GFile *        _gtk_file_chooser_get_preview_file        (GtkFileChooser    *chooser);
 106 gboolean       _gtk_file_chooser_add_shortcut_folder     (GtkFileChooser    *chooser,
 107                                                           GFile             *folder,
 108                                                           GError           **error);
 109 gboolean       _gtk_file_chooser_remove_shortcut_folder  (GtkFileChooser    *chooser,
 110                                                           GFile             *folder,
 111                                                           GError           **error);
 112 GSList *       _gtk_file_chooser_list_shortcut_folder_files (GtkFileChooser *chooser);
 113
 114 /* GtkFileChooserDialog private */
 115
 116 struct _GtkFileChooserDialogPrivate
 117 {
 118   GtkWidget *widget;
 119
 120   char *file_system;
 121
 122   /* for use with GtkFileChooserEmbed */
 123   gboolean response_requested;
 124 };
 125
 126
 127 /* GtkFileChooserWidget private */
 128
 129 struct _GtkFileChooserWidgetPrivate
 130 {
 131   GtkWidget *impl;
 132
 133   char *file_system;
 134 };
 135
 136
 137 /* GtkFileChooserDefault private */
 138
 139 typedef enum {
 140   LOAD_EMPTY,                   /* There is no model */
 141   LOAD_PRELOAD,                 /* Model is loading and a timer is running; model isn't inserted into the tree yet */
 142   LOAD_LOADING,                 /* Timeout expired, model is inserted into the tree, but not fully loaded yet */
 143   LOAD_FINISHED                 /* Model is fully loaded and inserted into the tree */
 144 } LoadState;
 145
 146 typedef enum {
 147   RELOAD_EMPTY,                 /* No folder has been set */
 148   RELOAD_HAS_FOLDER             /* We have a folder, although it may not be completely loaded yet; no need to reload */
 149 } ReloadState;
 150
 151 typedef enum {
 152   LOCATION_MODE_PATH_BAR,
 153   LOCATION_MODE_FILENAME_ENTRY
 154 } LocationMode;
 155
 156 typedef enum {
 157   OPERATION_MODE_BROWSE,
 158   OPERATION_MODE_SEARCH,
 159   OPERATION_MODE_RECENT
 160 } OperationMode;
 161
 162 struct _GtkFileChooserDefault
 163 {
 164   GtkBox parent_instance;
 165
 166   GtkFileChooserAction action;
 167
 168   GtkFileSystem *file_system;
 169
 170   /* Save mode widgets */
 171   GtkWidget *save_widgets;
 172   GtkWidget *save_widgets_table;
 173
 174   GtkWidget *save_folder_label;
 175
 176   /* The file browsing widgets */
 177   GtkWidget *browse_widgets_box;
 178   GtkWidget *browse_widgets_hpaned;
 179   GtkWidget *browse_header_box;
 180   GtkWidget *browse_shortcuts_tree_view;
 181   GtkWidget *browse_shortcuts_add_button;
 182   GtkWidget *browse_shortcuts_remove_button;
 183   GtkWidget *browse_shortcuts_popup_menu;
 184   GtkWidget *browse_shortcuts_popup_menu_remove_item;
 185   GtkWidget *browse_shortcuts_popup_menu_rename_item;
 186   GtkWidget *browse_files_tree_view;
 187   GtkWidget *browse_files_popup_menu;
 188   GtkWidget *browse_files_popup_menu_add_shortcut_item;
 189   GtkWidget *browse_files_popup_menu_hidden_files_item;
 190   GtkWidget *browse_files_popup_menu_size_column_item;
 191   GtkWidget *browse_files_popup_menu_copy_file_location_item;
 192   GtkWidget *browse_files_popup_menu_visit_file_item;
 193   GtkWidget *browse_new_folder_button;
 194   GtkWidget *browse_path_bar_hbox;
 195   GtkSizeGroup *browse_path_bar_size_group;
 196   GtkWidget *browse_path_bar;
 197   GtkWidget *browse_special_mode_icon;
 198   GtkWidget *browse_special_mode_label;
 199   GtkWidget *browse_select_a_folder_info_bar;
 200   GtkWidget *browse_select_a_folder_label;
 201   GtkWidget *browse_select_a_folder_icon;
 202
 203   GtkFileSystemModel *browse_files_model;
 204   char *browse_files_last_selected_name;
 205
 206   /* OPERATION_MODE_SEARCH */
 207   GtkWidget *search_hbox;
 208   GtkWidget *search_entry;
 209   GtkSearchEngine *search_engine;
 210   GtkQuery *search_query;
 211   GtkFileSystemModel *search_model;
 212
 213   /* OPERATION_MODE_RECENT */
 214   GtkRecentManager *recent_manager;
 215   GtkFileSystemModel *recent_model;
 216   guint load_recent_id;
 217
 218   GtkWidget *filter_combo_hbox;
 219   GtkWidget *filter_combo;
 220   GtkWidget *preview_box;
 221   GtkWidget *preview_label;
 222   GtkWidget *preview_widget;
 223   GtkWidget *extra_align;
 224   GtkWidget *extra_widget;
 225
 226   GtkWidget *location_button;
 227   GtkWidget *location_entry_box;
 228   GtkWidget *location_label;
 229   GtkWidget *location_entry;
 230   LocationMode location_mode;
 231
 232   GtkListStore *shortcuts_model;
 233
 234   /* Filter for the shortcuts pane.  We filter out the "current folder" row and
 235    * the separator that we use for the "Save in folder" combo.
 236    */
 237   GtkTreeModel *shortcuts_pane_filter_model;
 238
 239   /* Handles */
 240   GSList *loading_shortcuts;
 241   GSList *reload_icon_cancellables;
 242   GCancellable *file_list_drag_data_received_cancellable;
 243   GCancellable *update_current_folder_cancellable;
 244   GCancellable *should_respond_get_info_cancellable;
 245   GCancellable *file_exists_get_info_cancellable;
 246   GCancellable *update_from_entry_cancellable;
 247   GCancellable *shortcuts_activate_iter_cancellable;
 248   GSList *pending_cancellables;
 249
 250   LoadState load_state;
 251   ReloadState reload_state;
 252   guint load_timeout_id;
 253
 254   OperationMode operation_mode;
 255
 256   GSList *pending_select_files;
 257
 258   GtkFileFilter *current_filter;
 259   GSList *filters;
 260
 261   int num_volumes;
 262   int num_shortcuts;
 263   int num_bookmarks;
 264
 265   gulong volumes_changed_id;
 266   gulong bookmarks_changed_id;
 267
 268   GFile *current_volume_file;
 269   GFile *current_folder;
 270   GFile *preview_file;
 271   char *preview_display_name;
 272
 273   GtkTreeViewColumn *list_name_column;
 274   GtkCellRenderer *list_name_renderer;
 275   GtkTreeViewColumn *list_mtime_column;
 276   GtkTreeViewColumn *list_size_column;
 277
 278   GSource *edited_idle;
 279   char *edited_new_text;
 280
 281   gulong settings_signal_id;
 282   int icon_size;
 283
 284   GSource *focus_entry_idle;
 285
 286   gulong toplevel_set_focus_id;
 287   GtkWidget *toplevel_last_focus_widget;
 288
 289   gint sort_column;
 290   GtkSortType sort_order;
 291
 292 #if 0
 293   GdkDragContext *shortcuts_drag_context;
 294   GSource *shortcuts_drag_outside_idle;
 295 #endif
 296
 297   /* Flags */
 298
 299   guint local_only : 1;
 300   guint preview_widget_active : 1;
 301   guint use_preview_label : 1;
 302   guint select_multiple : 1;
 303   guint show_hidden : 1;
 304   guint do_overwrite_confirmation : 1;
 305   guint list_sort_ascending : 1;
 306   guint changing_folder : 1;
 307   guint shortcuts_current_folder_active : 1;
 308   guint has_home : 1;
 309   guint has_desktop : 1;
 310   guint has_search : 1;
 311   guint show_size_column : 1;
 312   guint create_folders : 1;
 313
 314 #if 0
 315   guint shortcuts_drag_outside : 1;
 316 #endif
 317 };
 318
 319
 320 G_END_DECLS
 321
 322 #endif /* __GTK_FILE_CHOOSER_PRIVATE_H__ */