X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/60b9eaa4c1c4d3057934d2cefbbe986553090ab3..cd2e64154fd5446a7e19aff4cb147efe2f2ba31e:/src/dolphinmainwindow.h diff --git a/src/dolphinmainwindow.h b/src/dolphinmainwindow.h index 8e031fd03..5bb17e79a 100644 --- a/src/dolphinmainwindow.h +++ b/src/dolphinmainwindow.h @@ -9,12 +9,17 @@ #ifndef DOLPHIN_MAINWINDOW_H #define DOLPHIN_MAINWINDOW_H +#include "config-dolphin.h" #include "dolphintabwidget.h" -#include +#include "selectionmode/bottombar.h" +#include #include -#include #include +#if HAVE_BALOO +#include "panels/information/informationpanel.h" +#endif + #include #include #include @@ -34,15 +39,18 @@ class KFileItem; class KFileItemList; class KJob; class KNewFileMenu; -class KHelpMenu; class KToolBarPopupAction; class QToolButton; -class QIcon; class PlacesPanel; class TerminalPanel; -namespace KIO { - class OpenUrlJob; +namespace KIO +{ +class OpenUrlJob; +} +namespace SelectionMode +{ +class ActionTextHelper; } /** @@ -50,7 +58,7 @@ namespace KIO { * * Handles the menus, toolbars and Dolphin views. */ -class DolphinMainWindow: public KXmlGuiWindow +class DolphinMainWindow : public KXmlGuiWindow { Q_OBJECT Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow") @@ -65,12 +73,12 @@ public: * having a split view setup, the nonactive view * is usually shown in darker colors. */ - DolphinViewContainer* activeViewContainer() const; + DolphinViewContainer *activeViewContainer() const; /** * Returns view container for all tabs */ - QVector viewContainers() const; + QVector viewContainers() const; /** * Opens each directory in \p dirs in a separate tab. If \a splitView is set, @@ -84,13 +92,19 @@ public: * If \a splitView is set, 2 directories are collected within one tab. * \pre \a files must contain at least one url. */ - void openFiles(const QList& files, bool splitView); + void openFiles(const QList &files, bool splitView); /** * Returns the 'Create New...' sub menu which also can be shared * with other menus (e. g. a context menu). */ - KNewFileMenu* newFileMenu() const; + KNewFileMenu *newFileMenu() const; + + /** + * Augments Qt's build-in QMainWindow context menu to add + * Dolphin-specific actions, such as "unlock panels". + */ + QMenu *createPopupMenu() override; /** * Switch the window's view containers' locations to display the home path @@ -100,18 +114,13 @@ public: * This typically done after unmounting a disk at mountPath to ensure that * the window is not displaying an invalid location. */ - void setViewsToHomeIfMountPathOpen(const QString& mountPath); - - /** - * Sets any of the window's view containers which are currently displaying - * invalid locations to the home path - */ - void setViewsWithInvalidPathsToHome(); + void setViewsToHomeIfMountPathOpen(const QString &mountPath); bool isFoldersPanelEnabled() const; bool isInformationPanelEnabled() const; + bool isSplitViewEnabledInCurrentTab() const; -public slots: +public Q_SLOTS: /** * Opens each directory in \p dirs in a separate tab. If \a splitView is set, * 2 directories are collected within one tab. @@ -133,7 +142,9 @@ public slots: /** * Tries to raise/activate the Dolphin window. */ - void activateWindow(); + void activateWindow(const QString &activationToken); + + bool isActiveWindow(); /** * Determines if a URL is open in any tab. @@ -144,6 +155,12 @@ public slots: */ bool isUrlOpen(const QString &url); + /** + * @return Whether the item with @p url can be found in any view only by switching + * between already open tabs and scrolling in their primary or secondary view. + * @note Use of QString instead of QUrl is required to be callable via DBus. + */ + bool isItemVisibleInAnyView(const QString &urlOfItem); /** * Pastes the clipboard data into the currently selected folder @@ -157,46 +174,60 @@ public slots: * Inform all affected dolphin components (panels, views) of an URL * change. */ - void changeUrl(const QUrl& url); + void changeUrl(const QUrl &url); /** * The current directory of the Terminal Panel has changed, probably because * the user entered a 'cd' command. This slot calls changeUrl(url) and makes * sure that the panel keeps the keyboard focus. */ - void slotTerminalDirectoryChanged(const QUrl& url); + void slotTerminalDirectoryChanged(const QUrl &url); /** Stores all settings and quits Dolphin. */ void quit(); /** - * Opens a new tab and places it after the current tab + * Opens a new tab in the background showing the URL \a url. */ - void openNewTabAfterCurrentTab(const QUrl& url); + void openNewTab(const QUrl &url); /** - * Opens a new tab and places it as the last tab + * Opens a new tab showing the URL \a url and activate it. */ - void openNewTabAfterLastTab(const QUrl& url); + void openNewTabAndActivate(const QUrl &url); -signals: + /** + * Opens a new window showing the URL \a url. + */ + void openNewWindow(const QUrl &url); + + /** @see GeneralSettings::splitViewChanged() */ + void slotSplitViewChanged(); + +Q_SIGNALS: /** * Is sent if the selection of the currently active view has * been changed. */ - void selectionChanged(const KFileItemList& selection); + void selectionChanged(const KFileItemList &selection); /** * Is sent if the url of the currently active view has * been changed. */ - void urlChanged(const QUrl& url); + void urlChanged(const QUrl &url); /** * Is emitted if information of an item is requested to be shown e. g. in the panel. * If item is null, no item information request is pending. */ - void requestItemInfo(const KFileItem& item); + void requestItemInfo(const KFileItem &item); + + /** + * It is emitted when in the current view, files are changed, + * or dirs have files/removed from them. + */ + void fileItemsChanged(const KFileItemList &changedFileItems); /** * Is emitted if the settings have been changed. @@ -204,24 +235,25 @@ signals: void settingsChanged(); protected: + /** @see QObject::event() */ + bool event(QEvent *event) override; + /** @see QWidget::showEvent() */ - void showEvent(QShowEvent* event) override; + void showEvent(QShowEvent *event) override; /** @see QMainWindow::closeEvent() */ - void closeEvent(QCloseEvent* event) override; + void closeEvent(QCloseEvent *event) override; /** @see KMainWindow::saveProperties() */ - void saveProperties(KConfigGroup& group) override; + void saveProperties(KConfigGroup &group) override; /** @see KMainWindow::readProperties() */ - void readProperties(const KConfigGroup& group) override; + void readProperties(const KConfigGroup &group) override; - /** Handles QWhatsThisClickedEvent and passes all others on. */ - bool event(QEvent* event) override; - /** Handles QWhatsThisClickedEvent and passes all others on. */ - bool eventFilter(QObject*, QEvent*) override; + /** Sets a sane initial window size **/ + QSize sizeHint() const override; -protected slots: +protected Q_SLOTS: /** * Calls the base method KXmlGuiWindow::saveNewToolbarConfig(). * Is also used to set toolbar constraints and UrlNavigator position @@ -229,7 +261,7 @@ protected slots: */ void saveNewToolbarConfig() override; -private slots: +private Q_SLOTS: /** * Refreshes the views of the main window by recreating them according to * the given Dolphin settings. @@ -244,7 +276,7 @@ private slots: void createDirectory(); /** Shows the error message in the status bar of the active view. */ - void showErrorMessage(const QString& message); + void showErrorMessage(const QString &message); /** * Updates the state of the 'Undo' menu action dependent @@ -253,7 +285,7 @@ private slots: void slotUndoAvailable(bool available); /** Sets the text of the 'Undo' menu action to \a text. */ - void slotUndoTextChanged(const QString& text); + void slotUndoTextChanged(const QString &text); /** Performs the current undo operation. */ void undo(); @@ -282,6 +314,9 @@ private slots: */ void updatePasteAction(); + /** Calls DolphinViewContainer::setSelectionMode() for m_activeViewContainer. */ + void slotSetSelectionMode(bool enabled, SelectionMode::BottomBar::Contents bottomBarContents); + /** Selects all items from the active view. */ void selectAll(); @@ -302,6 +337,12 @@ private slots: /** Dedicated action to open the stash:/ ioslave in split view. */ void toggleSplitStash(); + /** Copies all selected items to the inactive view. */ + void copyToInactiveSplitView(); + + /** Moves all selected items to the inactive view. */ + void moveToInactiveSplitView(); + /** Reloads the currently active view. */ void reloadView(); @@ -311,6 +352,8 @@ private slots: void enableStopAction(); void disableStopAction(); + void toggleSelectionMode(); + void showFilterBar(); void toggleFilterBar(); @@ -379,6 +422,12 @@ private slots: /** Opens a terminal window for the current location. */ void openTerminal(); + /** Opens terminal windows for the selected items' locations. */ + void openTerminalHere(); + + /** Opens a terminal window for the URL. */ + void openTerminalJob(const QUrl &url); + /** Focus a Terminal Panel. */ void focusTerminalPanel(); @@ -392,7 +441,7 @@ private slots: * Updates the state of the 'Edit' menu actions and emits * the signal selectionChanged(). */ - void slotSelectionChanged(const KFileItemList& selection); + void slotSelectionChanged(const KFileItemList &selection); /** * Updates the state of the 'Back' and 'Forward' menu @@ -417,11 +466,6 @@ private slots: */ void addToPlaces(); - /** - * Opens a new tab in the background showing the URL \a url. - */ - void openNewTab(const QUrl& url, DolphinTabWidget::TabPlacement tabPlacement); - /** * Opens the selected folder in a new tab. */ @@ -447,7 +491,7 @@ private slots: * If the URL can be listed, open it in the current view, otherwise * run it through KRun. */ - void handleUrl(const QUrl& url); + void handleUrl(const QUrl &url); /** * Is invoked when the write state of a folder has been changed and @@ -460,25 +504,28 @@ private slots: * @pos Position in screen coordinates. * @item File item context. If item is null, the context menu * should be applied to \a url. + * @selectedItems The selected items for which the context menu + * is opened. This list generally includes \a item. * @url URL which contains \a item. - * @customActions Actions that should be added to the context menu, - * if the file item is null. */ - void openContextMenu(const QPoint& pos, - const KFileItem& item, - const QUrl& url, - const QList& customActions); + void openContextMenu(const QPoint &pos, const KFileItem &item, const KFileItemList &selectedItems, const QUrl &url); - void updateControlMenu(); - void updateToolBar(); - void slotControlButtonDeleted(); + /** + * Updates the menu that is by default at the right end of the toolbar. + * + * In true "simple by default" fashion, the menu only contains the most important + * and necessary actions to be able to use Dolphin. This is supposed to hold true even + * if the user does not know how to open a context menu. More advanced actions can be + * discovered through a sub-menu (@see KConfigWidgets::KHamburgerMenu::setMenuBarAdvertised()). + */ + void updateHamburgerMenu(); /** * Is called if the user clicked an item in the Places Panel. * Reloads the view if \a url is the current URL already, and changes the * current URL otherwise. */ - void slotPlaceActivated(const QUrl& url); + void slotPlaceActivated(const QUrl &url); /** * Is called if the another view has been activated by changing the current @@ -488,7 +535,7 @@ private slots: * to this view. When having a split view setup, the nonactive view is * usually shown in darker colors. */ - void activeViewChanged(DolphinViewContainer* viewContainer); + void activeViewChanged(DolphinViewContainer *viewContainer); void closedTabsCountChanged(unsigned int count); @@ -507,7 +554,7 @@ private slots: * This slot is called when the user requested to unmount a removable media * from the places menu */ - void slotStorageTearDownFromPlacesRequested(const QString& mountPath); + void slotStorageTearDownFromPlacesRequested(const QString &mountPath); /** * This slot is called when the user requested to unmount a removable media @@ -516,7 +563,7 @@ private slots: * Solid::StorageAccess::teardownRequested(const QString & udi) * signal through the places panel. */ - void slotStorageTearDownExternallyRequested(const QString& mountPath); + void slotStorageTearDownExternallyRequested(const QString &mountPath); /** * Is called when the view has finished loading the directory. @@ -542,7 +589,7 @@ private slots: * history index. The QAction::data will carry an int with the index * to go to. */ - void slotGoBack(QAction* action); + void slotGoBack(QAction *action); /** * Middle clicking Back/Forward will open the resulting folder in a new tab. @@ -560,7 +607,13 @@ private slots: * history index. The QAction::data will carry an int with the index * to go to. */ - void slotGoForward(QAction* action); + void slotGoForward(QAction *action); + + /** + * Is called when configuring the keyboard shortcuts + */ + void slotKeyBindings(); + private: /** * Sets up the various menus and actions and connects them. @@ -576,23 +629,13 @@ private: void updateViewActions(); void updateGoActions(); - void createControlButton(); - void deleteControlButton(); - - /** - * Adds the action \p action to the menu \p menu in - * case if it has not added already to the toolbar. - * @return True if the action has been added to the menu. - */ - bool addActionToMenu(QAction* action, QMenu* menu); - /** * Connects the signals from the created DolphinView with * the DolphinViewContainer \a container with the corresponding slots of * the DolphinMainWindow. This method must be invoked each * time a DolphinView has been created. */ - void connectViewSignals(DolphinViewContainer* container); + void connectViewSignals(DolphinViewContainer *container); /** * Updates the text of the split action: @@ -615,10 +658,7 @@ private: * as the action for toggling the dock visibility is done by Qt which * is no KAction instance. */ - void createPanelAction(const QIcon &icon, - const QKeySequence& shortcut, - QAction* dockAction, - const QString& actionName); + void createPanelAction(const QIcon &icon, const QKeySequence &shortcut, QAction *dockAction, const QString &actionName); /** Adds "What's This?" texts to many widgets and StandardActions. */ void setupWhatsThis(); @@ -626,6 +666,19 @@ private: /** Returns preferred search tool as configured in "More Search Tools" menu. */ QPointer preferredSearchTool(); + /** + * Adds this action to the mainWindow's toolbar and saves the change + * in the users ui configuration file. + * This method is only needed for migration and should be removed once we can expect + * that pretty much all users have been migrated. Remove in 2026 because that's when + * even the most risk-averse distros will already have been forced to upgrade. + * @return true if successful. Otherwise false. + */ + bool addHamburgerMenuToToolbar(); + + /** Creates an action representing an item in the URL navigator history */ + static QAction *urlNavigatorHistoryAction(const KUrlNavigator *urlNavigator, int historyIndex, QObject *parent = nullptr); + private: /** * Implements a custom error handling for the undo manager. This @@ -637,48 +690,42 @@ private: public: UndoUiInterface(); ~UndoUiInterface() override; - void jobError(KIO::Job* job) override; + void jobError(KIO::Job *job) override; }; - KNewFileMenu* m_newFileMenu; - KHelpMenu* m_helpMenu; - DolphinTabWidget* m_tabWidget; - DolphinViewContainer* m_activeViewContainer; + KNewFileMenu *m_newFileMenu; + DolphinTabWidget *m_tabWidget; + DolphinViewContainer *m_activeViewContainer; - DolphinViewActionHandler* m_actionHandler; - DolphinRemoteEncoding* m_remoteEncoding; + DolphinViewActionHandler *m_actionHandler; + DolphinRemoteEncoding *m_remoteEncoding; QPointer m_settingsDialog; - DolphinBookmarkHandler* m_bookmarkHandler; - - // Members for the toolbar menu that is shown when the menubar is hidden: - QToolButton* m_controlButton; - QTimer* m_updateToolBarTimer; + DolphinBookmarkHandler *m_bookmarkHandler; + SelectionMode::ActionTextHelper *m_actionTextHelper; KIO::OpenUrlJob *m_lastHandleUrlOpenJob; - TerminalPanel* m_terminalPanel; - PlacesPanel* m_placesPanel; + TerminalPanel *m_terminalPanel; + PlacesPanel *m_placesPanel; bool m_tearDownFromPlacesRequested; - KToolBarPopupAction* m_backAction; - KToolBarPopupAction* m_forwardAction; - - /** Makes sure that only one object is ever connected to the history. */ - QMetaObject::Connection m_updateHistoryConnection; + KToolBarPopupAction *m_backAction; + KToolBarPopupAction *m_forwardAction; QMenu m_searchTools; + KFileItemActions m_fileItemActions; + friend class DolphinMainWindowTest; }; -inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const +inline DolphinViewContainer *DolphinMainWindow::activeViewContainer() const { return m_activeViewContainer; } -inline KNewFileMenu* DolphinMainWindow::newFileMenu() const +inline KNewFileMenu *DolphinMainWindow::newFileMenu() const { return m_newFileMenu; } #endif // DOLPHIN_MAINWINDOW_H -