src/dolphinview.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>                  *
   3  *   Copyright (C) 2006 by Gregor Kališnik <gregor@podnapisi.net>          *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program 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         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  19  ***************************************************************************/
  20
  21
  22 #ifndef _DOLPHINVIEW_H_
  23 #define _DOLPHINVIEW_H_
  24
  25 #include <kparts/part.h>
  26 #include <kfileitem.h>
  27 #include <kfileitemdelegate.h>
  28 #include <kfileiconview.h>
  29 #include <kio/job.h>
  30
  31 #include <urlnavigator.h>
  32
  33 #include <QDropEvent>
  34 #include <QLinkedList>
  35 #include <QListView>
  36 #include <QMouseEvent>
  37 #include <QVBoxLayout>
  38 #include <QWidget>
  39
  40 class DolphinController;
  41 class FilterBar;
  42 class KFileItemDelegate;
  43 class KUrl;
  44 class KDirModel;
  45 class UrlNavigator;
  46 class DolphinDetailsView;
  47 class DolphinDirLister;
  48 class DolphinIconsView;
  49 class DolphinMainWindow;
  50 class DolphinSortFilterProxyModel;
  51 class DolphinStatusBar;
  52 class QModelIndex;
  53 class QPainter;
  54 class QTimer;
  55 class ViewProperties;
  56
  57 /**
  58  * @short Represents a view for the directory content
  59  *        including the navigation bar, filter bar and status bar.
  60  *
  61  * View modes for icons and details are supported. Currently
  62  * Dolphin allows to have up to two views inside the main window.
  63  *
  64  * @see DolphinIconsView
  65  * @see DolphinDetailsView
  66  * @see UrlNavigator
  67  * @see DolphinStatusBar
  68  */
  69 class DolphinView : public QWidget
  70 {
  71     Q_OBJECT
  72
  73 public:
  74         /**
  75      * Defines the view mode for a directory. The view mode
  76      * can be defined when constructing a DolphinView. The
  77      * view mode is automatically updated if the directory itself
  78      * defines a view mode (see class ViewProperties for details).
  79      */
  80     enum Mode
  81     {
  82         /**
  83          * The directory items are shown as icons including an
  84          * icon name. */
  85         IconsView = 0,
  86
  87         /**
  88          * The icon, the name and at least the size of the directory
  89          * items are shown in a table. It is possible to add columns
  90          * for date, group and permissions.
  91          */
  92         DetailsView = 1,
  93         MaxModeEnum = DetailsView
  94     };
  95
  96     /** Defines the sort order for the items of a directory. */
  97     enum Sorting
  98     {
  99         SortByName = 0,
 100         SortBySize,
 101         SortByDate,
 102         SortByPermissions,
 103         SortByOwner,
 104         SortByGroup,
 105         MaxSortEnum = SortByGroup
 106     };
 107
 108     DolphinView(DolphinMainWindow* mainwindow,
 109                 QWidget *parent,
 110                 const KUrl& url,
 111                 Mode mode = IconsView,
 112                 bool showHiddenFiles = false);
 113
 114     virtual ~DolphinView();
 115
 116     /**
 117      * Sets the current active URL.
 118      * The signals UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
 119      * are emitted.
 120      */
 121     void setUrl(const KUrl& url);
 122
 123     /** Returns the current active URL. */
 124     const KUrl& url() const;
 125
 126     /**
 127      * Returns true if the view is active and hence all actions are
 128      * applied to this view.
 129      */
 130     bool isActive() const;
 131
 132     /**
 133      * Changes the view mode for the current directory to \a mode.
 134      * If the view properties should be remembered for each directory
 135      * (GeneralSettings::globalViewProps() returns false), then the
 136      * changed view mode will be be stored automatically.
 137      */
 138     void setMode(Mode mode);
 139     Mode mode() const;
 140
 141     /**
 142      * Turns on the file preview for the all files of the current directory,
 143      * if \a show is true.
 144      * If the view properties should be remembered for each directory
 145      * (GeneralSettings::globalViewProps() returns false), then the
 146      * preview setting will be be stored automatically.
 147      */
 148     void setShowPreview(bool show);
 149     bool showPreview() const;
 150
 151     /**
 152      * Shows all hidden files of the current directory,
 153      * if \a show is true.
 154      * If the view properties should be remembered for each directory
 155      * (GeneralSettings::globalViewProps() returns false), then the
 156      * show hidden file setting will be be stored automatically.
 157      */
 158     void setShowHiddenFiles(bool show);
 159     bool showHiddenFiles() const;
 160
 161     /**
 162      * Triggers the renaming of the currently selected items, where
 163      * the user must input a new name for the items.
 164      */
 165     void renameSelectedItems();
 166
 167     /**
 168      * Selects all items.
 169      * @see DolphinView::selectedItems()
 170      */
 171     void selectAll();
 172
 173     /**
 174      * Inverts the current selection: selected items get unselected,
 175      * unselected items get selected.
 176      * @see DolphinView::selectedItems()
 177      */
 178     void invertSelection();
 179
 180     /**
 181      * Goes back one step in the URL history. The signals
 182      * UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
 183      * are submitted.
 184      */
 185     void goBack();
 186
 187     /**
 188      * Goes forward one step in the Url history. The signals
 189      * UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
 190      * are submitted.
 191      */
 192     void goForward();
 193
 194     /**
 195      * Goes up one step of the Url path. The signals
 196      * UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
 197      * are submitted.
 198      */
 199     void goUp();
 200
 201     /**
 202      * Goes to the home URL. The signals UrlNavigator::urlChanged()
 203      * and UrlNavigator::historyChanged() are submitted.
 204      */
 205     void goHome();
 206
 207     /**
 208      * Sets the URL of the navigation bar to an editable state
 209      * if \a editable is true. If \a editable is false, each part of
 210      * the location is presented by a button for a fast navigation.
 211      */
 212     void setUrlEditable(bool editable);
 213
 214     /**
 215      * Returns the complete URL history. The index 0 indicates the oldest
 216      * history element.
 217      * @param index     Output parameter which indicates the current
 218      *                  index of the location.
 219      */
 220     const QLinkedList<UrlNavigator::HistoryElem> urlHistory(int& index) const;
 221
 222     /**
 223      * Returns true, if at least one item is selected.
 224      */
 225     bool hasSelection() const;
 226
 227     /**
 228      * Returns the selected items. The list is empty if no item has been
 229      * selected.
 230      * @see DolphinView::selectedUrls()
 231      */
 232     KFileItemList selectedItems() const;
 233
 234     /**
 235      * Returns a list of URLs for all selected items. An empty list
 236      * is returned, if no item is selected.
 237      * @see DolphinView::selectedItems()
 238      */
 239     KUrl::List selectedUrls() const;
 240
 241     /**
 242      * Returns the file item for the given model index \a index.
 243      */
 244     KFileItem* fileItem(const QModelIndex index) const;
 245
 246     /**
 247      * Renames the filename of the source URL by the new file name.
 248      * If the new file name already exists, a dialog is opened which
 249      * asks the user to enter a new name.
 250      */
 251     void rename(const KUrl& source, const QString& newName);
 252
 253     /** Returns the status bar of the view. */
 254     DolphinStatusBar* statusBar() const;
 255
 256     /**
 257      * Returns the x-position of the view content.
 258      * The content of the view might be larger than the visible area
 259      * and hence a scrolling must be done.
 260      */
 261     int contentsX() const;
 262
 263     /**
 264      * Returns the y-position of the view content.
 265      * The content of the view might be larger than the visible area
 266      * and hence a scrolling must be done.
 267      */
 268     int contentsY() const;
 269
 270     /**
 271      * Returns true, if the URL shown by the navigation bar is editable.
 272      * @see UrlNavigator
 273      */
 274     bool isUrlEditable() const;
 275
 276     /** Increases the size of the current set view mode. */
 277     void zoomIn();
 278
 279     /** Decreases the size of the current set view mode. */
 280     void zoomOut();
 281
 282     /**
 283      * Returns true, if zooming in is possible. If false is returned,
 284      * the minimal zoom size is possible.
 285      */
 286     bool isZoomInPossible() const;
 287
 288     /**
 289      * Returns true, if zooming out is possible. If false is returned,
 290      * the maximum zoom size is possible.
 291      */
 292     bool isZoomOutPossible() const;
 293
 294     /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
 295     void setSorting(Sorting sorting);
 296
 297     /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
 298     Sorting sorting() const;
 299
 300     /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
 301     void setSortOrder(Qt::SortOrder order);
 302
 303     /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
 304     Qt::SortOrder sortOrder() const;
 305
 306     /** Sets the additional information which should be shown for the items. */
 307     void setAdditionalInfo(KFileItemDelegate::AdditionalInformation info);
 308
 309     /** Returns the additional information which should be shown for the items. */
 310     KFileItemDelegate::AdditionalInformation additionalInfo() const;
 311
 312     /** Refreshs the view settings by reading out the stored settings. */
 313     void refreshSettings();
 314
 315     /** Returns the UrlNavigator of the view for read access. */
 316     const UrlNavigator* urlNavigator() const { return m_urlNavigator; }
 317
 318     /**
 319      * Triggers to request user information for the item given
 320      * by the URL \a url. The signal requestItemInfo is emitted,
 321      * which provides a way for widgets to get an indication to update
 322      * the item information.
 323      */
 324     void emitRequestItemInfo(const KUrl& url);
 325
 326     /** Returns true, if the filter bar is visible. */
 327     bool isFilterBarVisible() const;
 328
 329     /**
 330      * Return the DolphinMainWindow this View belongs to. It is guranteed
 331      * that we have one.
 332      */
 333     DolphinMainWindow* mainWindow() const ;
 334
 335     /** Reloads the current directory. */
 336     void reload();
 337
 338 public slots:
 339     /**
 340      * Popups the filter bar above the status bar if \a show is true.
 341      */
 342     void showFilterBar(bool show);
 343
 344     /**
 345      * Updates the number of items (= number of files + number of
 346      * directories) in the statusbar. If files are selected, the number
 347      * of selected files and the sum of the filesize is shown.
 348      */
 349     void updateStatusBar();
 350
 351     /**
 352      * Requests the main window to set this view as active view, which
 353      * means that all actions are applied to this view.
 354      */
 355     void requestActivation();
 356
 357     /** Applies an item effect to all cut items of the clipboard. */
 358     void updateCutItems();
 359
 360 signals:
 361     /** Is emitted if URL of the view has been changed to \a url. */
 362     void urlChanged(const KUrl& url);
 363
 364     /**
 365      * Is emitted if the view mode (IconsView, DetailsView,
 366      * PreviewsView) has been changed.
 367      */
 368     void modeChanged();
 369
 370     /** Is emitted if the 'show preview' property has been changed. */
 371     void showPreviewChanged();
 372
 373     /** Is emitted if the 'show hidden files' property has been changed. */
 374     void showHiddenFilesChanged();
 375
 376     /** Is emitted if the sorting by name, size or date has been changed. */
 377     void sortingChanged(DolphinView::Sorting sorting);
 378
 379     /** Is emitted if the sort order (ascending or descending) has been changed. */
 380     void sortOrderChanged(Qt::SortOrder order);
 381
 382     /** Is emitted if the addtional information for an item has been changed. */
 383     void additionalInfoChanged(KFileItemDelegate::AdditionalInformation info);
 384
 385     /**
 386      * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
 387      * It the URL is empty, no item information request is pending.
 388      */
 389     void requestItemInfo(const KUrl& url);
 390
 391     /** Is emitted if the contents has been moved to \a x, \a y. */
 392     void contentsMoved(int x, int y);
 393
 394     /**
 395      * Is emitted whenever the selection has been changed. The current selection can
 396      * be retrieved by mainWindow()->activeView()->selectedItems() or by
 397      * mainWindow()->activeView()->selectedUrls().
 398      */
 399     void selectionChanged();
 400
 401     /**
 402      * Is emitted whenever the filter bar has been turned show or hidden.
 403      */
 404     void showFilterBarChanged(bool shown);
 405
 406 protected:
 407     /** @see QWidget::mouseReleaseEvent */
 408     virtual void mouseReleaseEvent(QMouseEvent* event);
 409
 410 private slots:
 411     void loadDirectory(const KUrl& kurl);
 412     void triggerItem(const QModelIndex& index);
 413     void updateProgress(int percent);
 414
 415     /**
 416      * Updates the number of items (= number of directories + number of files)
 417      * and shows this information in the statusbar.
 418      */
 419     void updateItemCount();
 420
 421     /**
 422      * Generates a preview image for each file item in \a items.
 423      * The current preview settings (maximum size, 'Show Preview' menu)
 424      * are respected.
 425      */
 426     void generatePreviews(const KFileItemList& items);
 427
 428     /**
 429      * Replaces the icon of the item \a item by the preview pixmap
 430      * \a pixmap.
 431      */
 432     void showPreview(const KFileItem* item, const QPixmap& pixmap);
 433
 434     /**
 435      * Restores the x- and y-position of the contents if the
 436      * current view is part of the history.
 437      */
 438     void restoreContentsPos();
 439
 440     /** Shows the information \a msg inside the statusbar. */
 441     void showInfoMessage(const QString& msg);
 442
 443     /** Shows the error message \a msg inside the statusbar. */
 444     void showErrorMessage(const QString& msg);
 445
 446     void emitSelectionChangedSignal();
 447     void closeFilterBar();
 448
 449     /**
 450      * Filters the currently shown items by \a nameFilter. All items
 451      * which contain the given filter string will be shown.
 452      */
 453     void changeNameFilter(const QString& nameFilter);
 454
 455     /**
 456      * Opens the context menu on position \a pos. The position
 457      * is used to check whether the context menu is related to an
 458      * item or to the viewport.
 459      */
 460     void openContextMenu(const QPoint& pos);
 461
 462     /**
 463      * Drops the URLs \a urls to the index \a index. \a source
 464      * indicates the widget where the dragging has been started from.
 465      */
 466     void dropUrls(const KUrl::List& urls,
 467                   const QModelIndex& index,
 468                   QWidget* source);
 469
 470     /**
 471      * Drops the URLs \a urls at the
 472      * destination \a destination.
 473      */
 474     void dropUrls(const KUrl::List& urls,
 475                   const KUrl& destination);
 476     /**
 477      * Updates the view properties of the current URL to the
 478      * sorting given by \a sorting.
 479      */
 480     void updateSorting(DolphinView::Sorting sorting);
 481
 482     /**
 483      * Updates the view properties of the current URL to the
 484      * sort order given by \a order.
 485      */
 486     void updateSortOrder(Qt::SortOrder order);
 487
 488     /**
 489      * Emits the signal contentsMoved with the current coordinates
 490      * of the viewport as parameters.
 491      */
 492     void emitContentsMoved();
 493
 494     /**
 495      * Updates the activation state of the view by checking whether
 496      * the currently active view is this view.
 497      */
 498     void updateActivationState();
 499
 500 private:
 501     void startDirLister(const KUrl& url, bool reload = false);
 502
 503     /**
 504      * Returns the default text of the status bar, if no item is
 505      * selected.
 506      */
 507     QString defaultStatusBarText() const;
 508
 509     /**
 510      * Returns the text for the status bar, if at least one item
 511      * is selected.
 512      */
 513     QString selectionStatusBarText() const;
 514
 515     /**
 516      * Creates a new view representing the given view mode (DolphinView::mode()).
 517      * The current view will get deleted.
 518      */
 519     void createView();
 520
 521     /**
 522      * Selects all items by using the selection flags \a flags. This is a helper
 523      * method for the slots DolphinView::selectAll() and DolphinView::invertSelection().
 524      */
 525     void selectAll(QItemSelectionModel::SelectionFlags flags);
 526
 527     /**
 528      * Returns a pointer to the currently used item view, which is either
 529      * a ListView or a TreeView.
 530      */
 531     QAbstractItemView* itemView() const;
 532
 533     /**
 534      * Returns true if the index is valid and represents
 535      * the column KDirModel::Name.
 536      */
 537     bool isValidNameIndex(const QModelIndex& index) const;
 538
 539     /**
 540      * Returns true, if the item \a item has been cut into
 541      * the clipboard.
 542      */
 543     bool isCutItem(const KFileItem& item) const;
 544
 545 private:
 546     bool m_showProgress;
 547     Mode m_mode;
 548
 549     int m_iconSize;
 550     int m_folderCount;
 551     int m_fileCount;
 552
 553     DolphinMainWindow* m_mainWindow;
 554     QVBoxLayout* m_topLayout;
 555     UrlNavigator* m_urlNavigator;
 556
 557     DolphinController* m_controller;
 558     DolphinIconsView* m_iconsView;
 559     DolphinDetailsView* m_detailsView;
 560     KFileItemDelegate* m_fileItemDelegate;
 561
 562     FilterBar* m_filterBar;
 563     DolphinStatusBar* m_statusBar;
 564
 565     KDirModel* m_dirModel;
 566     DolphinDirLister* m_dirLister;
 567     DolphinSortFilterProxyModel* m_proxyModel;
 568 };
 569
 570 #endif // _DOLPHINVIEW_H_