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