src/views/dolphinview.h

   1 /*
   2  * SPDX-FileCopyrightText: 2006-2009 Peter Penz <peter.penz19@gmail.com>
   3  * SPDX-FileCopyrightText: 2006 Gregor Kališnik <gregor@podnapisi.net>
   4  *
   5  * SPDX-License-Identifier: GPL-2.0-or-later
   6  */
   7
   8 #ifndef DOLPHINVIEW_H
   9 #define DOLPHINVIEW_H
  10
  11 #include "dolphintabwidget.h"
  12 #include "dolphin_export.h"
  13 #include "tooltips/tooltipmanager.h"
  14
  15 #include <KFileItem>
  16 #include <KIO/Job>
  17 #include <config-baloo.h>
  18 #include <kio/fileundomanager.h>
  19 #include <kparts/part.h>
  20
  21 #include <QMimeData>
  22 #include <QPointer>
  23 #include <QUrl>
  24 #include <QWidget>
  25
  26 typedef KIO::FileUndoManager::CommandType CommandType;
  27 class QVBoxLayout;
  28 class DolphinItemListView;
  29 class KFileItemModel;
  30 class KItemListContainer;
  31 class KItemModelBase;
  32 class KItemSet;
  33 class ToolTipManager;
  34 class VersionControlObserver;
  35 class ViewProperties;
  36 class QLabel;
  37 class QGraphicsSceneDragDropEvent;
  38 class QRegularExpression;
  39
  40 /**
  41  * @short Represents a view for the directory content.
  42  *
  43  * View modes for icons, compact and details are supported. It's
  44  * possible to adjust:
  45  * - sort order
  46  * - sort type
  47  * - show hidden files
  48  * - show previews
  49  * - enable grouping
  50  */
  51 class DOLPHIN_EXPORT DolphinView : public QWidget
  52 {
  53     Q_OBJECT
  54
  55 public:
  56     /**
  57      * Defines the view mode for a directory. The
  58      * view mode is automatically updated if the directory itself
  59      * defines a view mode (see class ViewProperties for details).
  60      */
  61     enum Mode
  62     {
  63         /**
  64          * The items are shown as icons with a name-label below.
  65          */
  66         IconsView = 0,
  67
  68         /**
  69          * The icon, the name and the size of the items are
  70          * shown per default as a table.
  71          */
  72         DetailsView,
  73
  74         /**
  75          * The items are shown as icons with the name-label aligned
  76          * to the right side.
  77          */
  78         CompactView
  79     };
  80
  81     /**
  82      * @param url              Specifies the content which should be shown.
  83      * @param parent           Parent widget of the view.
  84      */
  85     DolphinView(const QUrl& url, QWidget* parent);
  86
  87     ~DolphinView() override;
  88
  89     /**
  90      * Returns the current active URL, where all actions are applied.
  91      * The URL navigator is synchronized with this URL.
  92      */
  93     QUrl url() const;
  94
  95     /**
  96      * If \a active is true, the view will marked as active. The active
  97      * view is defined as view where all actions are applied to.
  98      */
  99     void setActive(bool active);
 100     bool isActive() const;
 101
 102     /**
 103      * Changes the view mode for the current directory to \a mode.
 104      * If the view properties should be remembered for each directory
 105      * (GeneralSettings::globalViewProps() returns false), then the
 106      * changed view mode will be stored automatically.
 107      */
 108     void setMode(Mode mode);
 109     Mode mode() const;
 110
 111     /**
 112      * Turns on the file preview for the all files of the current directory,
 113      * if \a show is true.
 114      * If the view properties should be remembered for each directory
 115      * (GeneralSettings::globalViewProps() returns false), then the
 116      * preview setting will be stored automatically.
 117      */
 118     void setPreviewsShown(bool show);
 119     bool previewsShown() const;
 120
 121     /**
 122      * Shows all hidden files of the current directory,
 123      * if \a show is true.
 124      * If the view properties should be remembered for each directory
 125      * (GeneralSettings::globalViewProps() returns false), then the
 126      * show hidden file setting will be stored automatically.
 127      */
 128     void setHiddenFilesShown(bool show);
 129     bool hiddenFilesShown() const;
 130
 131     /**
 132      * Turns on sorting by groups if \a enable is true.
 133      */
 134     void setGroupedSorting(bool grouped);
 135     bool groupedSorting() const;
 136
 137     /**
 138      * Returns the items of the view.
 139      */
 140     KFileItemList items() const;
 141
 142     /**
 143      * @return The number of items. itemsCount() is faster in comparison
 144      *         to items().count().
 145      */
 146     int itemsCount() const;
 147
 148     /**
 149      * Returns the selected items. The list is empty if no item has been
 150      * selected.
 151      */
 152     KFileItemList selectedItems() const;
 153
 154     /**
 155      * Returns the number of selected items (this is faster than
 156      * invoking selectedItems().count()).
 157      */
 158     int selectedItemsCount() const;
 159
 160     /**
 161      * Marks the items indicated by \p urls to get selected after the
 162      * directory DolphinView::url() has been loaded. Note that nothing
 163      * gets selected if no loading of a directory has been triggered
 164      * by DolphinView::setUrl() or DolphinView::reload().
 165      */
 166     void markUrlsAsSelected(const QList<QUrl> &urls);
 167
 168     /**
 169      * Marks the item indicated by \p url to be scrolled to and as the
 170      * current item after directory DolphinView::url() has been loaded.
 171      */
 172     void markUrlAsCurrent(const QUrl& url);
 173
 174     /**
 175      * All items that match the regular expression \a regexp will get selected
 176      * if \a enabled is true and deselected if \a enabled is false.
 177      *
 178      * Note that to match the whole string the pattern should be anchored:
 179      * - you can anchor the pattern with QRegularExpression::anchoredPattern()
 180      * - if you use QRegularExpresssion::wildcardToRegularExpression(), don't use
 181      *   QRegularExpression::anchoredPattern() as the former already returns an
 182      *   anchored pattern
 183      */
 184     void selectItems(const QRegularExpression &regexp, bool enabled);
 185
 186     /**
 187      * Sets the zoom level to \a level. It is assured that the used
 188      * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
 189      * ZoomLevelInfo::maximumLevel().
 190      */
 191     void setZoomLevel(int level);
 192     int zoomLevel() const;
 193
 194     /**
 195      * Resets the view's icon size to the default value
 196      */
 197     void resetZoomLevel();
 198
 199     void setSortRole(const QByteArray& role);
 200     QByteArray sortRole() const;
 201
 202     void setSortOrder(Qt::SortOrder order);
 203     Qt::SortOrder sortOrder() const;
 204
 205     /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
 206     void setSortFoldersFirst(bool foldersFirst);
 207     bool sortFoldersFirst() const;
 208
 209     /** Sets a separate sorting with hidden files and folders last (true) or not (false). */
 210     void setSortHiddenLast(bool hiddenLast);
 211     bool sortHiddenLast() const;
 212
 213     /** Sets the additional information which should be shown for the items. */
 214     void setVisibleRoles(const QList<QByteArray>& roles);
 215
 216     /** Returns the additional information which should be shown for the items. */
 217     QList<QByteArray> visibleRoles() const;
 218
 219     void reload();
 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      * Filters the currently shown items by \a filters. All items
 241      * whose content-type matches those given by the list of filters
 242      * will be shown.
 243      */
 244     void setMimeTypeFilters(const QStringList& filters);
 245     QStringList mimeTypeFilters() const;
 246
 247     /**
 248      * Tells the view to generate an updated status bar text. The result
 249      * is returned through the statusBarTextChanged(QString statusBarText) signal.
 250      * It will carry a textual representation of the state of the current
 251      * folder or selected items, suitable for use in the status bar.
 252      * Any pending requests of status bar text are killed.
 253      */
 254     void requestStatusBarText();
 255
 256     /**
 257      * Returns the version control actions that are provided for the items \p items.
 258      * Usually the actions are presented in the context menu.
 259      */
 260     QList<QAction*> versionControlActions(const KFileItemList& items) const;
 261
 262     /**
 263      * Returns the state of the paste action:
 264      * first is whether the action should be enabled
 265      * second is the text for the action
 266      */
 267     QPair<bool, QString> pasteInfo() const;
 268
 269     /**
 270      * If \a tabsForFiles is true, the signal tabRequested() will also
 271      * emitted also for files. Per default tabs for files is disabled
 272      * and hence the signal tabRequested() will only be emitted for
 273      * directories.
 274      */
 275     void setTabsForFilesEnabled(bool tabsForFiles);
 276     bool isTabsForFilesEnabled() const;
 277
 278     /**
 279      * Returns true if the current view allows folders to be expanded,
 280      * i.e. presents a hierarchical view to the user.
 281      */
 282     bool itemsExpandable() const;
 283
 284     /**
 285      * Restores the view state (current item, contents position, details view expansion state)
 286      */
 287     void restoreState(QDataStream& stream);
 288
 289     /**
 290      * Saves the view state (current item, contents position, details view expansion state)
 291      */
 292     void saveState(QDataStream& stream);
 293
 294     /**
 295      * Returns the root item which represents the current URL.
 296      */
 297     KFileItem rootItem() const;
 298
 299     /**
 300      * Sets a context that is used for remembering the view-properties.
 301      * Per default the context is empty and the path of the currently set URL
 302      * is used for remembering the view-properties. Setting a custom context
 303      * makes sense if specific types of URLs (e.g. search-URLs) should
 304      * share common view-properties.
 305      */
 306     void setViewPropertiesContext(const QString& context);
 307     QString viewPropertiesContext() const;
 308
 309     /**
 310      * Checks if the given \a item can be opened as folder (e.g. archives).
 311      * This function will also adjust the \a url (e.g. change the protocol).
 312      * @return a valid and adjusted url if the item can be opened as folder,
 313      * otherwise return an empty url.
 314      */
 315     static QUrl openItemAsFolderUrl(const KFileItem& item, const bool browseThroughArchives = true);
 316
 317     /**
 318      * Hides tooltip displayed over element.
 319      */
 320     void hideToolTip(const ToolTipManager::HideBehavior behavior = ToolTipManager::HideBehavior::Later);
 321
 322 public Q_SLOTS:
 323     /**
 324      * Changes the directory to \a url. If the current directory is equal to
 325      * \a url, nothing will be done (use DolphinView::reload() instead).
 326      */
 327     void setUrl(const QUrl& url);
 328
 329     /**
 330      * Selects all items.
 331      * @see DolphinView::selectedItems()
 332      */
 333     void selectAll();
 334
 335     /**
 336      * Inverts the current selection: selected items get unselected,
 337      * unselected items get selected.
 338      * @see DolphinView::selectedItems()
 339      */
 340     void invertSelection();
 341
 342     void clearSelection();
 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 cut.
 363      */
 364     void cutSelectedItemsToClipboard();
 365
 366     /** Copies all selected items to the clipboard. */
 367     void copySelectedItemsToClipboard();
 368
 369     /**
 370      * Copies all selected items to @p destinationUrl.
 371      */
 372     void copySelectedItems(const KFileItemList &selection, const QUrl &destinationUrl);
 373
 374     /**
 375      * Moves all selected items to @p destinationUrl.
 376      */
 377     void moveSelectedItems(const KFileItemList &selection, const QUrl &destinationUrl);
 378
 379     /** Pastes the clipboard data to this view. */
 380     void paste();
 381
 382     /**
 383      * Pastes the clipboard data into the currently selected
 384      * folder. If the current selection is not exactly one folder, no
 385      * paste operation is done.
 386      */
 387     void pasteIntoFolder();
 388
 389     /**
 390      * Copies the path of the first selected KFileItem into Clipboard.
 391      */
 392     void copyPathToClipboard();
 393
 394     /**
 395      * Creates duplicates of selected items, appending "copy"
 396      * to the end.
 397      */
 398     void duplicateSelectedItems();
 399
 400     /**
 401      * Handles a drop of @p dropEvent onto widget @p dropWidget and destination @p destUrl
 402      */
 403     void dropUrls(const QUrl &destUrl, QDropEvent *dropEvent, QWidget *dropWidget);
 404
 405     void stopLoading();
 406
 407     /**
 408      * Applies the state that has been restored by restoreViewState()
 409      * to the view.
 410      */
 411     void updateViewState();
 412
 413     /** Activates the view if the item list container gets focus. */
 414     bool eventFilter(QObject* watched, QEvent* event) override;
 415
 416 Q_SIGNALS:
 417     /**
 418      * Is emitted if the view has been activated by e. g. a mouse click.
 419      */
 420     void activated();
 421
 422     /** Is emitted if the URL of the view has been changed to \a url. */
 423     void urlChanged(const QUrl& url);
 424
 425     /**
 426      * Is emitted when clicking on an item with the left mouse button.
 427      */
 428     void itemActivated(const KFileItem &item);
 429
 430     /**
 431      * Is emitted when multiple items have been activated by e. g.
 432      * context menu open with.
 433      */
 434     void itemsActivated(const KFileItemList &items);
 435
 436     /**
 437      * Is emitted if items have been added or deleted.
 438      */
 439     void itemCountChanged();
 440
 441     /**
 442      * Is emitted if a new tab should be opened for the URL \a url.
 443      */
 444     void tabRequested(const QUrl& url);
 445
 446     /**
 447      * Is emitted if a new tab should be opened for the URL \a url and set as active.
 448      */
 449     void activeTabRequested(const QUrl &url);
 450
 451     /**
 452      * Is emitted if a new window should be opened for the URL \a url.
 453      */
 454     void windowRequested(const QUrl &url);
 455
 456     /**
 457      * Is emitted if the view mode (IconsView, DetailsView,
 458      * PreviewsView) has been changed.
 459      */
 460     void modeChanged(DolphinView::Mode current, DolphinView::Mode previous);
 461
 462     /** Is emitted if the 'show preview' property has been changed. */
 463     void previewsShownChanged(bool shown);
 464
 465     /** Is emitted if the 'show hidden files' property has been changed. */
 466     void hiddenFilesShownChanged(bool shown);
 467
 468     /** Is emitted if the 'grouped sorting' property has been changed. */
 469     void groupedSortingChanged(bool groupedSorting);
 470
 471     /** Is emitted in reaction to a requestStatusBarText() call.
 472      * @see requestStatusBarText() */
 473     void statusBarTextChanged(QString statusBarText);
 474
 475     /** Is emitted if the sorting by name, size or date has been changed. */
 476     void sortRoleChanged(const QByteArray& role);
 477
 478     /** Is emitted if the sort order (ascending or descending) has been changed. */
 479     void sortOrderChanged(Qt::SortOrder order);
 480
 481     /**
 482      * Is emitted if the sorting of files and folders (separate with folders
 483      * first or mixed) has been changed.
 484      */
 485     void sortFoldersFirstChanged(bool foldersFirst);
 486
 487     /**
 488      * Is emitted if the sorting of hidden files has been changed.
 489      */
 490     void sortHiddenLastChanged(bool hiddenLast);
 491
 492     /** Is emitted if the additional information shown for this view has been changed. */
 493     void visibleRolesChanged(const QList<QByteArray>& current,
 494                              const QList<QByteArray>& previous);
 495
 496     /** Is emitted if the zoom level has been changed by zooming in or out. */
 497     void zoomLevelChanged(int current, int previous);
 498
 499     /**
 500      * Is emitted if information of an item is requested to be shown e. g. in the panel.
 501      * If item is null, no item information request is pending.
 502      */
 503     void requestItemInfo(const KFileItem& item);
 504
 505     /**
 506      * Is emitted whenever the selection has been changed.
 507      */
 508     void selectionChanged(const KFileItemList& selection);
 509
 510     /**
 511      * Is emitted if a context menu is requested for the item \a item,
 512      * which is part of \a url. If the item is null, the context menu
 513      * for the URL should be shown and the custom actions \a customActions
 514      * will be added.
 515      */
 516     void requestContextMenu(const QPoint& pos,
 517                             const KFileItem& item,
 518                             const QUrl& url,
 519                             const QList<QAction*>& customActions);
 520
 521     /**
 522      * Is emitted if an information message with the content \a msg
 523      * should be shown.
 524      */
 525     void infoMessage(const QString& msg);
 526
 527     /**
 528      * Is emitted if an error message with the content \a msg
 529      * should be shown.
 530      */
 531     void errorMessage(const QString& msg);
 532
 533     /**
 534      * Is emitted if an "operation completed" message with the content \a msg
 535      * should be shown.
 536      */
 537     void operationCompletedMessage(const QString& msg);
 538
 539     /**
 540      * Is emitted after DolphinView::setUrl() has been invoked and
 541      * the current directory is loaded. If this signal is emitted,
 542      * it is assured that the view contains already the correct root
 543      * URL and property settings.
 544      */
 545     void directoryLoadingStarted();
 546
 547     /**
 548      * Is emitted after the directory triggered by DolphinView::setUrl()
 549      * has been loaded.
 550      */
 551     void directoryLoadingCompleted();
 552
 553     /**
 554      * Is emitted after the directory loading triggered by DolphinView::setUrl()
 555      * has been canceled.
 556      */
 557     void directoryLoadingCanceled();
 558
 559     /**
 560      * Is emitted after DolphinView::setUrl() has been invoked and provides
 561      * the information how much percent of the current directory have been loaded.
 562      */
 563     void directoryLoadingProgress(int percent);
 564
 565     /**
 566      * Is emitted if the sorting is done asynchronously and provides the
 567      * progress information of the sorting.
 568      */
 569     void directorySortingProgress(int percent);
 570
 571     /**
 572      * Emitted when the file-item-model emits redirection.
 573      * Testcase: fish://localhost
 574      */
 575     void redirection(const QUrl& oldUrl, const QUrl& newUrl);
 576
 577     /**
 578      * Is emitted when the URL set by DolphinView::setUrl() represents a file.
 579      * In this case no signal errorMessage() will be emitted.
 580      */
 581     void urlIsFileError(const QUrl& url);
 582
 583     /**
 584      * Is emitted when the write state of the folder has been changed. The application
 585      * should disable all actions like "Create New..." that depend on the write
 586      * state.
 587      */
 588     void writeStateChanged(bool isFolderWritable);
 589
 590     /**
 591      * Is emitted if the URL should be changed to the previous URL of the
 592      * history (e.g. because the "back"-mousebutton has been pressed).
 593      */
 594     void goBackRequested();
 595
 596     /**
 597      * Is emitted if the URL should be changed to the next URL of the
 598      * history (e.g. because the "next"-mousebutton has been pressed).
 599      */
 600     void goForwardRequested();
 601
 602     /**
 603      * Is emitted when the user wants to move the focus to another view.
 604      */
 605     void toggleActiveViewRequested();
 606
 607     /**
 608      * Is emitted when the user clicks a tag or a link
 609      * in the metadata widget of a tooltip.
 610      */
 611     void urlActivated(const QUrl& url);
 612
 613     void goUpRequested();
 614
 615     void fileItemsChanged(const KFileItemList &changedFileItems);
 616
 617 protected:
 618     /** Changes the zoom level if Control is pressed during a wheel event. */
 619     void wheelEvent(QWheelEvent* event) override;
 620
 621     void hideEvent(QHideEvent* event) override;
 622     bool event(QEvent* event) override;
 623
 624 private Q_SLOTS:
 625     /**
 626      * Marks the view as active (DolphinView:isActive() will return true)
 627      * and emits the 'activated' signal if it is not already active.
 628      */
 629     void activate();
 630
 631     void slotItemActivated(int index);
 632     void slotItemsActivated(const KItemSet &indexes);
 633     void slotItemMiddleClicked(int index);
 634     void slotItemContextMenuRequested(int index, const QPointF& pos);
 635     void slotViewContextMenuRequested(const QPointF& pos);
 636     void slotHeaderContextMenuRequested(const QPointF& pos);
 637     void slotHeaderColumnWidthChangeFinished(const QByteArray& role, qreal current);
 638     void slotLeadingPaddingWidthChanged(qreal width);
 639     void slotItemHovered(int index);
 640     void slotItemUnhovered(int index);
 641     void slotItemDropEvent(int index, QGraphicsSceneDragDropEvent* event);
 642     void slotModelChanged(KItemModelBase* current, KItemModelBase* previous);
 643     void slotMouseButtonPressed(int itemIndex, Qt::MouseButtons buttons);
 644     void slotRenameDialogRenamingFinished(const QList<QUrl>& urls);
 645     void slotSelectedItemTextPressed(int index);
 646     void slotCopyingDone(KIO::Job *, const QUrl &, const QUrl &to);
 647     void slotIncreaseZoom();
 648     void slotDecreaseZoom();
 649     void slotSwipeUp();
 650
 651     /*
 652      * Is called when new items get pasted or dropped.
 653      */
 654     void slotItemCreated(const QUrl &url);
 655     /*
 656      * Is called after all pasted or dropped items have been copied to destination.
 657      */
 658     void slotJobResult(KJob *job);
 659
 660     /**
 661      * Emits the signal \a selectionChanged() with a small delay. This is
 662      * because getting all file items for the selection can be an expensive
 663      * operation. Fast selection changes are collected in this case and
 664      * the signal is emitted only after no selection change has been done
 665      * within a small delay.
 666      */
 667     void slotSelectionChanged(const KItemSet& current, const KItemSet& previous);
 668
 669     /**
 670      * Is called by emitDelayedSelectionChangedSignal() and emits the
 671      * signal \a selectionChanged() with all selected file items as parameter.
 672      */
 673     void emitSelectionChangedSignal();
 674
 675     /**
 676      * Helper method for DolphinView::requestStatusBarText().
 677      * Calculates the amount of folders and files and their total size in
 678      * response to a KStatJob::result(), then calls emitStatusBarText().
 679      * @see requestStatusBarText()
 680      * @see emitStatusBarText()
 681      */
 682     void slotStatJobResult(KJob *job);
 683
 684     /**
 685      * Updates the view properties of the current URL to the
 686      * sorting given by \a role.
 687      */
 688     void updateSortRole(const QByteArray& role);
 689
 690     /**
 691      * Updates the view properties of the current URL to the
 692      * sort order given by \a order.
 693      */
 694     void updateSortOrder(Qt::SortOrder order);
 695
 696     /**
 697      * Updates the view properties of the current URL to the
 698      * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
 699      */
 700     void updateSortFoldersFirst(bool foldersFirst);
 701
 702     /**
 703      * Updates the view properties of the current URL to the
 704      * sorting of hidden files given by \a hiddenLast.
 705      */
 706     void updateSortHiddenLast(bool hiddenLast);
 707
 708     /**
 709      * Indicates in the status bar that the delete operation
 710      * of the job \a job has been finished.
 711      */
 712     void slotDeleteFileFinished(KJob* job);
 713
 714     /**
 715      * Indicates in the status bar that the trash operation
 716      * of the job \a job has been finished.
 717      */
 718     void slotTrashFileFinished(KJob* job);
 719
 720     /**
 721      * Invoked when the rename job is done, for error handling.
 722      */
 723     void slotRenamingResult(KJob* job);
 724
 725     /**
 726      * Invoked when the file item model has started the loading
 727      * of the directory specified by DolphinView::url().
 728      */
 729     void slotDirectoryLoadingStarted();
 730
 731     /**
 732      * Invoked when the file item model indicates that the loading of a directory has
 733      * been completed. Assures that pasted items and renamed items get selected.
 734      */
 735     void slotDirectoryLoadingCompleted();
 736
 737     /**
 738      * Invoked when the file item model indicates that the loading of a directory has
 739      * been canceled.
 740      */
 741     void slotDirectoryLoadingCanceled();
 742
 743     /**
 744      * Is invoked when items of KFileItemModel have been changed.
 745      */
 746     void slotItemsChanged();
 747
 748     /**
 749      * Is invoked when the sort order has been changed by the user by clicking
 750      * on a header item. The view properties of the directory will get updated.
 751      */
 752     void slotSortOrderChangedByHeader(Qt::SortOrder current, Qt::SortOrder previous);
 753
 754     /**
 755      * Is invoked when the sort role has been changed by the user by clicking
 756      * on a header item. The view properties of the directory will get updated.
 757      */
 758     void slotSortRoleChangedByHeader(const QByteArray& current, const QByteArray& previous);
 759
 760     /**
 761      * Is invoked when the visible roles have been changed by the user by dragging
 762      * a header item. The view properties of the directory will get updated.
 763      */
 764     void slotVisibleRolesChangedByHeader(const QList<QByteArray>& current,
 765                                          const QList<QByteArray>& previous);
 766
 767     void slotRoleEditingCanceled();
 768     void slotRoleEditingFinished(int index, const QByteArray& role, const QVariant& value);
 769
 770     /**
 771      * Observes the item with the URL \a url. As soon as the directory
 772      * model indicates that the item is available, the item will
 773      * get selected and it is assured that the item stays visible.
 774      */
 775     void observeCreatedItem(const QUrl &url);
 776
 777     /**
 778      * Called when a redirection happens.
 779      * Testcase: fish://localhost
 780      */
 781     void slotDirectoryRedirection(const QUrl& oldUrl, const QUrl& newUrl);
 782
 783     void slotTwoClicksRenamingTimerTimeout();
 784
 785 private:
 786     void loadDirectory(const QUrl& url, bool reload = false);
 787
 788     /**
 789      * Applies the view properties which are defined by the current URL
 790      * to the DolphinView properties. The view properties are read from a
 791      * .directory file either in the current directory, or in the
 792      * share/apps/dolphin/view_properties/ subfolder of the user's .kde folder.
 793      */
 794     void applyViewProperties();
 795
 796     /**
 797      * Applies the given view properties to the DolphinView.
 798      */
 799     void applyViewProperties(const ViewProperties& props);
 800
 801     /**
 802      * Applies the m_mode property to the corresponding
 803      * itemlayout-property of the KItemListView.
 804      */
 805     void applyModeToView();
 806
 807     enum Selection {
 808         HasSelection,
 809         NoSelection
 810     };
 811     /**
 812      * Helper method for DolphinView::requestStatusBarText().
 813      * Generates the status bar text from the parameters and
 814      * then emits statusBarTextChanged().
 815      * @param totalFileSize the sum of the sizes of the files
 816      * @param selection     if HasSelection is passed, the emitted status bar text will say
 817      *                      that the folders and files which are counted here are selected.
 818      */
 819     void emitStatusBarText(const int folderCount, const int fileCount,
 820                            KIO::filesize_t totalFileSize, const Selection selection);
 821
 822     /**
 823      * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
 824      * Pastes the clipboard data into the URL \a url.
 825      */
 826     void pasteToUrl(const QUrl& url);
 827
 828     /**
 829      * Returns a list of URLs for all selected items. The list is
 830      * simplified, so that when the URLs are part of different tree
 831      * levels, only the parent is returned.
 832      */
 833     QList<QUrl> simplifiedSelectedUrls() const;
 834
 835     /**
 836      * Returns the MIME data for all selected items.
 837      */
 838     QMimeData* selectionMimeData() const;
 839
 840     /**
 841      * Updates m_isFolderWritable dependent on whether the folder represented by
 842      * the current URL is writable. If the state has changed, the signal
 843      * writeableStateChanged() will be emitted.
 844      */
 845     void updateWritableState();
 846
 847     /**
 848      * @return The current URL if no viewproperties-context is given (see
 849      *         DolphinView::viewPropertiesContext(), otherwise the context
 850      *         is returned.
 851      */
 852     QUrl viewPropertiesUrl() const;
 853
 854     /**
 855      * Clears the selection and updates current item and selection according to the parameters
 856      *
 857      * @param current URL to be set as current
 858      * @param selected list of selected items
 859      */
 860     void forceUrlsSelection(const QUrl& current, const QList<QUrl>& selected);
 861
 862     void abortTwoClicksRenaming();
 863
 864     void updatePlaceholderLabel();
 865
 866     void tryShowNameToolTip(QEvent* event);
 867
 868 private:
 869     void updatePalette();
 870     void showLoadingPlaceholder();
 871
 872     bool m_active;
 873     bool m_tabsForFiles;
 874     bool m_assureVisibleCurrentIndex;
 875     bool m_isFolderWritable;
 876     bool m_dragging; // True if a dragging is done. Required to be able to decide whether a
 877                      // tooltip may be shown when hovering an item.
 878     bool m_loading;
 879
 880     QUrl m_url;
 881     QString m_viewPropertiesContext;
 882     Mode m_mode;
 883     QList<QByteArray> m_visibleRoles;
 884
 885     QPointer<KIO::StatJob> m_statJobForStatusBarText;
 886
 887     QVBoxLayout* m_topLayout;
 888
 889     KFileItemModel* m_model;
 890     DolphinItemListView* m_view;
 891     KItemListContainer* m_container;
 892
 893     ToolTipManager* m_toolTipManager;
 894
 895     QTimer* m_selectionChangedTimer;
 896
 897     QUrl m_currentItemUrl; // Used for making the view to remember the current URL after F5
 898     bool m_scrollToCurrentItem; // Used for marking we need to scroll to current item or not
 899     QPoint m_restoredContentsPosition;
 900
 901     QList<QUrl> m_selectedUrls; // Used for making the view to remember selections after F5
 902     bool m_clearSelectionBeforeSelectingNewItems;
 903     bool m_markFirstNewlySelectedItemAsCurrent;
 904
 905     VersionControlObserver* m_versionControlObserver;
 906
 907     QTimer* m_twoClicksRenamingTimer;
 908     QUrl m_twoClicksRenamingItemUrl;
 909     QLabel* m_placeholderLabel;
 910     QTimer* m_showLoadingPlaceholderTimer;
 911
 912     // For unit tests
 913     friend class TestBase;
 914     friend class DolphinDetailsViewTest;
 915     friend class DolphinPart;                   // Accesses m_model
 916 };
 917
 918 /// Allow using DolphinView::Mode in QVariant
 919 Q_DECLARE_METATYPE(DolphinView::Mode)
 920
 921 #endif // DOLPHINVIEW_H