#ifndef DOLPHIN_MAINWINDOW_H
#define DOLPHIN_MAINWINDOW_H
+#include "config-dolphin.h"
+#include "disabledactionnotifier.h"
#include "dolphintabwidget.h"
-#include <config-baloo.h>
+#include "selectionmode/bottombar.h"
+#include <KActionMenu>
+#include <KFileItemActions>
#include <kio/fileundomanager.h>
-#include <KSortableList>
#include <kxmlguiwindow.h>
+#if HAVE_BALOO
+#include "panels/information/informationpanel.h"
+#endif
+
+#include <QFutureWatcher>
#include <QIcon>
#include <QList>
#include <QMenu>
typedef KIO::FileUndoManager::CommandType CommandType;
+class DiskSpaceUsageMenu;
class DolphinBookmarkHandler;
class DolphinViewActionHandler;
class DolphinSettingsDialog;
class KFileItemList;
class KJob;
class KNewFileMenu;
-class KHelpMenu;
+class KRecentFilesAction;
class KToolBarPopupAction;
class QToolButton;
-class QIcon;
class PlacesPanel;
class TerminalPanel;
-namespace KIO {
- class OpenUrlJob;
+/** 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;
}
/**
*
* 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")
* 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<DolphinViewContainer*> viewContainers() const;
+ QVector<DolphinViewContainer *> viewContainers() const;
/**
* Opens each directory in \p dirs in a separate tab. If \a splitView is set,
* 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<QUrl>& files, bool splitView);
+ void openFiles(const QList<QUrl> &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
* 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);
+ void setViewsToHomeIfMountPathOpen(const QString &mountPath);
/**
- * Sets any of the window's view containers which are currently displaying
- * invalid locations to the home path
+ * 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 setViewsWithInvalidPathsToHome();
+ void setSessionAutoSaveEnabled(bool enable);
bool isFoldersPanelEnabled() const;
bool isInformationPanelEnabled() const;
+ bool isSplitViewEnabledInCurrentTab() const;
-public slots:
+ /**
+ * 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.
/**
* 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.
*/
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
* 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.
+ * @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 openNewTabAfterCurrentTab(const QUrl& url);
+ void openNewTabAndActivate(const QUrl &url);
/**
- * Opens a new tab and places it as the last tab
+ * Opens a new window showing the URL \a url.
*/
- void openNewTabAfterLastTab(const QUrl& url);
+ void openNewWindow(const QUrl &url);
+
+ /** @see GeneralSettings::splitViewChanged() */
+ void slotSplitViewChanged();
-signals:
+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.
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
*/
void saveNewToolbarConfig() override;
-private slots:
+private Q_SLOTS:
/**
* Refreshes the views of the main window by recreating them according to
* the given Dolphin settings.
void updateNewMenu();
void createDirectory();
+ void createFile();
/** 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
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();
*/
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();
*/
void toggleSplitView();
+ /**
+ * 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();
void enableStopAction();
void disableStopAction();
+ void toggleSelectionMode();
+
void showFilterBar();
+ void toggleFilterBar();
/**
* Toggles between edit and browse mode of the navigation bar.
void togglePanelLockState();
/**
- * Is invoked if the Terminal panel got visible/invisible and takes care
- * that the active view has the focus if the Terminal panel is invisible.
+ * 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 slotTerminalPanelVisibilityChanged();
+ void slotTerminalPanelVisibilityChanged(bool visible);
+
+ /**
+ * 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 slotPlacesPanelVisibilityChanged(bool visible);
/** Goes back one step of the URL history. */
void goBack();
/** Opens a terminal window for the current location. */
void openTerminal();
- /** Focus a Terminal Panel. */
- void focusTerminalPanel();
+ /** Opens terminal windows for the selected items' locations. */
+ void openTerminalHere();
+
+ /** Opens a terminal window for the URL. */
+ void openTerminalJob(const QUrl &url);
+
+ /** Toggles focus to/from a Terminal Panel. */
+ void toggleTerminalPanelFocus();
+
+ /** Toggles focus to/from the Places Panel. */
+ void togglePlacesPanelFocus();
/** Opens the settings dialog for Dolphin. */
void editSettings();
* 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
*/
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.
*/
*/
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
*/
* 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
* @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<QAction*>& 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
* 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);
* 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
* 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.
* 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.
* 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();
+
+ /**
+ * Saves the session.
+ */
+ void slotSaveSession();
+
private:
/**
* Sets up the various menus and actions and connects them.
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:
* 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();
/**
* Sets the window sides the toolbar may be moved to based on toolbar contents.
*/
void updateAllowedToolbarAreas();
+ /**
+ * Sets the background of the location bar(s) on if they are inside the toolbar,
+ * or off if they are outside the toolbar.
+ */
+ void updateNavigatorsBackground();
+
bool isKompareInstalled() const;
/**
* Creates an action for showing/hiding a panel, that is accessible
- * in "Configure toolbars..." and "Configure shortcuts...". This is necessary
- * as the action for toggling the dock visibility is done by Qt which
- * is no KAction instance.
+ * in "Configure toolbars..." and "Configure shortcuts...".
*/
- void createPanelAction(const QIcon &icon,
- const QKeySequence& shortcut,
- QAction* dockAction,
- const QString& actionName);
+ 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<QAction> 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
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<DolphinSettingsDialog> 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;
+ DisabledActionNotifier *m_disabledActionNotifier;
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;
+ KActionMenu *m_splitViewAction;
+ QAction *m_splitViewMenuAction;
+ DiskSpaceUsageMenu *m_diskSpaceUsageMenu;
QMenu m_searchTools;
+ KFileItemActions m_fileItemActions;
+ QTimer *m_sessionSaveTimer;
+ QFutureWatcher<void> *m_sessionSaveWatcher;
+ bool m_sessionSaveScheduled;
+
+ KIO::CommandLauncherJob *m_job;
+
+ KRecentFilesAction *m_recentFiles = nullptr;
+
+ 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
-
projects / dolphin.git / blobdiff