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