X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/c00478bbc1001d10dcfc04e9b0ea251620837e85..dd07a327:/src/dolphinmainwindow.h?ds=sidebyside diff --git a/src/dolphinmainwindow.h b/src/dolphinmainwindow.h index e99add896..ecc84b971 100644 --- a/src/dolphinmainwindow.h +++ b/src/dolphinmainwindow.h @@ -1,59 +1,79 @@ -/*************************************************************************** - * Copyright (C) 2006 by Peter Penz * - * Copyright (C) 2006 by Stefan Monov * - * Copyright (C) 2006 by Cvetoslav Ludmiloff * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program; if not, write to the * - * Free Software Foundation, Inc., * - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - ***************************************************************************/ +/* + * SPDX-FileCopyrightText: 2006 Peter Penz + * SPDX-FileCopyrightText: 2006 Stefan Monov + * SPDX-FileCopyrightText: 2006 Cvetoslav Ludmiloff + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ #ifndef DOLPHIN_MAINWINDOW_H #define DOLPHIN_MAINWINDOW_H -#include "dolphinview.h" -#include "sidebarpage.h" +#include "config-dolphin.h" +#include "disabledactionnotifier.h" +#include "dolphintabwidget.h" +#include "selectionmode/bottombar.h" +#include +#include +#include +#include -#include +#if HAVE_BALOO +#include "panels/information/informationpanel.h" +#endif -#include -#include -#include -#include +#include +#include +#include +#include +#include +#include +#include -#include +typedef KIO::FileUndoManager::CommandType CommandType; -class DolphinApplication; +class DolphinBookmarkHandler; +class DolphinViewActionHandler; +class DolphinSettingsDialog; class DolphinViewContainer; -class KNewMenu; -class KUrl; -class QSplitter; +class DolphinRemoteEncoding; +class DolphinTabWidget; +class KFileItem; +class KFileItemList; +class KJob; +class KNewFileMenu; +class KRecentFilesAction; +class KToolBarPopupAction; +class QToolButton; +class PlacesPanel; +class TerminalPanel; + +/** Used to identify that a custom command should be triggered on a view background double-click.*/ +constexpr QLatin1String customCommand{"CUSTOM_COMMAND"}; + +namespace KIO +{ +class OpenUrlJob; +class CommandLauncherJob; +} +namespace SelectionMode +{ +class ActionTextHelper; +} /** * @short Main window for Dolphin. * * 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") - Q_PROPERTY(int id READ getId SCRIPTABLE true) - friend class DolphinApplication; public: - virtual ~DolphinMainWindow(); + DolphinMainWindow(); + ~DolphinMainWindow() override; /** * Returns the currently active view. @@ -61,157 +81,241 @@ public: * having a split view setup, the nonactive view * is usually shown in darker colors. */ - DolphinViewContainer* activeViewContainer() const; + DolphinViewContainer *activeViewContainer() const; /** - * Returns true, if the main window contains two instances - * of a view container. The active view constainer can be - * accessed by DolphinMainWindow::activeViewContainer(). + * Returns view container for all tabs */ - bool isSplit() const; + QVector viewContainers() const; /** - * If the main window contains two instances of a view container - * (DolphinMainWindow::isSplit() returns true), then the - * two views get toggled (the right view is on the left, the left - * view on the right). + * Opens each directory in \p dirs in a separate tab. If \a splitView is set, + * 2 directories are collected within one tab. + * \pre \a dirs must contain at least one url. */ - void toggleViews(); - - /** Renames the item represented by \a oldUrl to \a newUrl. */ - void rename(const KUrl& oldUrl, const KUrl& newUrl); + void openDirectories(const QList &dirs, bool splitView); /** - * Refreshes the views of the main window by recreating them dependent from - * the given Dolphin settings. + * Opens the directories which contain the files \p files and selects all files. + * If \a splitView is set, 2 directories are collected within one tab. + * \pre \a files must contain at least one url. */ - void refreshViews(); + 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). */ - KNewMenu* newMenu() const; + KNewFileMenu *newFileMenu() const; + + /** + * Augments Qt's build-in QMainWindow context menu to add + * Dolphin-specific actions, such as "unlock panels". + */ + QMenu *createPopupMenu() override; /** - * Returns the 'Show Menubar' action which can be shared with - * other menus (e. g. a context menu). + * Switch the window's view containers' locations to display the home path + * for any which are currently displaying a location corresponding to or + * within mountPath. + * + * This typically done after unmounting a disk at mountPath to ensure that + * the window is not displaying an invalid location. */ - KAction* showMenuBarAction() const; + void setViewsToHomeIfMountPathOpen(const QString &mountPath); -public slots: /** - * Handles the dropping of URLs to the given - * destination. This is only called by the TreeViewSidebarPage. + * Enables or disables the session autosaving feature. + * + * @param enable If true, saves the session automatically after a fixed + * time interval from the last state change. */ - void dropUrls(const KUrl::List& urls, - const KUrl& destination); + void setSessionAutoSaveEnabled(bool enable); + + bool isFoldersPanelEnabled() const; + bool isInformationPanelEnabled() const; + bool isSplitViewEnabledInCurrentTab() const; + + /** + * Activates a user set action when double clicking the view's background. + */ + void slotDoubleClickViewBackground(Qt::MouseButton button); + +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. + * \pre \a dirs must contain at least one url. + * + * @note this function is overloaded so that it is callable via DBus. + */ + void openDirectories(const QStringList &dirs, bool splitView); + + /** + * Opens the directories which contain the files \p files and selects all files. + * If \a splitView is set, 2 directories are collected within one tab. + * \pre \a files must contain at least one url. + * + * @note this is overloaded so that this function is callable via DBus. + */ + void openFiles(const QStringList &files, bool splitView); + + /** + * Tries to raise/activate the Dolphin window. + */ + void activateWindow(const QString &activationToken); + + bool isActiveWindow(); /** - * Returns the main window ID used through DBus. + * Determines if a URL is open in any tab. + * @note Use of QString instead of QUrl is required to be callable via DBus. + * + * @param url URL to look for + * @returns true if url is currently open in a tab, false otherwise. */ - int getId() const; + bool isUrlOpen(const QString &url); /** - * Inform all affected dolphin components (sidebars, views) of an 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 + * of the active view. If not exactly one folder is selected, + * no pasting is done at all. + */ + void pasteIntoFolder(); + + /** + * Implementation of the MainWindowAdaptor/QDBusAbstractAdaptor interface. + * Inform all affected dolphin components (panels, views) of an URL * change. */ - void changeUrl(const KUrl& url); + void changeUrl(const QUrl &url); /** - * Inform all affected dolphin components that a selection change is - * requested. + * 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 changeSelection(const KFileItemList& selection); + void slotTerminalDirectoryChanged(const QUrl &url); /** Stores all settings and quits Dolphin. */ void quit(); -signals: /** - * Is send if the active view has been changed in - * the split view mode. + * Opens a new tab in the background showing the URL \a url. + * @return A pointer to the opened DolphinTabPage. + */ + DolphinTabPage *openNewTab(const QUrl &url); + + /** + * Opens a new tab showing the URL \a url and activate it. */ - void activeViewChanged(); + void openNewTabAndActivate(const QUrl &url); + /** + * 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 KUrl& url); + void urlChanged(const QUrl &url); /** - * Is emitted if information of an item is requested to be shown e. g. in the sidebar. + * 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. + */ + void settingsChanged(); protected: + /** @see QObject::event() */ + bool event(QEvent *event) override; + + /** @see QWidget::showEvent() */ + void showEvent(QShowEvent *event) override; + /** @see QMainWindow::closeEvent() */ - virtual void closeEvent(QCloseEvent* event); + void closeEvent(QCloseEvent *event) override; /** @see KMainWindow::saveProperties() */ - virtual void saveProperties(KConfigGroup& group); + void saveProperties(KConfigGroup &group) override; /** @see KMainWindow::readProperties() */ - virtual void readProperties(const KConfigGroup& group); + void readProperties(const KConfigGroup &group) override; -private slots: + /** Sets a sane initial window size **/ + QSize sizeHint() const override; + +protected Q_SLOTS: /** - * Opens the dialog for creating a directory. Is connected - * with the key shortcut for "new directory" (F10). + * Calls the base method KXmlGuiWindow::saveNewToolbarConfig(). + * Is also used to set toolbar constraints and UrlNavigator position + * based on the newly changed toolbar configuration. */ - void createDir(); - - /** Updates the 'Create New...' sub menu. */ - void updateNewMenu(); + void saveNewToolbarConfig() override; +private Q_SLOTS: /** - * Let the user input a name for the selected item(s) and trigger - * a renaming afterwards. + * Refreshes the views of the main window by recreating them according to + * the given Dolphin settings. */ - void rename(); + void refreshViews(); - /** Moves the selected items of the active view to the trash. */ - void moveToTrash(); + void clearStatusBar(); - /** Deletes the selected items of the active view. */ - void deleteItems(); + /** Updates the 'Create New...' sub menu. */ + void updateNewMenu(); - /** - * Opens the properties window for the selected items of the - * active view. The properties windows shows information - * like name, size and permissions. - */ - void properties(); + void createDirectory(); + void createFile(); - /** - * Shows the error information from the places model - * in the status bar. - */ - void slotHandlePlacesError(const QString &message); + /** Shows the error message in the status bar of the active view. */ + void showErrorMessage(const QString &message); /** * Updates the state of the 'Undo' menu action dependent - * from the parameter \a available. + * on the parameter \a available. */ 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(); /** * Copies all selected items to the clipboard and marks - * the items as cutted. + * the items as cut. */ void cut(); @@ -221,12 +325,21 @@ private slots: /** Pastes the clipboard data to the active view. */ void paste(); + /** Replaces the URL navigator by a search box to find files. */ + void find(); + + /** Updates the state of the search action according to the view container. */ + void updateSearchAction(); + /** - * Updates the text of the paste action dependent from + * Updates the text of the paste action dependent on * the number of items which are in the clipboard. */ 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(); @@ -237,112 +350,78 @@ private slots: */ void invertSelection(); - /** The current active view is switched to a new view mode. */ - void setViewMode(QAction *); - - /** The sorting of the current view should be done by the name. */ - void sortByName(); - - /** The sorting of the current view should be done by the size. */ - void sortBySize(); - - /** The sorting of the current view should be done by the date. */ - void sortByDate(); - - /** The sorting of the current view should be done by the permissions. */ - void sortByPermissions(); - - /** The sorting of the current view should be done by the owner. */ - void sortByOwner(); - - /** The sorting of the current view should be done by the group. */ - void sortByGroup(); - - /** The sorting of the current view should be done by the type. */ - void sortByType(); - - /** The sorting of the current view should be done by the rating. */ - void sortByRating(); - - /** The sorting of the current view should be done by tags. */ - void sortByTags(); - - /** Switches between an ascending and descending sorting order. */ - void toggleSortOrder(); - - /** Switches between sorting by categories or not. */ - void toggleSortCategorization(); - - /** Switches between showing the size as additional information for the item or not. */ - void toggleSizeInfo(); - - /** Switchtes between showing the date as additional information for the item or not. */ - void toggleDateInfo(); - - /** Switchtes between showing the permissions as additional information for the item or not. */ - void togglePermissionsInfo(); - - /** Switchtes between showing the owner as additional information for the item or not. */ - void toggleOwnerInfo(); - - /** Switchtes between showing the group as additional information for the item or not. */ - void toggleGroupInfo(); - - /** Switches between showing the MIME type as additional information for the item or not. */ - void toggleMimeInfo(); - /** * Switches between one and two views: * If one view is visible, it will get split into two views. - * If already two views are visible, the nonactivated view gets closed. + * If already two views are visible, the active view gets closed. */ void toggleSplitView(); - /** Reloads the current active view. */ + /** + * Pops out a split view. + * The active view will be popped out, unless the view is not split, + * in which case nothing will happen. + */ + void popoutSplitView(); + + /** 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(); - /** Stops the loading process for the current active view. */ + /** Stops the loading process for the currently active view. */ void stopLoading(); - /** Switches between showing a preview of the file content and showing the icon. */ - void togglePreview(); + void enableStopAction(); + void disableStopAction(); + + void toggleSelectionMode(); + + void showFilterBar(); + void toggleFilterBar(); /** - * Switches between showing and hiding of hidden marked files dependent - * from the current state of the 'Show Hidden Files' menu toggle action. + * Toggles between edit and browse mode of the navigation bar. */ - void toggleShowHiddenFiles(); + void toggleEditLocation(); /** - * Toggles between showing and hiding of the filter bar dependent - * from the current state of the 'Show Filter Bar' menu toggle action. + * Switches to the edit mode of the navigation bar and selects + * the whole URL, so that it can be replaced by the user. If the edit mode is + * already active, it is assured that the navigation bar get focused. */ - void toggleFilterBarVisibility(); - - /** Increases the size of the current set view mode. */ - void zoomIn(); - - /** Decreases the size of the current set view mode. */ - void zoomOut(); + void replaceLocation(); /** - * Toggles between edit and brose mode of the navigation bar. + * Toggles the state of the panels between a locked and unlocked layout. */ - void toggleEditLocation(); + void togglePanelLockState(); /** - * Switches to the edit mode of the navigation bar. If the edit mode is - * already active, it is assured that the navigation bar get focused. + * Is invoked whenever the Terminal panel visibility is changed by the user and then moves the focus + * to the active view if the panel was hidden. + * @note The opposite action (putting focus to the Terminal) is not handled + * here but in TerminalPanel::showEvent(). + * @param visible the new visibility state of the terminal panel */ - void editLocation(); + void slotTerminalPanelVisibilityChanged(bool visible); /** - * Opens the view properties dialog, which allows to modify the properties - * of the currently active view. + * Is invoked whenever the Places panel visibility is changed by the user and then either moves the focus + * - to the Places panel if it was made visible, or + * - to the active view if the panel was hidden. + * @param visible the new visibility state of the Places panel */ - void adjustViewProperties(); + void slotPlacesPanelVisibilityChanged(bool visible); - /** Goes back on step of the URL history. */ + /** Goes back one step of the URL history. */ void goBack(); /** Goes forward one step of the URL history. */ @@ -351,11 +430,20 @@ private slots: /** Goes up one hierarchy of the current URL. */ void goUp(); - /** Goes to the home URL. */ + /** Changes the location to the home URL. */ void goHome(); - /** Opens KFind for the current shown directory. */ - void findFile(); + /** Open the previous URL in the URL history in a new tab. */ + void goBackInNewTab(); + + /** Open the next URL in the URL history in a new tab. */ + void goForwardInNewTab(); + + /** Open the URL one hierarchy above the current URL in a new tab. */ + void goUpInNewTab(); + + /** * Open the home URL in a new tab. */ + void goHomeInNewTab(); /** Opens Kompare for 2 selected files. */ void compareFiles(); @@ -366,44 +454,44 @@ private slots: */ void toggleShowMenuBar(); - /** Opens the settings dialog for Dolphin. */ - void editSettings(); + /** Updates "Open Preferred Search Tool" action. */ + void updateOpenPreferredSearchToolAction(); - /** Updates the state of all 'View' menu actions. */ - void slotViewModeChanged(); + /** Opens preferred search tool for the current location. */ + void openPreferredSearchTool(); - /** Updates the state of the 'Show preview' menu action. */ - void slotShowPreviewChanged(); + /** Opens a terminal window for the current location. */ + void openTerminal(); - /** Updates the state of the 'Show hidden files' menu action. */ - void slotShowHiddenFilesChanged(); + /** Opens terminal windows for the selected items' locations. */ + void openTerminalHere(); - /** Updates the state of the 'Categorized sorting' menu action. */ - void slotCategorizedSortingChanged(); + /** Opens a terminal window for the URL. */ + void openTerminalJob(const QUrl &url); - /** Updates the state of the 'Sort by' actions. */ - void slotSortingChanged(DolphinView::Sorting sorting); + /** Toggles focus to/from a Terminal Panel. */ + void toggleTerminalPanelFocus(); - /** Updates the state of the 'Sort Ascending/Descending' action. */ - void slotSortOrderChanged(Qt::SortOrder order); + /** Toggles focus to/from the Places Panel. */ + void togglePlacesPanelFocus(); - /** Updates the state of the 'Additional Information' actions. */ - void slotAdditionalInfoChanged(KFileItemDelegate::InformationList info); + /** Opens the settings dialog for Dolphin. */ + void editSettings(); + + /** Updates the state of the 'Show Full Location' action. */ + void slotEditableStateChanged(bool editable); /** * Updates the state of the 'Edit' menu actions and emits * the signal selectionChanged(). */ - void slotSelectionChanged(const KFileItemList& selection); - - /** Emits the signal requestItemInfo(). */ - void slotRequestItemInfo(const KFileItem&); + void slotSelectionChanged(const KFileItemList &selection); /** * Updates the state of the 'Back' and 'Forward' menu - * actions corresponding the the current history. + * actions corresponding to the current history. */ - void slotHistoryChanged(); + void updateHistory(); /** Updates the state of the 'Show filter bar' menu action. */ void updateFilterBarAction(bool show); @@ -411,39 +499,197 @@ private slots: /** Open a new main window. */ void openNewMainWindow(); - /** Toggles the active view if two views are shown within the main window. */ - void toggleActiveView(); + /** + * Opens a new view with the current URL that is part of a tab and + * activates it. + */ + void openNewActivatedTab(); - /** Called when the view is doing a file operation, like renaming, copying, moving etc. */ - void slotDoingOperation(KonqFileUndoManager::CommandType type); + /** + * Adds the current URL as an entry to the Places panel + */ + void addToPlaces(); -private: - DolphinMainWindow(int id); - void init(); + /** + * Opens the selected folder in a new tab. + */ + void openInNewTab(); /** - * Activates the given view, which means that - * all menu actions are applied to this view. When - * having a split view setup, the nonactive view - * is usually shown in darker colors. + * Opens the selected folder in a new window. + */ + void openInNewWindow(); + + /** + * Opens the selected folder in the other inactive split view, enables split view if necessary. + */ + void openInSplitView(const QUrl &url); + + /** + * Show the target of the selected symlink + */ + void showTarget(); + + /** + * Indicates in the statusbar that the execution of the command \a command + * has been finished. + */ + void showCommand(CommandType command); + + /** + * If the URL can be listed, open it in the current view, otherwise + * run it through KRun. + */ + void handleUrl(const QUrl &url); + + /** + * Is invoked when the write state of a folder has been changed and + * enables/disables the "Create New..." menu entry. + */ + void slotWriteStateChanged(bool isFolderWritable); + + /** + * Opens the context menu on the current mouse position. + * @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. + */ + void openContextMenu(const QPoint &pos, const KFileItem &item, const KFileItemList &selectedItems, const QUrl &url); + + /** + * 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); + + /** + * Is called if the another view has been activated by changing the current + * tab or activating another view in split-view mode. + * + * Activates the given view, which means that all menu actions are applied + * to this view. When having a split view setup, the nonactive view is + * usually shown in darker colors. + */ + void activeViewChanged(DolphinViewContainer *viewContainer); + + void closedTabsCountChanged(unsigned int count); + + /** + * Is called if a new tab has been opened or a tab has been closed to + * enable/disable the tab actions. + */ + void tabCountChanged(int count); + + /** + * Updates the Window Title with the caption from the active view container + */ + void updateWindowTitle(); + + /** + * This slot is called when the user requested to unmount a removable media + * from the places menu + */ + void slotStorageTearDownFromPlacesRequested(const QString &mountPath); + + /** + * This slot is called when the user requested to unmount a removable media + * _not_ from the dolphin's places menu (from the notification area for e.g.) + * This slot is basically connected to each removable device's + * Solid::StorageAccess::teardownRequested(const QString & udi) + * signal through the places panel. + */ + void slotStorageTearDownExternallyRequested(const QString &mountPath); + + /** + * Is called when the view has finished loading the directory. + */ + void slotDirectoryLoadingCompleted(); + + /** + * Is called when the user middle clicks a toolbar button. + * + * Here middle clicking Back/Forward/Up/Home will open the resulting + * folder in a new tab. + */ + void slotToolBarActionMiddleClicked(QAction *action); + + /** + * Is called before the Back popup menu is shown. This slot will populate + * the menu with history data + */ + void slotAboutToShowBackPopupMenu(); + + /** + * This slot is used by the Back Popup Menu to go back to a specific + * history index. The QAction::data will carry an int with the index + * to go to. + */ + void slotGoBack(QAction *action); + + /** + * Middle clicking Back/Forward will open the resulting folder in a new tab. */ - void setActiveViewContainer(DolphinViewContainer* view); + void slotBackForwardActionMiddleClicked(QAction *action); + /** + * Is called before the Forward popup menu is shown. This slot will populate + * the menu with history data + */ + void slotAboutToShowForwardPopupMenu(); + + /** + * This slot is used by the Forward Popup Menu to go forward to a specific + * history index. The QAction::data will carry an int with the index + * to go to. + */ + void slotGoForward(QAction *action); + + /** + * Is called when configuring the keyboard shortcuts + */ + void slotKeyBindings(); + + /** + * Saves the session. + */ + void slotSaveSession(); + +private: + /** + * Sets up the various menus and actions and connects them. + */ void setupActions(); + + /** + * Sets up the dock widgets and their panels. + */ void setupDockWidgets(); - void updateHistory(); - void updateEditActions(); + + void updateFileAndEditActions(); void updateViewActions(); void updateGoActions(); - void clearStatusBar(); /** * Connects the signals from the created DolphinView with - * the index \a viewIndex with the corresponding slots of + * 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(int viewIndex); + void connectViewSignals(DolphinViewContainer *container); /** * Updates the text of the split action: @@ -451,78 +697,98 @@ private: * otherwise the text is set to "Join". The icon * is updated to match with the text and the currently active view. */ - void updateSplitAction(); + void updateSplitActions(); /** - * Helper method for the slots toggleDateInfo(), toggleSizeInfo() - * and toggleMimeInfo(). Applies \a info dependent from the current - * checked state of the action \a actionName to the file item delegate. + * Sets the window sides the toolbar may be moved to based on toolbar contents. */ - void toggleAdditionalInfo(const char* actionName, - KFileItemDelegate::Information info); + void updateAllowedToolbarAreas(); + + bool isKompareInstalled() const; -private: /** - * DolphinMainWindow supports up to two views beside each other. + * Creates an action for showing/hiding a panel, that is accessible + * in "Configure toolbars..." and "Configure shortcuts...". */ - enum ViewIndex - { - PrimaryView = 0, ///< View shown on the left side of the main window. - SecondaryView = 1 ///< View shown on the left side of the main window. - }; + void createPanelAction(const QIcon &icon, const QKeySequence &shortcut, QDockWidget *dockAction, const QString &actionName); + + /** Adds "What's This?" texts to many widgets and StandardActions. */ + void setupWhatsThis(); + + /** 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 * assures that all errors are shown in the status bar of Dolphin * instead as modal error dialog with an OK button. */ - class UndoUiInterface : public KonqFileUndoManager::UiInterface + class UndoUiInterface : public KIO::FileUndoManager::UiInterface { public: - UndoUiInterface(DolphinMainWindow* mainWin); - virtual ~UndoUiInterface(); - virtual void jobError(KIO::Job* job); - - private: - DolphinMainWindow* m_mainWin; + UndoUiInterface(); + ~UndoUiInterface() override; + void jobError(KIO::Job *job) override; }; - KNewMenu* m_newMenu; - KAction* m_showMenuBar; - QSplitter* m_splitter; - DolphinViewContainer* m_activeViewContainer; - int m_id; + KNewFileMenu *m_newFileMenu; + DolphinTabWidget *m_tabWidget; + DolphinViewContainer *m_activeViewContainer; - DolphinViewContainer* m_viewContainer[SecondaryView + 1]; + DolphinViewActionHandler *m_actionHandler; + DolphinRemoteEncoding *m_remoteEncoding; + QPointer m_settingsDialog; + DolphinBookmarkHandler *m_bookmarkHandler; + SelectionMode::ActionTextHelper *m_actionTextHelper; + DisabledActionNotifier *m_disabledActionNotifier; - /// remember pending undo operations until they are finished - QList m_undoCommandTypes; -}; + KIO::OpenUrlJob *m_lastHandleUrlOpenJob; -inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const -{ - return m_activeViewContainer; -} + TerminalPanel *m_terminalPanel; + PlacesPanel *m_placesPanel; + bool m_tearDownFromPlacesRequested; -inline bool DolphinMainWindow::isSplit() const -{ - return m_viewContainer[SecondaryView] != 0; -} + KToolBarPopupAction *m_backAction; + KToolBarPopupAction *m_forwardAction; + KActionMenu *m_splitViewAction; + QAction *m_splitViewMenuAction; -inline KNewMenu* DolphinMainWindow::newMenu() const -{ - return m_newMenu; -} + QMenu m_searchTools; + KFileItemActions m_fileItemActions; + + QTimer *m_sessionSaveTimer; + QFutureWatcher *m_sessionSaveWatcher; + bool m_sessionSaveScheduled; -inline KAction* DolphinMainWindow::showMenuBarAction() const + KIO::CommandLauncherJob *m_job; + + KRecentFilesAction *m_recentFiles = nullptr; + + friend class DolphinMainWindowTest; +}; + +inline DolphinViewContainer *DolphinMainWindow::activeViewContainer() const { - return m_showMenuBar; + return m_activeViewContainer; } -inline int DolphinMainWindow::getId() const +inline KNewFileMenu *DolphinMainWindow::newFileMenu() const { - return m_id; + return m_newFileMenu; } #endif // DOLPHIN_MAINWINDOW_H -