src/views/dolphinview.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006-2009 by Peter Penz <peter.penz19@gmail.com>        *
   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 #ifndef DOLPHINVIEW_H
  22 #define DOLPHINVIEW_H
  23
  24 #include <config-nepomuk.h>
  25
  26 #include "libdolphin_export.h"
  27
  28 #include <kparts/part.h>
  29 #include <KFileItem>
  30 #include <KFileItemDelegate>
  31 #include <kio/fileundomanager.h>
  32 #include <KIO/Job>
  33
  34 #include <QBoxLayout>
  35 #include <QKeyEvent>
  36 #include <QLinkedList>
  37 #include <QSet>
  38 #include <QWidget>
  39
  40 typedef KIO::FileUndoManager::CommandType CommandType;
  41
  42 class DolphinItemListContainer;
  43 class KAction;
  44 class KActionCollection;
  45 class KFileItemModel;
  46 class KItemModelBase;
  47 class KUrl;
  48 class ToolTipManager;
  49 class VersionControlObserver;
  50 class ViewProperties;
  51 class QGraphicsSceneDragDropEvent;
  52 class QRegExp;
  53
  54 /**
  55  * @short Represents a view for the directory content.
  56  *
  57  * View modes for icons, compact and details are supported. It's
  58  * possible to adjust:
  59  * - sort order
  60  * - sort type
  61  * - show hidden files
  62  * - show previews
  63  * - enable grouping
  64  */
  65 class LIBDOLPHINPRIVATE_EXPORT DolphinView : public QWidget
  66 {
  67     Q_OBJECT
  68
  69 public:
  70     /**
  71      * Defines the view mode for a directory. The
  72      * view mode is automatically updated if the directory itself
  73      * defines a view mode (see class ViewProperties for details).
  74      */
  75     enum Mode
  76     {
  77         /**
  78          * The items are shown as icons with a name-label below.
  79          */
  80         IconsView = 0,
  81
  82         /**
  83          * The icon, the name and the size of the items are
  84          * shown per default as a table.
  85          */
  86         DetailsView,
  87
  88         /**
  89          * The items are shown as icons with the name-label aligned
  90          * to the right side.
  91          */
  92         CompactView
  93     };
  94
  95     /**
  96      * @param url              Specifies the content which should be shown.
  97      * @param parent           Parent widget of the view.
  98      */
  99     DolphinView(const KUrl& url, QWidget* parent);
 100
 101     virtual ~DolphinView();
 102
 103     /**
 104      * Returns the current active URL, where all actions are applied.
 105      * The URL navigator is synchronized with this URL.
 106      */
 107     KUrl url() const;
 108
 109     /**
 110      * If \a active is true, the view will marked as active. The active
 111      * view is defined as view where all actions are applied to.
 112      */
 113     void setActive(bool active);
 114     bool isActive() const;
 115
 116     /**
 117      * Changes the view mode for the current directory to \a mode.
 118      * If the view properties should be remembered for each directory
 119      * (GeneralSettings::globalViewProps() returns false), then the
 120      * changed view mode will be stored automatically.
 121      */
 122     void setMode(Mode mode);
 123     Mode mode() const;
 124
 125     /**
 126      * Turns on the file preview for the all files of the current directory,
 127      * if \a show is true.
 128      * If the view properties should be remembered for each directory
 129      * (GeneralSettings::globalViewProps() returns false), then the
 130      * preview setting will be stored automatically.
 131      */
 132     void setPreviewsShown(bool show);
 133     bool previewsShown() const;
 134
 135     /**
 136      * Shows all hidden files of the current directory,
 137      * if \a show is true.
 138      * If the view properties should be remembered for each directory
 139      * (GeneralSettings::globalViewProps() returns false), then the
 140      * show hidden file setting will be stored automatically.
 141      */
 142     void setHiddenFilesShown(bool show);
 143     bool hiddenFilesShown() const;
 144
 145     /**
 146      * Turns on sorting by groups if \a enable is true.
 147      */
 148     void setGroupedSorting(bool grouped);
 149     bool groupedSorting() const;
 150
 151     /**
 152      * Returns the items of the view.
 153      */
 154     KFileItemList items() const;
 155
 156     /**
 157      * @return The number of items. itemsCount() is faster in comparison
 158      *         to items().count().
 159      */
 160     int itemsCount() const;
 161
 162     /**
 163      * Returns the selected items. The list is empty if no item has been
 164      * selected.
 165      */
 166     KFileItemList selectedItems() const;
 167
 168     /**
 169      * Returns the number of selected items (this is faster than
 170      * invoking selectedItems().count()).
 171      */
 172     int selectedItemsCount() const;
 173
 174     /**
 175      * Marks the items indicated by \p urls to get selected after the
 176      * directory DolphinView::url() has been loaded. Note that nothing
 177      * gets selected if no loading of a directory has been triggered
 178      * by DolphinView::setUrl() or DolphinView::reload().
 179      */
 180     void markUrlsAsSelected(const QList<KUrl>& urls);
 181
 182     /**
 183      * Marks the item indicated by \p url as the current item after the
 184      * directory DolphinView::url() has been loaded.
 185      */
 186     void markUrlAsCurrent(const KUrl& url);
 187
 188     /**
 189      * All items that match to the pattern \a pattern will get selected
 190      * if \a enabled is true and deselected if  \a enabled is false.
 191      */
 192     void selectItems(const QRegExp& pattern, bool enabled);
 193
 194     /**
 195      * Sets the zoom level to \a level. It is assured that the used
 196      * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
 197      * ZoomLevelInfo::maximumLevel().
 198      */
 199     void setZoomLevel(int level);
 200     int zoomLevel() const;
 201
 202     void setSortRole(const QByteArray& role);
 203     QByteArray sortRole() const;
 204
 205     void setSortOrder(Qt::SortOrder order);
 206     Qt::SortOrder sortOrder() const;
 207
 208     /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
 209     void setSortFoldersFirst(bool foldersFirst);
 210     bool sortFoldersFirst() const;
 211
 212     /** Sets the additional information which should be shown for the items. */
 213     void setVisibleRoles(const QList<QByteArray>& roles);
 214
 215     /** Returns the additional information which should be shown for the items. */
 216     QList<QByteArray> visibleRoles() const;
 217
 218     void reload();
 219     void stopLoading();
 220
 221     /**
 222      * Refreshes the view to get synchronized with the settings (e.g. icons size,
 223      * font, ...).
 224      */
 225     void readSettings();
 226
 227     /**
 228      * Saves the current settings (e.g. icons size, font, ..).
 229      */
 230     void writeSettings();
 231
 232     /**
 233      * Filters the currently shown items by \a nameFilter. All items
 234      * which contain the given filter string will be shown.
 235      */
 236     void setNameFilter(const QString& nameFilter);
 237     QString nameFilter() const;
 238
 239     /**
 240      * Returns a textual representation of the state of the current
 241      * folder or selected items, suitable for use in the status bar.
 242      */
 243     QString statusBarText() const;
 244
 245     /**
 246      * Returns the version control actions that are provided for the items \p items.
 247      * Usually the actions are presented in the context menu.
 248      */
 249     QList<QAction*> versionControlActions(const KFileItemList& items) const;
 250
 251     /**
 252      * Returns the state of the paste action:
 253      * first is whether the action should be enabled
 254      * second is the text for the action
 255      */
 256     QPair<bool, QString> pasteInfo() const;
 257
 258     /**
 259      * If \a tabsForFiles is true, the signal tabRequested() will also
 260      * emitted also for files. Per default tabs for files is disabled
 261      * and hence the signal tabRequested() will only be emitted for
 262      * directories.
 263      */
 264     void setTabsForFilesEnabled(bool tabsForFiles);
 265     bool isTabsForFilesEnabled() const;
 266
 267     /**
 268      * Returns true if the current view allows folders to be expanded,
 269      * i.e. presents a hierarchical view to the user.
 270      */
 271     bool itemsExpandable() const;
 272
 273     /**
 274      * Restores the view state (current item, contents position, details view expansion state)
 275      */
 276     void restoreState(QDataStream& stream);
 277
 278     /**
 279      * Saves the view state (current item, contents position, details view expansion state)
 280      */
 281     void saveState(QDataStream& stream);
 282
 283     /**
 284      * Returns the root item which represents the current URL.
 285      */
 286     KFileItem rootItem() const;
 287
 288 public slots:
 289     /**
 290      * Changes the directory to \a url. If the current directory is equal to
 291      * \a url, nothing will be done (use DolphinView::reload() instead).
 292      */
 293     void setUrl(const KUrl& url);
 294
 295     /**
 296      * Selects all items.
 297      * @see DolphinView::selectedItems()
 298      */
 299     void selectAll();
 300
 301     /**
 302      * Inverts the current selection: selected items get unselected,
 303      * unselected items get selected.
 304      * @see DolphinView::selectedItems()
 305      */
 306     void invertSelection();
 307
 308     void clearSelection();
 309
 310     /**
 311      * Triggers the renaming of the currently selected items, where
 312      * the user must input a new name for the items.
 313      */
 314     void renameSelectedItems();
 315
 316     /**
 317      * Moves all selected items to the trash.
 318      */
 319     void trashSelectedItems();
 320
 321     /**
 322      * Deletes all selected items.
 323      */
 324     void deleteSelectedItems();
 325
 326     /**
 327      * Copies all selected items to the clipboard and marks
 328      * the items as cut.
 329      */
 330     void cutSelectedItems();
 331
 332     /** Copies all selected items to the clipboard. */
 333     void copySelectedItems();
 334
 335     /** Pastes the clipboard data to this view. */
 336     void paste();
 337
 338     /**
 339      * Pastes the clipboard data into the currently selected
 340      * folder. If the current selection is not exactly one folder, no
 341      * paste operation is done.
 342      */
 343     void pasteIntoFolder();
 344
 345     /** Activates the view if the item list container gets focus. */
 346     virtual bool eventFilter(QObject* watched, QEvent* event);
 347
 348 signals:
 349     /**
 350      * Is emitted if the view has been activated by e. g. a mouse click.
 351      */
 352     void activated();
 353
 354     /**
 355      * Is emitted if the URL of the view will be changed to \a url.
 356      * After the URL has been changed the signal urlChanged() will
 357      * be emitted.
 358      */
 359     void urlAboutToBeChanged(const KUrl& url);
 360
 361     /** Is emitted if the URL of the view has been changed to \a url. */
 362     void urlChanged(const KUrl& url);
 363
 364     /**
 365      * Is emitted when clicking on an item with the left mouse button.
 366      */
 367     void itemActivated(const KFileItem& item);
 368
 369     /**
 370      * Is emitted if items have been added or deleted.
 371      */
 372     void itemCountChanged();
 373
 374     /**
 375      * Is emitted if a new tab should be opened for the URL \a url.
 376      */
 377     void tabRequested(const KUrl& url);
 378
 379     /**
 380      * Is emitted if the view mode (IconsView, DetailsView,
 381      * PreviewsView) has been changed.
 382      */
 383     void modeChanged(DolphinView::Mode current, DolphinView::Mode previous);
 384
 385     /** Is emitted if the 'show preview' property has been changed. */
 386     void previewsShownChanged(bool shown);
 387
 388     /** Is emitted if the 'show hidden files' property has been changed. */
 389     void hiddenFilesShownChanged(bool shown);
 390
 391     /** Is emitted if the 'grouped sorting' property has been changed. */
 392     void groupedSortingChanged(bool groupedSorting);
 393
 394     /** Is emitted if the sorting by name, size or date has been changed. */
 395     void sortRoleChanged(const QByteArray& role);
 396
 397     /** Is emitted if the sort order (ascending or descending) has been changed. */
 398     void sortOrderChanged(Qt::SortOrder order);
 399
 400     /**
 401      * Is emitted if the sorting of files and folders (separate with folders
 402      * first or mixed) has been changed.
 403      */
 404     void sortFoldersFirstChanged(bool foldersFirst);
 405
 406     /** Is emitted if the additional information shown for this view has been changed. */
 407     void visibleRolesChanged(const QList<QByteArray>& current,
 408                              const QList<QByteArray>& previous);
 409
 410     /** Is emitted if the zoom level has been changed by zooming in or out. */
 411     void zoomLevelChanged(int current, int previous);
 412
 413     /**
 414      * Is emitted if information of an item is requested to be shown e. g. in the panel.
 415      * If item is null, no item information request is pending.
 416      */
 417     void requestItemInfo(const KFileItem& item);
 418
 419     /**
 420      * Is emitted whenever the selection has been changed.
 421      */
 422     void selectionChanged(const KFileItemList& selection);
 423
 424     /**
 425      * Is emitted if a context menu is requested for the item \a item,
 426      * which is part of \a url. If the item is null, the context menu
 427      * for the URL should be shown and the custom actions \a customActions
 428      * will be added.
 429      */
 430     void requestContextMenu(const QPoint& pos,
 431                             const KFileItem& item,
 432                             const KUrl& url,
 433                             const QList<QAction*>& customActions);
 434
 435     /**
 436      * Is emitted if an information message with the content \a msg
 437      * should be shown.
 438      */
 439     void infoMessage(const QString& msg);
 440
 441     /**
 442      * Is emitted if an error message with the content \a msg
 443      * should be shown.
 444      */
 445     void errorMessage(const QString& msg);
 446
 447     /**
 448      * Is emitted if an "operation completed" message with the content \a msg
 449      * should be shown.
 450      */
 451     void operationCompletedMessage(const QString& msg);
 452
 453     /**
 454      * Is emitted after DolphinView::setUrl() has been invoked and
 455      * the current directory is loaded. If this signal is emitted,
 456      * it is assured that the view contains already the correct root
 457      * URL and property settings.
 458      */
 459     void dirLoadingStarted();
 460
 461     /**
 462      * Is emitted after the directory triggered by DolphinView::setUrl()
 463      * has been loaded.
 464      */
 465     void dirLoadingCompleted();
 466
 467     /**
 468      * Is emitted after DolphinView::setUrl() has been invoked and provides
 469      * the information how much percent of the current directory have been loaded.
 470      */
 471     void dirLoadingProgress(int percent);
 472
 473     /**
 474      * Is emitted if the sorting is done asynchronously and provides the
 475      * progress information of the sorting.
 476      */
 477     void dirSortingProgress(int percent);
 478
 479     /**
 480      * Emitted when the file-item-model emits redirection.
 481      * Testcase: fish://localhost
 482      */
 483     void redirection(const KUrl& oldUrl, const KUrl& newUrl);
 484
 485     /**
 486      * Is emitted when the write state of the folder has been changed. The application
 487      * should disable all actions like "Create New..." that depend on the write
 488      * state.
 489      */
 490     void writeStateChanged(bool isFolderWritable);
 491
 492     /**
 493      * Is emitted if the URL should be changed to the previous URL of the
 494      * history (e.g. because the "back"-mousebutton has been pressed).
 495      */
 496     void goBackRequested();
 497
 498     /**
 499      * Is emitted if the URL should be changed to the next URL of the
 500      * history (e.g. because the "next"-mousebutton has been pressed).
 501      */
 502     void goForwardRequested();
 503
 504 protected:
 505     /** Changes the zoom level if Control is pressed during a wheel event. */
 506     virtual void wheelEvent(QWheelEvent* event);
 507
 508     /** @reimp */
 509     virtual void hideEvent(QHideEvent* event);
 510
 511 private slots:
 512     /**
 513      * Marks the view as active (DolphinView:isActive() will return true)
 514      * and emits the 'activated' signal if it is not already active.
 515      */
 516     void activate();
 517
 518     void slotItemActivated(int index);
 519     void slotItemsActivated(const QSet<int>& indexes);
 520     void slotItemMiddleClicked(int index);
 521     void slotItemContextMenuRequested(int index, const QPointF& pos);
 522     void slotViewContextMenuRequested(const QPointF& pos);
 523     void slotHeaderContextMenuRequested(const QPointF& pos);
 524     void slotHeaderColumnWidthChanged(const QByteArray& role, qreal current, qreal previous);
 525     void slotItemHovered(int index);
 526     void slotItemUnhovered(int index);
 527     void slotItemDropEvent(int index, QGraphicsSceneDragDropEvent* event);
 528     void slotModelChanged(KItemModelBase* current, KItemModelBase* previous);
 529     void slotMouseButtonPressed(int itemIndex, Qt::MouseButtons buttons);
 530
 531     /**
 532      * Emits the signal \a selectionChanged() with a small delay. This is
 533      * because getting all file items for the selection can be an expensive
 534      * operation. Fast selection changes are collected in this case and
 535      * the signal is emitted only after no selection change has been done
 536      * within a small delay.
 537      */
 538     void slotSelectionChanged(const QSet<int>& current, const QSet<int>& previous);
 539
 540     /**
 541      * Is called by emitDelayedSelectionChangedSignal() and emits the
 542      * signal \a selectionChanged() with all selected file items as parameter.
 543      */
 544     void emitSelectionChangedSignal();
 545
 546     /**
 547      * Updates the view properties of the current URL to the
 548      * sorting given by \a role.
 549      */
 550     void updateSortRole(const QByteArray& role);
 551
 552     /**
 553      * Updates the view properties of the current URL to the
 554      * sort order given by \a order.
 555      */
 556     void updateSortOrder(Qt::SortOrder order);
 557
 558     /**
 559      * Updates the view properties of the current URL to the
 560      * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
 561      */
 562     void updateSortFoldersFirst(bool foldersFirst);
 563
 564     /**
 565      * Updates the status bar to show hover information for the
 566      * item \a item. If currently other items are selected,
 567      * no hover information is shown.
 568      * @see DolphinView::clearHoverInformation()
 569      */
 570     void showHoverInformation(const KFileItem& item);
 571
 572     /**
 573      * Clears the hover information shown in the status bar.
 574      * @see DolphinView::showHoverInformation().
 575      */
 576     void clearHoverInformation();
 577
 578     /**
 579      * Indicates in the status bar that the delete operation
 580      * of the job \a job has been finished.
 581      */
 582     void slotDeleteFileFinished(KJob* job);
 583
 584     /**
 585      * Invoked when the file item model has started the loading
 586      * of the directory specified by DolphinView::url().
 587      */
 588     void slotDirLoadingStarted();
 589
 590     /**
 591      * Invoked when the file item model indicates that the loading of a directory has
 592      * been completed. Assures that pasted items and renamed items get seleced.
 593      */
 594     void slotDirLoadingCompleted();
 595
 596     /**
 597      * Is invoked when items of KFileItemModel have been changed.
 598      */
 599     void slotItemsChanged();
 600
 601     /**
 602      * Is invoked when the sort order has been changed by the user by clicking
 603      * on a header item. The view properties of the directory will get updated.
 604      */
 605     void slotSortOrderChangedByHeader(Qt::SortOrder current, Qt::SortOrder previous);
 606
 607     /**
 608      * Is invoked when the sort role has been changed by the user by clicking
 609      * on a header item. The view properties of the directory will get updated.
 610      */
 611     void slotSortRoleChangedByHeader(const QByteArray& current, const QByteArray& previous);
 612
 613     /**
 614      * Is invoked when the visible roles have been changed by the user by dragging
 615      * a header item. The view properties of the directory will get updated.
 616      */
 617     void slotVisibleRolesChangedByHeader(const QList<QByteArray>& current,
 618                                          const QList<QByteArray>& previous);
 619
 620     /**
 621      * Observes the item with the URL \a url. As soon as the directory
 622      * model indicates that the item is available, the item will
 623      * get selected and it is assured that the item stays visible.
 624      *
 625      * @see selectAndScrollToCreatedItem()
 626      */
 627     void observeCreatedItem(const KUrl& url);
 628
 629     /**
 630      * Selects and scrolls to the item that got observed
 631      * by observeCreatedItem().
 632      */
 633     void selectAndScrollToCreatedItem();
 634
 635     /**
 636      * Called when a redirection happens.
 637      * Testcase: fish://localhost
 638      */
 639     void slotRedirection(const KUrl& oldUrl, const KUrl& newUrl);
 640
 641     /**
 642      * Applies the state that has been restored by restoreViewState()
 643      * to the view.
 644      */
 645     void updateViewState();
 646
 647     void hideToolTip();
 648
 649     /**
 650      * Calculates the number of currently shown files into
 651      * \a fileCount and the number of folders into \a folderCount.
 652      * The size of all files is written into \a totalFileSize.
 653      * It is recommend using this method instead of asking the
 654      * directory lister or the model directly, as it takes
 655      * filtering and hierarchical previews into account.
 656      */
 657     void calculateItemCount(int& fileCount, int& folderCount, KIO::filesize_t& totalFileSize) const;
 658
 659 private:
 660     KFileItemModel* fileItemModel() const;
 661
 662     void loadDirectory(const KUrl& url, bool reload = false);
 663
 664     /**
 665      * Applies the view properties which are defined by the current URL
 666      * to the DolphinView properties.
 667      */
 668     void applyViewProperties();
 669
 670     /**
 671      * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
 672      * Pastes the clipboard data into the URL \a url.
 673      */
 674     void pasteToUrl(const KUrl& url);
 675
 676     /**
 677      * Returns a list of URLs for all selected items. The list is
 678      * simplified, so that when the URLs are part of different tree
 679      * levels, only the parent is returned.
 680      */
 681     KUrl::List simplifiedSelectedUrls() const;
 682
 683     /**
 684      * Returns the MIME data for all selected items.
 685      */
 686     QMimeData* selectionMimeData() const;
 687
 688     /**
 689      * Is invoked after a paste operation or a drag & drop
 690      * operation and URLs from \a mimeData as selected.
 691      * This allows to select all newly pasted
 692      * items in restoreViewState().
 693      */
 694     void markPastedUrlsAsSelected(const QMimeData* mimeData);
 695
 696     /**
 697      * Updates m_isFolderWritable dependent on whether the folder represented by
 698      * the current URL is writable. If the state has changed, the signal
 699      * writeableStateChanged() will be emitted.
 700      */
 701     void updateWritableState();
 702
 703 private:
 704     bool m_active;
 705     bool m_tabsForFiles;
 706     bool m_assureVisibleCurrentIndex;
 707     bool m_isFolderWritable;
 708     bool m_dragging; // True if a dragging is done. Required to be able to decide whether a
 709                      // tooltip may be shown when hovering an item.
 710
 711     KUrl m_url;
 712     Mode m_mode;
 713     QList<QByteArray> m_visibleRoles;
 714
 715     QVBoxLayout* m_topLayout;
 716
 717     DolphinItemListContainer* m_container;
 718
 719     ToolTipManager* m_toolTipManager;
 720
 721     QTimer* m_selectionChangedTimer;
 722
 723     KUrl m_currentItemUrl; // Used for making the view to remember the current URL after F5
 724     QPoint m_restoredContentsPosition;
 725     KUrl m_createdItemUrl; // URL for a new item that got created by the "Create New..." menu
 726
 727     QList<KUrl> m_selectedUrls; // Used for making the view to remember selections after F5
 728
 729     VersionControlObserver* m_versionControlObserver;
 730
 731     // For unit tests
 732     friend class TestBase;
 733     friend class DolphinDetailsViewTest;
 734 };
 735
 736 /// Allow using DolphinView::Mode in QVariant
 737 Q_DECLARE_METATYPE(DolphinView::Mode)
 738
 739 #endif // DOLPHINVIEW_H