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