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