2 * SPDX-FileCopyrightText: 2006 Peter Penz <peter.penz19@gmail.com>
3 * SPDX-FileCopyrightText: 2006 Stefan Monov <logixoul@gmail.com>
4 * SPDX-FileCopyrightText: 2006 Cvetoslav Ludmiloff <ludmiloff@gmail.com>
6 * SPDX-License-Identifier: GPL-2.0-or-later
9 #ifndef DOLPHIN_MAINWINDOW_H
10 #define DOLPHIN_MAINWINDOW_H
12 #include "config-dolphin.h"
13 #include "disabledactionnotifier.h"
14 #include "dolphintabwidget.h"
15 #include "selectionmode/bottombar.h"
16 #include <KActionMenu>
17 #include <KFileItemActions>
18 #include <kio/fileundomanager.h>
19 #include <kxmlguiwindow.h>
22 #include "panels/information/informationpanel.h"
25 #include <QFutureWatcher>
33 typedef KIO::FileUndoManager::CommandType CommandType
;
35 class DolphinBookmarkHandler
;
36 class DolphinViewActionHandler
;
37 class DolphinSettingsDialog
;
38 class DolphinViewContainer
;
39 class DolphinRemoteEncoding
;
40 class DolphinTabWidget
;
45 class KRecentFilesAction
;
46 class KToolBarPopupAction
;
51 /** Used to identify that a custom command should be triggered on a view background double-click.*/
52 constexpr QLatin1String customCommand
{"CUSTOM_COMMAND"};
57 class CommandLauncherJob
;
59 namespace SelectionMode
61 class ActionTextHelper
;
65 * @short Main window for Dolphin.
67 * Handles the menus, toolbars and Dolphin views.
69 class DolphinMainWindow
: public KXmlGuiWindow
72 Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow")
76 ~DolphinMainWindow() override
;
79 * Returns the currently active view.
80 * All menu actions are applied to this view. When
81 * having a split view setup, the nonactive view
82 * is usually shown in darker colors.
84 DolphinViewContainer
*activeViewContainer() const;
87 * Returns view container for all tabs
89 QVector
<DolphinViewContainer
*> viewContainers() const;
92 * Opens each directory in \p dirs in a separate tab. If \a splitView is set,
93 * 2 directories are collected within one tab.
94 * \pre \a dirs must contain at least one url.
96 void openDirectories(const QList
<QUrl
> &dirs
, bool splitView
);
99 * Opens the directories which contain the files \p files and selects all files.
100 * If \a splitView is set, 2 directories are collected within one tab.
101 * \pre \a files must contain at least one url.
103 void openFiles(const QList
<QUrl
> &files
, bool splitView
);
106 * Returns the 'Create New...' sub menu which also can be shared
107 * with other menus (e. g. a context menu).
109 KNewFileMenu
*newFileMenu() const;
112 * Augments Qt's build-in QMainWindow context menu to add
113 * Dolphin-specific actions, such as "unlock panels".
115 QMenu
*createPopupMenu() override
;
118 * Switch the window's view containers' locations to display the home path
119 * for any which are currently displaying a location corresponding to or
122 * This typically done after unmounting a disk at mountPath to ensure that
123 * the window is not displaying an invalid location.
125 void setViewsToHomeIfMountPathOpen(const QString
&mountPath
);
128 * Enables or disables the session autosaving feature.
130 * @param enable If true, saves the session automatically after a fixed
131 * time interval from the last state change.
133 void setSessionAutoSaveEnabled(bool enable
);
135 bool isFoldersPanelEnabled() const;
136 bool isInformationPanelEnabled() const;
137 bool isSplitViewEnabledInCurrentTab() const;
140 * Activates a user set action when double clicking the view's background.
142 void slotDoubleClickViewBackground(Qt::MouseButton button
);
146 * Opens each directory in \p dirs in a separate tab. If \a splitView is set,
147 * 2 directories are collected within one tab.
148 * \pre \a dirs must contain at least one url.
150 * @note this function is overloaded so that it is callable via DBus.
152 void openDirectories(const QStringList
&dirs
, bool splitView
);
155 * Opens the directories which contain the files \p files and selects all files.
156 * If \a splitView is set, 2 directories are collected within one tab.
157 * \pre \a files must contain at least one url.
159 * @note this is overloaded so that this function is callable via DBus.
161 void openFiles(const QStringList
&files
, bool splitView
);
164 * Tries to raise/activate the Dolphin window.
166 void activateWindow(const QString
&activationToken
);
168 bool isActiveWindow();
171 * Determines if a URL is open in any tab.
172 * @note Use of QString instead of QUrl is required to be callable via DBus.
174 * @param url URL to look for
175 * @returns true if url is currently open in a tab, false otherwise.
177 bool isUrlOpen(const QString
&url
);
180 * @return Whether the item with @p url can be found in any view only by switching
181 * between already open tabs and scrolling in their primary or secondary view.
182 * @note Use of QString instead of QUrl is required to be callable via DBus.
184 bool isItemVisibleInAnyView(const QString
&urlOfItem
);
187 * Pastes the clipboard data into the currently selected folder
188 * of the active view. If not exactly one folder is selected,
189 * no pasting is done at all.
191 void pasteIntoFolder();
194 * Implementation of the MainWindowAdaptor/QDBusAbstractAdaptor interface.
195 * Inform all affected dolphin components (panels, views) of an URL
198 void changeUrl(const QUrl
&url
);
201 * The current directory of the Terminal Panel has changed, probably because
202 * the user entered a 'cd' command. This slot calls changeUrl(url) and makes
203 * sure that the panel keeps the keyboard focus.
205 void slotTerminalDirectoryChanged(const QUrl
&url
);
207 /** Stores all settings and quits Dolphin. */
211 * Opens a new tab in the background showing the URL \a url.
212 * @return A pointer to the opened DolphinTabPage.
214 DolphinTabPage
*openNewTab(const QUrl
&url
);
217 * Opens a new tab showing the URL \a url and activate it.
219 void openNewTabAndActivate(const QUrl
&url
);
222 * Opens a new window showing the URL \a url.
224 void openNewWindow(const QUrl
&url
);
226 /** @see GeneralSettings::splitViewChanged() */
227 void slotSplitViewChanged();
231 * Is sent if the selection of the currently active view has
234 void selectionChanged(const KFileItemList
&selection
);
237 * Is sent if the url of the currently active view has
240 void urlChanged(const QUrl
&url
);
243 * Is emitted if information of an item is requested to be shown e. g. in the panel.
244 * If item is null, no item information request is pending.
246 void requestItemInfo(const KFileItem
&item
);
249 * It is emitted when in the current view, files are changed,
250 * or dirs have files/removed from them.
252 void fileItemsChanged(const KFileItemList
&changedFileItems
);
255 * Is emitted if the settings have been changed.
257 void settingsChanged();
260 /** @see QObject::event() */
261 bool event(QEvent
*event
) override
;
263 /** @see QWidget::showEvent() */
264 void showEvent(QShowEvent
*event
) override
;
266 /** @see QMainWindow::closeEvent() */
267 void closeEvent(QCloseEvent
*event
) override
;
269 /** @see KMainWindow::saveProperties() */
270 void saveProperties(KConfigGroup
&group
) override
;
272 /** @see KMainWindow::readProperties() */
273 void readProperties(const KConfigGroup
&group
) override
;
275 /** Sets a sane initial window size **/
276 QSize
sizeHint() const override
;
280 * Calls the base method KXmlGuiWindow::saveNewToolbarConfig().
281 * Is also used to set toolbar constraints and UrlNavigator position
282 * based on the newly changed toolbar configuration.
284 void saveNewToolbarConfig() override
;
288 * Refreshes the views of the main window by recreating them according to
289 * the given Dolphin settings.
293 void clearStatusBar();
295 /** Updates the 'Create New...' sub menu. */
296 void updateNewMenu();
298 void createDirectory();
300 /** Shows the error message in the status bar of the active view. */
301 void showErrorMessage(const QString
&message
);
304 * Updates the state of the 'Undo' menu action dependent
305 * on the parameter \a available.
307 void slotUndoAvailable(bool available
);
309 /** Sets the text of the 'Undo' menu action to \a text. */
310 void slotUndoTextChanged(const QString
&text
);
312 /** Performs the current undo operation. */
316 * Copies all selected items to the clipboard and marks
321 /** Copies all selected items to the clipboard. */
324 /** Pastes the clipboard data to the active view. */
327 /** Replaces the URL navigator by a search box to find files. */
330 /** Updates the state of the search action according to the view container. */
331 void updateSearchAction();
334 * Updates the text of the paste action dependent on
335 * the number of items which are in the clipboard.
337 void updatePasteAction();
339 /** Calls DolphinViewContainer::setSelectionMode() for m_activeViewContainer. */
340 void slotSetSelectionMode(bool enabled
, SelectionMode::BottomBar::Contents bottomBarContents
);
342 /** Selects all items from the active view. */
346 * Inverts the selection of all items of the active view:
347 * Selected items get nonselected and nonselected items get
350 void invertSelection();
353 * Switches between one and two views:
354 * If one view is visible, it will get split into two views.
355 * If already two views are visible, the active view gets closed.
357 void toggleSplitView();
360 * Pops out a split view.
361 * The active view will be popped out, unless the view is not split,
362 * in which case nothing will happen.
364 void popoutSplitView();
366 /** Dedicated action to open the stash:/ ioslave in split view. */
367 void toggleSplitStash();
369 /** Copies all selected items to the inactive view. */
370 void copyToInactiveSplitView();
372 /** Moves all selected items to the inactive view. */
373 void moveToInactiveSplitView();
375 /** Reloads the currently active view. */
378 /** Stops the loading process for the currently active view. */
381 void enableStopAction();
382 void disableStopAction();
384 void toggleSelectionMode();
386 void showFilterBar();
387 void toggleFilterBar();
390 * Toggles between edit and browse mode of the navigation bar.
392 void toggleEditLocation();
395 * Switches to the edit mode of the navigation bar and selects
396 * the whole URL, so that it can be replaced by the user. If the edit mode is
397 * already active, it is assured that the navigation bar get focused.
399 void replaceLocation();
402 * Toggles the state of the panels between a locked and unlocked layout.
404 void togglePanelLockState();
407 * Is invoked whenever the Terminal panel visibility is changed by the user and then moves the focus
408 * to the active view if the panel was hidden.
409 * @note The opposite action (putting focus to the Terminal) is not handled
410 * here but in TerminalPanel::showEvent().
411 * @param visible the new visibility state of the terminal panel
413 void slotTerminalPanelVisibilityChanged(bool visible
);
416 * Is invoked whenever the Places panel visibility is changed by the user and then either moves the focus
417 * - to the Places panel if it was made visible, or
418 * - to the active view if the panel was hidden.
419 * @param visible the new visibility state of the Places panel
421 void slotPlacesPanelVisibilityChanged(bool visible
);
423 /** Goes back one step of the URL history. */
426 /** Goes forward one step of the URL history. */
429 /** Goes up one hierarchy of the current URL. */
432 /** Changes the location to the home URL. */
435 /** Open the previous URL in the URL history in a new tab. */
436 void goBackInNewTab();
438 /** Open the next URL in the URL history in a new tab. */
439 void goForwardInNewTab();
441 /** Open the URL one hierarchy above the current URL in a new tab. */
444 /** * Open the home URL in a new tab. */
445 void goHomeInNewTab();
447 /** Opens Kompare for 2 selected files. */
451 * Hides the menu bar if it is visible, makes the menu bar
452 * visible if it is hidden.
454 void toggleShowMenuBar();
456 /** Updates "Open Preferred Search Tool" action. */
457 void updateOpenPreferredSearchToolAction();
459 /** Opens preferred search tool for the current location. */
460 void openPreferredSearchTool();
462 /** Opens a terminal window for the current location. */
465 /** Opens terminal windows for the selected items' locations. */
466 void openTerminalHere();
468 /** Opens a terminal window for the URL. */
469 void openTerminalJob(const QUrl
&url
);
471 /** Toggles focus to/from a Terminal Panel. */
472 void toggleTerminalPanelFocus();
474 /** Toggles focus to/from the Places Panel. */
475 void togglePlacesPanelFocus();
477 /** Opens the settings dialog for Dolphin. */
480 /** Updates the state of the 'Show Full Location' action. */
481 void slotEditableStateChanged(bool editable
);
484 * Updates the state of the 'Edit' menu actions and emits
485 * the signal selectionChanged().
487 void slotSelectionChanged(const KFileItemList
&selection
);
490 * Updates the state of the 'Back' and 'Forward' menu
491 * actions corresponding to the current history.
493 void updateHistory();
495 /** Updates the state of the 'Show filter bar' menu action. */
496 void updateFilterBarAction(bool show
);
498 /** Open a new main window. */
499 void openNewMainWindow();
502 * Opens a new view with the current URL that is part of a tab and
505 void openNewActivatedTab();
508 * Adds the current URL as an entry to the Places panel
513 * Opens the selected folder in a new tab.
518 * Opens the selected folder in a new window.
520 void openInNewWindow();
523 * Opens the selected folder in the other inactive split view, enables split view if necessary.
525 void openInSplitView(const QUrl
&url
);
528 * Show the target of the selected symlink
533 * Indicates in the statusbar that the execution of the command \a command
536 void showCommand(CommandType command
);
539 * If the URL can be listed, open it in the current view, otherwise
540 * run it through KRun.
542 void handleUrl(const QUrl
&url
);
545 * Is invoked when the write state of a folder has been changed and
546 * enables/disables the "Create New..." menu entry.
548 void slotWriteStateChanged(bool isFolderWritable
);
551 * Opens the context menu on the current mouse position.
552 * @pos Position in screen coordinates.
553 * @item File item context. If item is null, the context menu
554 * should be applied to \a url.
555 * @selectedItems The selected items for which the context menu
556 * is opened. This list generally includes \a item.
557 * @url URL which contains \a item.
559 void openContextMenu(const QPoint
&pos
, const KFileItem
&item
, const KFileItemList
&selectedItems
, const QUrl
&url
);
562 * Updates the menu that is by default at the right end of the toolbar.
564 * In true "simple by default" fashion, the menu only contains the most important
565 * and necessary actions to be able to use Dolphin. This is supposed to hold true even
566 * if the user does not know how to open a context menu. More advanced actions can be
567 * discovered through a sub-menu (@see KConfigWidgets::KHamburgerMenu::setMenuBarAdvertised()).
569 void updateHamburgerMenu();
572 * Is called if the user clicked an item in the Places Panel.
573 * Reloads the view if \a url is the current URL already, and changes the
574 * current URL otherwise.
576 void slotPlaceActivated(const QUrl
&url
);
579 * Is called if the another view has been activated by changing the current
580 * tab or activating another view in split-view mode.
582 * Activates the given view, which means that all menu actions are applied
583 * to this view. When having a split view setup, the nonactive view is
584 * usually shown in darker colors.
586 void activeViewChanged(DolphinViewContainer
*viewContainer
);
588 void closedTabsCountChanged(unsigned int count
);
591 * Is called if a new tab has been opened or a tab has been closed to
592 * enable/disable the tab actions.
594 void tabCountChanged(int count
);
597 * Updates the Window Title with the caption from the active view container
599 void updateWindowTitle();
602 * This slot is called when the user requested to unmount a removable media
603 * from the places menu
605 void slotStorageTearDownFromPlacesRequested(const QString
&mountPath
);
608 * This slot is called when the user requested to unmount a removable media
609 * _not_ from the dolphin's places menu (from the notification area for e.g.)
610 * This slot is basically connected to each removable device's
611 * Solid::StorageAccess::teardownRequested(const QString & udi)
612 * signal through the places panel.
614 void slotStorageTearDownExternallyRequested(const QString
&mountPath
);
617 * Is called when the view has finished loading the directory.
619 void slotDirectoryLoadingCompleted();
622 * Is called when the user middle clicks a toolbar button.
624 * Here middle clicking Back/Forward/Up/Home will open the resulting
625 * folder in a new tab.
627 void slotToolBarActionMiddleClicked(QAction
*action
);
630 * Is called before the Back popup menu is shown. This slot will populate
631 * the menu with history data
633 void slotAboutToShowBackPopupMenu();
636 * This slot is used by the Back Popup Menu to go back to a specific
637 * history index. The QAction::data will carry an int with the index
640 void slotGoBack(QAction
*action
);
643 * Middle clicking Back/Forward will open the resulting folder in a new tab.
645 void slotBackForwardActionMiddleClicked(QAction
*action
);
648 * Is called before the Forward popup menu is shown. This slot will populate
649 * the menu with history data
651 void slotAboutToShowForwardPopupMenu();
654 * This slot is used by the Forward Popup Menu to go forward to a specific
655 * history index. The QAction::data will carry an int with the index
658 void slotGoForward(QAction
*action
);
661 * Is called when configuring the keyboard shortcuts
663 void slotKeyBindings();
668 void slotSaveSession();
672 * Sets up the various menus and actions and connects them.
677 * Sets up the dock widgets and their panels.
679 void setupDockWidgets();
681 void updateFileAndEditActions();
682 void updateViewActions();
683 void updateGoActions();
686 * Connects the signals from the created DolphinView with
687 * the DolphinViewContainer \a container with the corresponding slots of
688 * the DolphinMainWindow. This method must be invoked each
689 * time a DolphinView has been created.
691 void connectViewSignals(DolphinViewContainer
*container
);
694 * Updates the text of the split action:
695 * If two views are shown, the text is set to "Split",
696 * otherwise the text is set to "Join". The icon
697 * is updated to match with the text and the currently active view.
699 void updateSplitActions();
702 * Sets the window sides the toolbar may be moved to based on toolbar contents.
704 void updateAllowedToolbarAreas();
706 bool isKompareInstalled() const;
709 * Creates an action for showing/hiding a panel, that is accessible
710 * in "Configure toolbars..." and "Configure shortcuts...".
712 void createPanelAction(const QIcon
&icon
, const QKeySequence
&shortcut
, QDockWidget
*dockAction
, const QString
&actionName
);
714 /** Adds "What's This?" texts to many widgets and StandardActions. */
715 void setupWhatsThis();
717 /** Returns preferred search tool as configured in "More Search Tools" menu. */
718 QPointer
<QAction
> preferredSearchTool();
721 * Adds this action to the mainWindow's toolbar and saves the change
722 * in the users ui configuration file.
723 * This method is only needed for migration and should be removed once we can expect
724 * that pretty much all users have been migrated. Remove in 2026 because that's when
725 * even the most risk-averse distros will already have been forced to upgrade.
726 * @return true if successful. Otherwise false.
728 bool addHamburgerMenuToToolbar();
730 /** Creates an action representing an item in the URL navigator history */
731 static QAction
*urlNavigatorHistoryAction(const KUrlNavigator
*urlNavigator
, int historyIndex
, QObject
*parent
= nullptr);
735 * Implements a custom error handling for the undo manager. This
736 * assures that all errors are shown in the status bar of Dolphin
737 * instead as modal error dialog with an OK button.
739 class UndoUiInterface
: public KIO::FileUndoManager::UiInterface
743 ~UndoUiInterface() override
;
744 void jobError(KIO::Job
*job
) override
;
747 KNewFileMenu
*m_newFileMenu
;
748 DolphinTabWidget
*m_tabWidget
;
749 DolphinViewContainer
*m_activeViewContainer
;
751 DolphinViewActionHandler
*m_actionHandler
;
752 DolphinRemoteEncoding
*m_remoteEncoding
;
753 QPointer
<DolphinSettingsDialog
> m_settingsDialog
;
754 DolphinBookmarkHandler
*m_bookmarkHandler
;
755 SelectionMode::ActionTextHelper
*m_actionTextHelper
;
756 DisabledActionNotifier
*m_disabledActionNotifier
;
758 KIO::OpenUrlJob
*m_lastHandleUrlOpenJob
;
760 TerminalPanel
*m_terminalPanel
;
761 PlacesPanel
*m_placesPanel
;
762 bool m_tearDownFromPlacesRequested
;
764 KToolBarPopupAction
*m_backAction
;
765 KToolBarPopupAction
*m_forwardAction
;
766 KActionMenu
*m_splitViewAction
;
767 QAction
*m_splitViewMenuAction
;
770 KFileItemActions m_fileItemActions
;
772 QTimer
*m_sessionSaveTimer
;
773 QFutureWatcher
<void> *m_sessionSaveWatcher
;
774 bool m_sessionSaveScheduled
;
776 KIO::CommandLauncherJob
*m_job
;
778 KRecentFilesAction
*m_recentFiles
= nullptr;
780 friend class DolphinMainWindowTest
;
783 inline DolphinViewContainer
*DolphinMainWindow::activeViewContainer() const
785 return m_activeViewContainer
;
788 inline KNewFileMenu
*DolphinMainWindow::newFileMenu() const
790 return m_newFileMenu
;
793 #endif // DOLPHIN_MAINWINDOW_H