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