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 <config-nepomuk.h>
  26
  27 #include "libdolphin_export.h"
  28
  29 #include <kparts/part.h>
  30 #include <kfileitem.h>
  31 #include <kfileitemdelegate.h>
  32 #include <kio/fileundomanager.h>
  33 #include <kio/job.h>
  34
  35 #include <QBoxLayout>
  36 #include <QKeyEvent>
  37 #include <QLinkedList>
  38 #include <QListView>
  39 #include <QWidget>
  40
  41 class DolphinController;
  42 class DolphinColumnView;
  43 class DolphinDetailsView;
  44 class DolphinFileItemDelegate;
  45 class DolphinIconsView;
  46 class DolphinMainWindow;
  47 class DolphinModel;
  48 class DolphinSortFilterProxyModel;
  49 class KFilePreviewGenerator;
  50 class KAction;
  51 class KActionCollection;
  52 class KDirLister;
  53 class KUrl;
  54 class KToggleAction;
  55 class ToolTipManager;
  56 class QModelIndex;
  57 class ViewProperties;
  58
  59 /**
  60  * @short Represents a view for the directory content.
  61  *
  62  * View modes for icons, details and columns are supported. It's
  63  * possible to adjust:
  64  * - sort order
  65  * - sort type
  66  * - show hidden files
  67  * - show previews
  68  *
  69  * @see DolphinIconsView
  70  * @see DolphinDetailsView
  71  * @see DolphinColumnView
  72  */
  73 class LIBDOLPHINPRIVATE_EXPORT DolphinView : public QWidget
  74 {
  75     Q_OBJECT
  76
  77 public:
  78     /**
  79      * Defines the view mode for a directory. The view mode
  80      * can be defined when constructing a DolphinView. The
  81      * view mode is automatically updated if the directory itself
  82      * defines a view mode (see class ViewProperties for details).
  83      */
  84     enum Mode
  85     {
  86         /**
  87          * The directory items are shown as icons including an
  88          * icon name.
  89          */
  90         IconsView = 0,
  91
  92         /**
  93          * The icon, the name and at least the size of the directory
  94          * items are shown in a table. It is possible to add columns
  95          * for date, group and permissions.
  96          */
  97         DetailsView = 1,
  98
  99         /**
 100          * Each folder is shown in a separate column.
 101          */
 102         ColumnView = 2,
 103         MaxModeEnum = ColumnView
 104     };
 105
 106     /** Defines the sort order for the items of a directory. */
 107     enum Sorting
 108     {
 109         SortByName = 0,
 110         SortBySize,
 111         SortByDate,
 112         SortByPermissions,
 113         SortByOwner,
 114         SortByGroup,
 115         SortByType,
 116         SortByRating,
 117         SortByTags,
 118         MaxSortEnum = SortByTags
 119     };
 120
 121     /**
 122      * @param parent           Parent widget of the view.
 123      * @param url              Specifies the content which should be shown.
 124      * @param dirLister        Used directory lister. The lister is not owned
 125      *                         by the view and won't get deleted.
 126      * @param dolphinModel     Used directory model. The model is not owned
 127      *                         by the view and won't get deleted.
 128      * @param proxyModel       Used proxy model which specifies the sorting. The
 129      *                         model is not owned by the view and won't get
 130      *                         deleted.
 131      */
 132     DolphinView(QWidget* parent,
 133                 const KUrl& url,
 134                 KDirLister* dirLister,
 135                 DolphinModel* dolphinModel,
 136                 DolphinSortFilterProxyModel* proxyModel);
 137
 138     virtual ~DolphinView();
 139
 140     /**
 141      * Returns the current active URL, where all actions are applied.
 142      * The URL navigator is synchronized with this URL.
 143      */
 144     const KUrl& url() const;
 145
 146     /**
 147      * Returns the root URL of the view, which is defined as the first
 148      * visible path of DolphinView::url(). Usually the root URL is
 149      * equal to DolphinView::url(), but in the case of the column view
 150      * when 2 columns are shown, the root URL might be:
 151      * /home/peter/Documents
 152      * and DolphinView::url() might return
 153      * /home/peter/Documents/Music/
 154      */
 155     KUrl rootUrl() const;
 156
 157     /**
 158      * If \a active is true, the view will marked as active. The active
 159      * view is defined as view where all actions are applied to.
 160      */
 161     void setActive(bool active);
 162     bool isActive() const;
 163
 164     /**
 165      * Changes the view mode for the current directory to \a mode.
 166      * If the view properties should be remembered for each directory
 167      * (GeneralSettings::globalViewProps() returns false), then the
 168      * changed view mode will be stored automatically.
 169      */
 170     void setMode(Mode mode);
 171     Mode mode() const;
 172
 173     /** See setShowPreview */
 174     bool showPreview() const;
 175
 176     /** See setShowHiddenFiles */
 177     bool showHiddenFiles() const;
 178
 179     /** See setCategorizedSorting */
 180     bool categorizedSorting() const;
 181
 182     /**
 183      * Returns true, if the categorized sorting is supported by the current
 184      * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
 185      * supports categorizations. To check whether the categorized
 186      * sorting is set, use DolphinView::categorizedSorting().
 187      */
 188     bool supportsCategorizedSorting() const;
 189
 190     /**
 191      * Selects all items.
 192      * @see DolphinView::selectedItems()
 193      */
 194     void selectAll();
 195
 196     /**
 197      * Inverts the current selection: selected items get unselected,
 198      * unselected items get selected.
 199      * @see DolphinView::selectedItems()
 200      */
 201     void invertSelection();
 202
 203     /** Returns true, if at least one item is selected. */
 204     bool hasSelection() const;
 205
 206     void clearSelection();
 207
 208     /**
 209      * Returns the selected items. The list is empty if no item has been
 210      * selected.
 211      * @see DolphinView::selectedUrls()
 212      */
 213     KFileItemList selectedItems() const;
 214
 215     /**
 216      * Returns a list of URLs for all selected items. An empty list
 217      * is returned, if no item is selected.
 218      * @see DolphinView::selectedItems()
 219      */
 220     KUrl::List selectedUrls() const;
 221
 222     /**
 223      * Returns the number of selected items (this is faster than
 224      * invoking selectedItems().count()).
 225      */
 226     int selectedItemsCount() const;
 227
 228     /**
 229      * Sets the upper left position of the view content
 230      * to (x,y). The content of the view might be larger than the visible area
 231      * and hence a scrolling must be done.
 232      */
 233     void setContentsPosition(int x, int y);
 234
 235     /** Returns the upper left position of the view content. */
 236     QPoint contentsPosition() const;
 237
 238     /**
 239      * Sets the zoom level to \a level. It is assured that the used
 240      * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
 241      * ZoomLevelInfo::maximumLevel().
 242      */
 243     void setZoomLevel(int level);
 244     int zoomLevel() const;
 245
 246     /**
 247      * Returns true, if zooming in is possible. If false is returned,
 248      * the maximum zooming level has been reached.
 249      */
 250     bool isZoomInPossible() const;
 251
 252     /**
 253      * Returns true, if zooming out is possible. If false is returned,
 254      * the minimum zooming level has been reached.
 255      */
 256     bool isZoomOutPossible() const;
 257
 258     /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
 259     void setSorting(Sorting sorting);
 260
 261     /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
 262     Sorting sorting() const;
 263
 264     /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
 265     void setSortOrder(Qt::SortOrder order);
 266
 267     /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
 268     Qt::SortOrder sortOrder() const;
 269
 270     /** Sets the additional information which should be shown for the items. */
 271     void setAdditionalInfo(KFileItemDelegate::InformationList info);
 272
 273     /** Returns the additional information which should be shown for the items. */
 274     KFileItemDelegate::InformationList additionalInfo() const;
 275
 276     /** Reloads the current directory. */
 277     void reload();
 278
 279     /**
 280      * Refreshes the view to get synchronized with the (updated) Dolphin settings.
 281      * This method only needs to get invoked if the view settings for the Icons View,
 282      * Details View or Columns View have been changed.
 283      */
 284     void refresh();
 285
 286     /**
 287      * Changes the directory of the view to \a url. If \a rootUrl is empty, the view
 288      * properties from \a url are used for adjusting the view mode and the other properties.
 289      * If \a rootUrl is not empty, the view properties from the root URL are considered
 290      * instead. Specifying a root URL is only required if a view having a different root URL
 291      * (e. g. the column view) should be restored. Usually using DolphinView::setUrl()
 292      * is enough for changing the current URL.
 293      */
 294     void updateView(const KUrl& url, const KUrl& rootUrl);
 295
 296     /**
 297      * Filters the currently shown items by \a nameFilter. All items
 298      * which contain the given filter string will be shown.
 299      */
 300     void setNameFilter(const QString& nameFilter);
 301
 302     /**
 303      * Calculates the number of currently shown files into
 304      * \a fileCount and the number of folders into \a folderCount.
 305      * It is recommend using this method instead of asking the
 306      * directory lister or the model directly, as it takes
 307      * filtering and hierarchical previews into account.
 308      */
 309     void calculateItemCount(int& fileCount, int& folderCount) const;
 310
 311     /**
 312      * Returns a textual representation of the state of the current
 313      * folder or selected items, suitable for use in the status bar.
 314      */
 315     QString statusBarText() const;
 316
 317     /**
 318      * Updates the state of the 'Additional Information' actions in \a collection.
 319      */
 320     void updateAdditionalInfoActions(KActionCollection* collection);
 321
 322     /**
 323      * Returns the state of the paste action:
 324      * first is whether the action should be enabled
 325      * second is the text for the action
 326      */
 327     QPair<bool, QString> pasteInfo() const;
 328
 329     /**
 330      * If \a tabsForFiles is true, the signal tabRequested() will also
 331      * emitted also for files. Per default tabs for files is disabled
 332      * and hence the signal tabRequested() will only be emitted for
 333      * directories.
 334      */
 335     void setTabsForFilesEnabled(bool tabsForFiles);
 336     bool isTabsForFilesEnabled() const;
 337
 338     /**
 339      * Returns true if the current view allows folders to be expanded,
 340      * i.e. presents a hierarchical view to the user.
 341      */
 342     bool itemsExpandable() const;
 343
 344 public slots:
 345     /**
 346      * Changes the directory to \a url. If the current directory is equal to
 347      * \a url, nothing will be done (use DolphinView::reload() instead).
 348      */
 349     void setUrl(const KUrl& url);
 350
 351     /**
 352      * Request of a selection change. The view will do its best to accommodate
 353      * the request, but it is not guaranteed that all items in \a selection
 354      * will actually get selected. The view will e.g. not select items which
 355      * are not in the currently displayed folder.
 356      */
 357     void changeSelection(const KFileItemList& selection);
 358
 359     /**
 360      * Triggers the renaming of the currently selected items, where
 361      * the user must input a new name for the items.
 362      */
 363     void renameSelectedItems();
 364
 365     /**
 366      * Moves all selected items to the trash.
 367      */
 368     void trashSelectedItems();
 369
 370     /**
 371      * Deletes all selected items.
 372      */
 373     void deleteSelectedItems();
 374
 375     /**
 376      * Copies all selected items to the clipboard and marks
 377      * the items as cutted.
 378      */
 379     void cutSelectedItems();
 380
 381     /** Copies all selected items to the clipboard. */
 382     void copySelectedItems();
 383
 384     /** Pastes the clipboard data to this view. */
 385     void paste();
 386
 387     /**
 388      * Pastes the clipboard data into the currently selected
 389      * folder. If the current selection is not exactly one folder, no
 390      * paste operation is done.
 391      */
 392     void pasteIntoFolder();
 393
 394     /**
 395      * Turns on the file preview for the all files of the current directory,
 396      * if \a show is true.
 397      * If the view properties should be remembered for each directory
 398      * (GeneralSettings::globalViewProps() returns false), then the
 399      * preview setting will be stored automatically.
 400      */
 401     void setShowPreview(bool show);
 402
 403     /**
 404      * Shows all hidden files of the current directory,
 405      * if \a show is true.
 406      * If the view properties should be remembered for each directory
 407      * (GeneralSettings::globalViewProps() returns false), then the
 408      * show hidden file setting will be stored automatically.
 409      */
 410     void setShowHiddenFiles(bool show);
 411
 412     /**
 413      * Summarizes all sorted items by their category \a categorized
 414      * is true.
 415      * If the view properties should be remembered for each directory
 416      * (GeneralSettings::globalViewProps() returns false), then the
 417      * categorized sorting setting will be stored automatically.
 418      */
 419     void setCategorizedSorting(bool categorized);
 420
 421     /** Switches between an ascending and descending sorting order. */
 422     void toggleSortOrder();
 423
 424     /**
 425      * Switches on or off the displaying of additional information
 426      * as specified by \a action.
 427      */
 428     void toggleAdditionalInfo(QAction* action);
 429
 430 signals:
 431     /**
 432      * Is emitted if the view has been activated by e. g. a mouse click.
 433      */
 434     void activated();
 435
 436     /** Is emitted if URL of the view has been changed to \a url. */
 437     void urlChanged(const KUrl& url);
 438
 439     /**
 440      * Is emitted if the view requests a changing of the current
 441      * URL to \a url (see DolphinController::triggerUrlChangeRequest()).
 442      */
 443     void requestUrlChange(const KUrl& url);
 444
 445     /**
 446      * Is emitted when clicking on an item with the left mouse button.
 447      */
 448     void itemTriggered(const KFileItem& item);
 449
 450     /**
 451      * Is emitted if a new tab should be opened for the URL \a url.
 452      */
 453     void tabRequested(const KUrl& url);
 454
 455     /**
 456      * Is emitted if the view mode (IconsView, DetailsView,
 457      * PreviewsView) has been changed.
 458      */
 459     void modeChanged();
 460
 461     /** Is emitted if the 'show preview' property has been changed. */
 462     void showPreviewChanged();
 463
 464     /** Is emitted if the 'show hidden files' property has been changed. */
 465     void showHiddenFilesChanged();
 466
 467     /** Is emitted if the 'categorized sorting' property has been changed. */
 468     void categorizedSortingChanged();
 469
 470     /** Is emitted if the sorting by name, size or date has been changed. */
 471     void sortingChanged(DolphinView::Sorting sorting);
 472
 473     /** Is emitted if the sort order (ascending or descending) has been changed. */
 474     void sortOrderChanged(Qt::SortOrder order);
 475
 476     /** Is emitted if the additional information shown for this view has been changed. */
 477     void additionalInfoChanged();
 478
 479     /** Is emitted if the zoom level has been changed by zooming in or out. */
 480     void zoomLevelChanged(int level);
 481
 482     /**
 483      * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
 484      * If item is null, no item information request is pending.
 485      */
 486     void requestItemInfo(const KFileItem& item);
 487
 488     /** Is emitted if the contents has been moved to \a x, \a y. */
 489     void contentsMoved(int x, int y);
 490
 491     /**
 492      * Is emitted whenever the selection has been changed.
 493      */
 494     void selectionChanged(const KFileItemList& selection);
 495
 496     /**
 497      * Is emitted if a context menu is requested for the item \a item,
 498      * which is part of \a url. If the item is 0, the context menu
 499      * for the URL should be shown.
 500      */
 501     void requestContextMenu(const KFileItem& item, const KUrl& url);
 502
 503     /**
 504      * Is emitted if an information message with the content \a msg
 505      * should be shown.
 506      */
 507     void infoMessage(const QString& msg);
 508
 509     /**
 510      * Is emitted if an error message with the content \a msg
 511      * should be shown.
 512      */
 513     void errorMessage(const QString& msg);
 514
 515     /**
 516      * Is emitted if an "operation completed" message with the content \a msg
 517      * should be shown.
 518      */
 519     void operationCompletedMessage(const QString& msg);
 520
 521     /**
 522      * Is emitted after DolphinView::setUrl() has been invoked and
 523      * the path \a url is currently loaded. If this signal is emitted,
 524      * it is assured that the view contains already the correct root
 525      * URL and property settings.
 526      */
 527     void startedPathLoading(const KUrl& url);
 528
 529     /**
 530      * Emitted when KDirLister emits redirection.
 531      * Testcase: fish://localhost
 532      */
 533     void redirection(const KUrl& oldUrl, const KUrl& newUrl);
 534
 535 protected:
 536     /** @see QWidget::mouseReleaseEvent */
 537     virtual void mouseReleaseEvent(QMouseEvent* event);
 538     virtual void wheelEvent(QWheelEvent* event);
 539     virtual bool eventFilter(QObject* watched, QEvent* event);
 540
 541 private slots:
 542     /**
 543      * Marks the view as active (DolphinView:isActive() will return true)
 544      * and emits the 'activated' signal if it is not already active.
 545      */
 546     void activate();
 547
 548     /**
 549      * If the item \a item is a directory, then this
 550      * directory will be loaded. If the  item is a file, the corresponding
 551      * application will get started.
 552      */
 553     void triggerItem(const KFileItem& index);
 554
 555     void emitSelectionChangedSignal();
 556
 557     /**
 558      * Opens the context menu on position \a pos. The position
 559      * is used to check whether the context menu is related to an
 560      * item or to the viewport.
 561      */
 562     void openContextMenu(const QPoint& pos);
 563
 564     /**
 565      * Drops dragged URLs to the destination path \a destPath. If
 566      * the URLs are dropped above an item inside the destination path,
 567      * the item is indicated by \a destItem.
 568      */
 569     void dropUrls(const KFileItem& destItem,
 570                   const KUrl& destPath,
 571                   QDropEvent* event);
 572
 573     /**
 574      * Updates the view properties of the current URL to the
 575      * sorting given by \a sorting.
 576      */
 577     void updateSorting(DolphinView::Sorting sorting);
 578
 579     /**
 580      * Updates the view properties of the current URL to the
 581      * sort order given by \a order.
 582      */
 583     void updateSortOrder(Qt::SortOrder order);
 584
 585     /**
 586      * Updates the view properties of the current URL to the
 587      * additional information given by \a info.
 588      */
 589     void updateAdditionalInfo(const KFileItemDelegate::InformationList& info);
 590
 591     /**
 592      * Emits the signal contentsMoved with the current coordinates
 593      * of the viewport as parameters.
 594      */
 595     void emitContentsMoved();
 596
 597     /**
 598      * Updates the status bar to show hover information for the
 599      * item \a item. If currently other items are selected,
 600      * no hover information is shown.
 601      * @see DolphinView::clearHoverInformation()
 602      */
 603     void showHoverInformation(const KFileItem& item);
 604
 605     /**
 606      * Clears the hover information shown in the status bar.
 607      * @see DolphinView::showHoverInformation().
 608      */
 609     void clearHoverInformation();
 610
 611     /**
 612      * Indicates in the status bar that the delete operation
 613      * of the job \a job has been finished.
 614      */
 615     void slotDeleteFileFinished(KJob* job);
 616
 617     /**
 618      * Is emitted if the controller requests a changing of the current
 619      * URL to \a url
 620      */
 621     void slotRequestUrlChange(const KUrl& url);
 622
 623     /**
 624      * Restores the current item (= item that has the keyboard focus)
 625      * to m_currentItemUrl.
 626      */
 627     void restoreCurrentItem();
 628
 629 private:
 630     void loadDirectory(const KUrl& url, bool reload = false);
 631
 632     /**
 633      * Returns the URL where the view properties should be stored. Usually
 634      * DolphinView::url() is returned, but in the case of a Column View the
 635      * view properties are always stored in the directory represented by the
 636      * first column. It is recommendend whenever using the ViewProperties class
 637      * to use DolphinView::viewPropertiesUrl() as URL.
 638      */
 639     KUrl viewPropertiesUrl() const;
 640
 641     /**
 642      * Applies the view properties which are defined by the current URL
 643      * m_url to the DolphinView properties.
 644      */
 645     void applyViewProperties(const KUrl& url);
 646
 647     /**
 648      * Creates a new view representing the given view mode (DolphinView::mode()).
 649      * The current view will get deleted.
 650      */
 651     void createView();
 652
 653     void deleteView();
 654
 655     /**
 656      * Returns a pointer to the currently used item view, which is either
 657      * a ListView or a TreeView.
 658      */
 659     QAbstractItemView* itemView() const;
 660
 661     /**
 662      * Returns true, if the item \a item has been cut into
 663      * the clipboard.
 664      */
 665     bool isCutItem(const KFileItem& item) const;
 666
 667     /**
 668      * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
 669      * Pastes the clipboard data into the URL \a url.
 670      */
 671     void pasteToUrl(const KUrl& url);
 672
 673     /**
 674      * Checks whether the current item view has the same zoom level
 675      * as \a oldZoomLevel. If this is not the case, the zoom level
 676      * of the controller is updated and a zoomLevelChanged() signal
 677      * is emitted.
 678      */
 679     void updateZoomLevel(int oldZoomLevel);
 680
 681     /**
 682      * Returns a list of URLs for all selected items. The list is
 683      * simplified, so that when the URLs are part of different tree
 684      * levels, only the parent is returned.
 685      */
 686     KUrl::List simplifiedSelectedUrls() const;
 687
 688     /**
 689      * Returns true, if the ColumnView is activated. As the column view
 690      * requires some special handling for iterating through directories,
 691      * this method has been introduced for convenience.
 692      */
 693     bool isColumnViewActive() const;
 694
 695 private:
 696     bool m_active : 1;
 697     bool m_showPreview : 1;
 698     bool m_loadingDirectory : 1;
 699     bool m_storedCategorizedSorting : 1;
 700     bool m_tabsForFiles : 1;
 701     bool m_isContextMenuOpen : 1;   // TODO: workaround for Qt-issue 207192
 702
 703     Mode m_mode;
 704
 705     DolphinMainWindow* m_mainWindow;
 706     QVBoxLayout* m_topLayout;
 707
 708     DolphinController* m_controller;
 709     DolphinIconsView* m_iconsView;
 710     DolphinDetailsView* m_detailsView;
 711     DolphinColumnView* m_columnView;
 712     DolphinFileItemDelegate* m_fileItemDelegate;
 713     QItemSelectionModel* m_selectionModel;
 714
 715     DolphinModel* m_dolphinModel;
 716     KDirLister* m_dirLister;
 717     DolphinSortFilterProxyModel* m_proxyModel;
 718
 719     KFilePreviewGenerator* m_previewGenerator;
 720     ToolTipManager* m_toolTipManager;
 721
 722     KUrl m_rootUrl;
 723     KUrl m_currentItemUrl;
 724 };
 725
 726 inline bool DolphinView::isColumnViewActive() const
 727 {
 728     return m_columnView != 0;
 729 }
 730
 731 /// Allow using DolphinView::Mode in QVariant
 732 Q_DECLARE_METATYPE(DolphinView::Mode)
 733
 734 #endif // DOLPHINVIEW_H