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 <kio/job.h>
  29
  30 #include <kurlnavigator.h>
  31
  32 #include <QtGui/QKeyEvent>
  33 #include <QtCore/QLinkedList>
  34 #include <QtGui/QListView>
  35 #include <QtGui/QBoxLayout>
  36 #include <QtGui/QWidget>
  37
  38 class DolphinController;
  39 class FilterBar;
  40 class KFileItemDelegate;
  41 class KUrl;
  42 class KDirModel;
  43 class KUrlNavigator;
  44 class DolphinColumnView;
  45 class DolphinDetailsView;
  46 class DolphinDirLister;
  47 class DolphinIconsView;
  48 class DolphinMainWindow;
  49 class DolphinSortFilterProxyModel;
  50 class DolphinStatusBar;
  51 class QModelIndex;
  52 class QPainter;
  53 class QTimer;
  54 class ViewProperties;
  55
  56 /**
  57  * @short Represents a view for the directory content
  58  *        including the navigation bar, filter bar and status bar.
  59  *
  60  * View modes for icons, details and columns are supported. Currently
  61  * Dolphin allows to have up to two views inside the main window.
  62  *
  63  * @see DolphinIconsView
  64  * @see DolphinDetailsView
  65  * @see DolphinColumnView
  66  * @see KUrlNavigator
  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
  94         /**
  95          * Each folder is shown in a separate column.
  96          */
  97         ColumnView = 2,
  98         MaxModeEnum = ColumnView
  99     };
 100
 101     /** Defines the sort order for the items of a directory. */
 102     enum Sorting
 103     {
 104         SortByName = 0,
 105         SortBySize,
 106         SortByDate,
 107         SortByPermissions,
 108         SortByOwner,
 109         SortByGroup,
 110         SortByType,
 111         MaxSortEnum = SortByType
 112     };
 113
 114     DolphinView(DolphinMainWindow* mainwindow,
 115                 QWidget *parent,
 116                 const KUrl& url,
 117                 Mode mode = IconsView,
 118                 bool showHiddenFiles = false);
 119
 120     virtual ~DolphinView();
 121
 122     /**
 123      * Sets the current active URL.
 124      * The signals KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged()
 125      * are emitted.
 126      */
 127     void setUrl(const KUrl& url);
 128
 129     /** Returns the current active URL. */
 130     const KUrl& url() const;
 131
 132     /**
 133      * Returns true if the view is active and hence all actions are
 134      * applied to this view.
 135      */
 136     bool isActive() const;
 137
 138     /**
 139      * Changes the view mode for the current directory to \a mode.
 140      * If the view properties should be remembered for each directory
 141      * (GeneralSettings::globalViewProps() returns false), then the
 142      * changed view mode will be be stored automatically.
 143      */
 144     void setMode(Mode mode);
 145     Mode mode() const;
 146
 147     /**
 148      * Turns on the file preview for the all files of the current directory,
 149      * if \a show is true.
 150      * If the view properties should be remembered for each directory
 151      * (GeneralSettings::globalViewProps() returns false), then the
 152      * preview setting will be be stored automatically.
 153      */
 154     void setShowPreview(bool show);
 155     bool showPreview() const;
 156
 157     /**
 158      * Shows all hidden files of the current directory,
 159      * if \a show is true.
 160      * If the view properties should be remembered for each directory
 161      * (GeneralSettings::globalViewProps() returns false), then the
 162      * show hidden file setting will be be stored automatically.
 163      */
 164     void setShowHiddenFiles(bool show);
 165     bool showHiddenFiles() const;
 166
 167     /**
 168      * Summarizes all sorted items by their category \a categorized
 169      * is true.
 170      * If the view properties should be remembered for each directory
 171      * (GeneralSettings::globalViewProps() returns false), then the
 172      * categorized sorting setting will be be stored automatically.
 173      */
 174     void setCategorizedSorting(bool categorized);
 175     bool categorizedSorting() const;
 176
 177     /**
 178      * Returns true, if the categorized sorting is supported by the current
 179      * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
 180      * supports categorizations. To check whether the categorized
 181      * sorting is set, use DolphinView::categorizedSorting().
 182      */
 183     bool supportsCategorizedSorting() const;
 184
 185     /**
 186      * Triggers the renaming of the currently selected items, where
 187      * the user must input a new name for the items.
 188      */
 189     void renameSelectedItems();
 190
 191     /**
 192      * Selects all items.
 193      * @see DolphinView::selectedItems()
 194      */
 195     void selectAll();
 196
 197     /**
 198      * Inverts the current selection: selected items get unselected,
 199      * unselected items get selected.
 200      * @see DolphinView::selectedItems()
 201      */
 202     void invertSelection();
 203
 204     /**
 205      * Goes back one step in the URL history. The signals
 206      * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged()
 207      * are submitted.
 208      */
 209     void goBack();
 210
 211     /**
 212      * Goes forward one step in the Url history. The signals
 213      * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged()
 214      * are submitted.
 215      */
 216     void goForward();
 217
 218     /**
 219      * Goes up one step of the Url path. The signals
 220      * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged()
 221      * are submitted.
 222      */
 223     void goUp();
 224
 225     /**
 226      * Goes to the home URL. The signals KUrlNavigator::urlChanged()
 227      * and KUrlNavigator::historyChanged() are submitted.
 228      */
 229     void goHome();
 230
 231     /**
 232      * Sets the URL of the navigation bar to an editable state
 233      * if \a editable is true. If \a editable is false, each part of
 234      * the location is presented by a button for a fast navigation.
 235      */
 236     void setUrlEditable(bool editable);
 237
 238     /** Returns true, if at least one item is selected. */
 239     bool hasSelection() const;
 240
 241     void clearSelection();
 242
 243     /**
 244      * Returns the selected items. The list is empty if no item has been
 245      * selected.
 246      * @see DolphinView::selectedUrls()
 247      */
 248     KFileItemList selectedItems() const;
 249
 250     /**
 251      * Returns a list of URLs for all selected items. An empty list
 252      * is returned, if no item is selected.
 253      * @see DolphinView::selectedItems()
 254      */
 255     KUrl::List selectedUrls() const;
 256
 257     /**
 258      * Returns the file item for the given model index \a index.
 259      */
 260     KFileItem* fileItem(const QModelIndex index) const;
 261
 262     /**
 263      * Renames the filename of the source URL by the new file name.
 264      * If the new file name already exists, a dialog is opened which
 265      * asks the user to enter a new name.
 266      */
 267     void rename(const KUrl& source, const QString& newName);
 268
 269     DolphinStatusBar* statusBar() const;
 270
 271     /**
 272      * Returns the x-position of the view content.
 273      * The content of the view might be larger than the visible area
 274      * and hence a scrolling must be done.
 275      */
 276     int contentsX() const;
 277
 278     /**
 279      * Returns the y-position of the view content.
 280      * The content of the view might be larger than the visible area
 281      * and hence a scrolling must be done.
 282      */
 283     int contentsY() const;
 284
 285     /**
 286      * Returns true, if the URL shown by the navigation bar is editable.
 287      * @see KUrlNavigator
 288      */
 289     bool isUrlEditable() const;
 290
 291     /** Increases the size of the current set view mode. */
 292     void zoomIn();
 293
 294     /** Decreases the size of the current set view mode. */
 295     void zoomOut();
 296
 297     /**
 298      * Returns true, if zooming in is possible. If false is returned,
 299      * the minimal zoom size is possible.
 300      */
 301     bool isZoomInPossible() const;
 302
 303     /**
 304      * Returns true, if zooming out is possible. If false is returned,
 305      * the maximum zoom size is possible.
 306      */
 307     bool isZoomOutPossible() const;
 308
 309     /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
 310     void setSorting(Sorting sorting);
 311
 312     /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
 313     Sorting sorting() const;
 314
 315     /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
 316     void setSortOrder(Qt::SortOrder order);
 317
 318     /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
 319     Qt::SortOrder sortOrder() const;
 320
 321     /** Sets the additional information which should be shown for the items. */
 322     void setAdditionalInfo(KFileItemDelegate::AdditionalInformation info);
 323
 324     /** Returns the additional information which should be shown for the items. */
 325     KFileItemDelegate::AdditionalInformation additionalInfo() const;
 326
 327     /** Returns the KUrlNavigator of the view for read access. */
 328     const KUrlNavigator* urlNavigator() const
 329     {
 330         return m_urlNavigator;
 331     }
 332
 333     /**
 334      * Triggers to request user information for the item given
 335      * by the URL \a url. The signal requestItemInfo is emitted,
 336      * which provides a way for widgets to get an indication to update
 337      * the item information.
 338      */
 339     void emitRequestItemInfo(const KUrl& url);
 340
 341     /** Returns true, if the filter bar is visible. */
 342     bool isFilterBarVisible() const;
 343
 344     /**
 345      * Return the DolphinMainWindow this View belongs to. It is guranteed
 346      * that we have one.
 347      */
 348     DolphinMainWindow* mainWindow() const ;
 349
 350     /** Reloads the current directory. */
 351     void reload();
 352
 353 public slots:
 354     /**
 355      * Popups the filter bar above the status bar if \a show is true.
 356      */
 357     void showFilterBar(bool show);
 358
 359     /**
 360      * Updates the number of items (= number of files + number of
 361      * directories) in the statusbar. If files are selected, the number
 362      * of selected files and the sum of the filesize is shown.
 363      */
 364     void updateStatusBar();
 365
 366     /**
 367      * Requests the main window to set this view as active view, which
 368      * means that all actions are applied to this view.
 369      */
 370     void requestActivation();
 371
 372     /**
 373      * Request of a selection change. The view will do its best to accommodate
 374      * the request, but it is not guaranteed that all items in \a selection
 375      * will actually get selected. The view will e.g. not select items which
 376      * are not in the currently displayed folder.
 377      */
 378     void changeSelection(const KFileItemList& selection);
 379
 380 signals:
 381     /** Is emitted if URL of the view has been changed to \a url. */
 382     void urlChanged(const KUrl& url);
 383
 384     /**
 385      * Is emitted if the view mode (IconsView, DetailsView,
 386      * PreviewsView) has been changed.
 387      */
 388     void modeChanged();
 389
 390     /** Is emitted if the 'show preview' property has been changed. */
 391     void showPreviewChanged();
 392
 393     /** Is emitted if the 'show hidden files' property has been changed. */
 394     void showHiddenFilesChanged();
 395
 396     /** Is emitted if the 'categorized sorting' property has been changed. */
 397     void categorizedSortingChanged();
 398
 399     /** Is emitted if the sorting by name, size or date has been changed. */
 400     void sortingChanged(DolphinView::Sorting sorting);
 401
 402     /** Is emitted if the sort order (ascending or descending) has been changed. */
 403     void sortOrderChanged(Qt::SortOrder order);
 404
 405     /** Is emitted if the addtional information for an item has been changed. */
 406     void additionalInfoChanged(KFileItemDelegate::AdditionalInformation info);
 407
 408     /**
 409      * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
 410      * It the URL is empty, no item information request is pending.
 411      */
 412     void requestItemInfo(const KUrl& url);
 413
 414     /** Is emitted if the contents has been moved to \a x, \a y. */
 415     void contentsMoved(int x, int y);
 416
 417     /**
 418      * Is emitted whenever the selection has been changed.
 419      */
 420     void selectionChanged(const KFileItemList& selection);
 421
 422     /**
 423      * Is emitted whenever the filter bar has been turned show or hidden.
 424      */
 425     void showFilterBarChanged(bool shown);
 426
 427 protected:
 428     /** @see QWidget::mouseReleaseEvent */
 429     virtual void mouseReleaseEvent(QMouseEvent* event);
 430
 431 private slots:
 432     void changeDirectory(const KUrl& url);
 433     void triggerItem(const QModelIndex& index);
 434     void updateProgress(int percent);
 435
 436     /**
 437      * Updates the number of items (= number of directories + number of files)
 438      * and shows this information in the statusbar.
 439      */
 440     void updateItemCount();
 441
 442     /**
 443      * Generates a preview image for each file item in \a items.
 444      * The current preview settings (maximum size, 'Show Preview' menu)
 445      * are respected.
 446      */
 447     void generatePreviews(const KFileItemList& items);
 448
 449     /**
 450      * Replaces the icon of the item \a item by the preview pixmap
 451      * \a pixmap.
 452      */
 453     void showPreview(const KFileItem& item, const QPixmap& pixmap);
 454
 455     /**
 456      * Restores the x- and y-position of the contents if the
 457      * current view is part of the history.
 458      */
 459     void restoreContentsPos();
 460
 461     /** Shows the information \a msg inside the statusbar. */
 462     void showInfoMessage(const QString& msg);
 463
 464     /** Shows the error message \a msg inside the statusbar. */
 465     void showErrorMessage(const QString& msg);
 466
 467     void emitSelectionChangedSignal();
 468     void closeFilterBar();
 469
 470     /**
 471      * Filters the currently shown items by \a nameFilter. All items
 472      * which contain the given filter string will be shown.
 473      */
 474     void changeNameFilter(const QString& nameFilter);
 475
 476     /**
 477      * Opens the context menu on position \a pos. The position
 478      * is used to check whether the context menu is related to an
 479      * item or to the viewport.
 480      */
 481     void openContextMenu(const QPoint& pos);
 482
 483     /**
 484      * Drops the URLs \a urls to the index \a index. \a source
 485      * indicates the widget where the dragging has been started from.
 486      */
 487     void dropUrls(const KUrl::List& urls,
 488                   const QModelIndex& index,
 489                   QWidget* source);
 490
 491     /**
 492      * Drops the URLs \a urls at the
 493      * destination \a destination.
 494      */
 495     void dropUrls(const KUrl::List& urls,
 496                   const KUrl& destination);
 497     /**
 498      * Updates the view properties of the current URL to the
 499      * sorting given by \a sorting.
 500      */
 501     void updateSorting(DolphinView::Sorting sorting);
 502
 503     /**
 504      * Updates the view properties of the current URL to the
 505      * sort order given by \a order.
 506      */
 507     void updateSortOrder(Qt::SortOrder order);
 508
 509     /**
 510      * Emits the signal contentsMoved with the current coordinates
 511      * of the viewport as parameters.
 512      */
 513     void emitContentsMoved();
 514
 515     /**
 516      * Updates the activation state of the view by checking whether
 517      * the currently active view is this view.
 518      */
 519     void updateActivationState();
 520
 521     /** Applies an item effect to all cut items of the clipboard. */
 522     void updateCutItems();
 523
 524 private:
 525     void startDirLister(const KUrl& url, bool reload = false);
 526
 527     /**
 528      * Returns the default text of the status bar, if no item is
 529      * selected.
 530      */
 531     QString defaultStatusBarText() const;
 532
 533     /**
 534      * Returns the text for the status bar, if at least one item
 535      * is selected.
 536      */
 537     QString selectionStatusBarText() const;
 538
 539     /**
 540      * Creates a new view representing the given view mode (DolphinView::mode()).
 541      * The current view will get deleted.
 542      */
 543     void createView();
 544
 545     /**
 546      * Selects all items by using the selection flags \a flags. This is a helper
 547      * method for the slots DolphinView::selectAll() and DolphinView::invertSelection().
 548      */
 549     void selectAll(QItemSelectionModel::SelectionFlags flags);
 550
 551     /**
 552      * Returns a pointer to the currently used item view, which is either
 553      * a ListView or a TreeView.
 554      */
 555     QAbstractItemView* itemView() const;
 556
 557     /**
 558      * Returns true if the index is valid and represents
 559      * the column KDirModel::Name.
 560      */
 561     bool isValidNameIndex(const QModelIndex& index) const;
 562
 563     /**
 564      * Returns true, if the item \a item has been cut into
 565      * the clipboard.
 566      */
 567     bool isCutItem(const KFileItem& item) const;
 568
 569     /** Applies an item effect to all cut items. */
 570     void applyCutItemEffect();
 571
 572     /**
 573      * Returns true, if the ColumnView is activated. As the column view
 574      * requires some special handling for iterating through directories,
 575      * this method has been introduced for convenience.
 576      */
 577     bool isColumnViewActive() const
 578     {
 579         return m_columnView != 0;
 580     }
 581
 582 private:
 583     /**
 584      * Remembers the original pixmap for an item before
 585      * the cut effect is applied.
 586      */
 587     struct CutItem
 588     {
 589         KUrl url;
 590         QPixmap pixmap;
 591     };
 592
 593     bool m_showProgress;
 594     bool m_blockContentsMovedSignal;
 595     bool m_initializeColumnView;
 596     Mode m_mode;
 597
 598     int m_iconSize;
 599     int m_folderCount;
 600     int m_fileCount;
 601
 602     DolphinMainWindow* m_mainWindow;
 603     QVBoxLayout* m_topLayout;
 604     KUrlNavigator* m_urlNavigator;
 605
 606     DolphinController* m_controller;
 607     DolphinIconsView* m_iconsView;
 608     DolphinDetailsView* m_detailsView;
 609     DolphinColumnView* m_columnView;
 610     KFileItemDelegate* m_fileItemDelegate;
 611
 612     FilterBar* m_filterBar;
 613     DolphinStatusBar* m_statusBar;
 614
 615     KDirModel* m_dirModel;
 616     DolphinDirLister* m_dirLister;
 617     DolphinSortFilterProxyModel* m_proxyModel;
 618
 619     QList<CutItem> m_cutItemsCache;
 620 };
 621
 622 #endif // _DOLPHINVIEW_H_