X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/70cd04df40b152fd7a448964b9f9ca4948291eb3..0446c768675f0a11f887378681eb1f01b3e2c575:/src/dolphinmainwindow.h diff --git a/src/dolphinmainwindow.h b/src/dolphinmainwindow.h index 6b046c2ea..761766df8 100644 --- a/src/dolphinmainwindow.h +++ b/src/dolphinmainwindow.h @@ -1,56 +1,52 @@ -/*************************************************************************** - * 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 - -#include +#include "dolphintabwidget.h" +#include +#include #include -#include #include -#include -#include +#ifdef HAVE_BALOO + #include "panels/information/informationpanel.h" +#endif + +#include #include -#include +#include +#include +#include +#include typedef KIO::FileUndoManager::CommandType CommandType; +class DolphinBookmarkHandler; class DolphinViewActionHandler; -class DolphinApplication; class DolphinSettingsDialog; class DolphinViewContainer; class DolphinRemoteEncoding; -class KAction; +class DolphinTabWidget; class KFileItem; class KFileItemList; class KJob; class KNewFileMenu; -class KTabBar; -class KUrl; -class QSplitter; +class KHelpMenu; +class KToolBarPopupAction; class QToolButton; -class QVBoxLayout; +class PlacesPanel; +class TerminalPanel; + +namespace KIO { + class OpenUrlJob; +} /** * @short Main window for Dolphin. @@ -61,12 +57,10 @@ 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: DolphinMainWindow(); - virtual ~DolphinMainWindow(); + ~DolphinMainWindow() override; /** * Returns the currently active view. @@ -77,24 +71,23 @@ public: DolphinViewContainer* activeViewContainer() const; /** - * Opens each directory in \p dirs in a separate tab. If the "split view" - * option is enabled, 2 directories are collected within one tab. + * Returns view container for all tabs */ - void openDirectories(const QList& dirs); + QVector viewContainers() const; /** - * Opens the directory which contains the files \p files - * and selects all files (implements the --select option - * of Dolphin). + * 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 openFiles(const QList& files); + void openDirectories(const QList &dirs, bool splitView); /** - * Returns true, if the main window contains two instances - * of a view container. The active view constainer can be - * accessed by DolphinMainWindow::activeViewContainer(). + * 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. */ - bool isSplit() const; + void openFiles(const QList& files, bool splitView); /** * Returns the 'Create New...' sub menu which also can be shared @@ -102,7 +95,53 @@ public: */ KNewFileMenu* newFileMenu() const; -public slots: + /** + * 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. + */ + void setViewsToHomeIfMountPathOpen(const QString& mountPath); + + bool isFoldersPanelEnabled() const; + bool isInformationPanelEnabled() const; + +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(); + + /** + * 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. + */ + bool isUrlOpen(const QString &url); + + /** * Pastes the clipboard data into the currently selected folder * of the active view. If not exactly one folder is selected, @@ -110,29 +149,42 @@ public slots: */ void pasteIntoFolder(); - /** - * Returns the main window ID used through DBus. - */ - int getId() const; - /** * 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); /** * 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 KUrl& url); + void slotTerminalDirectoryChanged(const QUrl& url); /** Stores all settings and quits Dolphin. */ void quit(); -signals: + /** + * Opens a new tab in the background showing the URL \a url. + */ + void openNewTab(const QUrl& url); + + /** + * Opens a new tab showing the URL \a url and activate it. + */ + 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. @@ -143,7 +195,7 @@ signals: * 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 panel. @@ -151,6 +203,12 @@ signals: */ 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. */ @@ -158,18 +216,34 @@ signals: protected: /** @see QWidget::showEvent() */ - virtual void showEvent(QShowEvent* event); + 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; + + /** 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 Q_SLOTS: + /** + * Calls the base method KXmlGuiWindow::saveNewToolbarConfig(). + * Is also used to set toolbar constraints and UrlNavigator position + * based on the newly changed toolbar configuration. + */ + void saveNewToolbarConfig() override; -private slots: +private Q_SLOTS: /** * Refreshes the views of the main window by recreating them according to * the given Dolphin settings. @@ -192,9 +266,6 @@ private slots: */ void slotUndoAvailable(bool available); - /** Invoked when an action in the recent tabs menu is clicked. */ - void restoreClosedTab(QAction* action); - /** Sets the text of the 'Undo' menu action to \a text. */ void slotUndoTextChanged(const QString& text); @@ -216,6 +287,9 @@ private slots: /** 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 on * the number of items which are in the clipboard. @@ -239,6 +313,9 @@ private slots: */ void toggleSplitView(); + /** Dedicated action to open the stash:/ ioslave in split view. */ + void toggleSplitStash(); + /** Reloads the currently active view. */ void reloadView(); @@ -249,6 +326,7 @@ private slots: void disableStopAction(); void showFilterBar(); + void toggleFilterBar(); /** * Toggles between edit and browse mode of the navigation bar. @@ -268,11 +346,10 @@ private slots: void togglePanelLockState(); /** - * Is invoked if the Places panel got visible/invisible and takes care - * that the places-selector of all views is only shown if the Places panel - * is invisible. + * 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. */ - void slotPlacesPanelVisibilityChanged(bool visible); + void slotTerminalPanelVisibilityChanged(); /** Goes back one step of the URL history. */ void goBack(); @@ -286,28 +363,17 @@ private slots: /** Changes the location to the home URL. */ void goHome(); - /** - * Open the previous URL in the URL history in a new tab - * if the middle mouse button is clicked. - */ - void goBack(Qt::MouseButtons buttons); + /** 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 - * if the middle mouse button is clicked. - */ - void goForward(Qt::MouseButtons buttons); + /** 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 - * if the middle mouse button is clicked. - */ - void goUp(Qt::MouseButtons buttons); + /** Open the URL one hierarchy above the current URL in a new tab. */ + void goUpInNewTab(); - /** - * Open the home URL in a new tab - */ - void goHome(Qt::MouseButtons buttons); + /** * Open the home URL in a new tab. */ + void goHomeInNewTab(); /** Opens Kompare for 2 selected files. */ void compareFiles(); @@ -318,9 +384,18 @@ private slots: */ void toggleShowMenuBar(); + /** Updates "Open Preferred Search Tool" action. */ + void updateOpenPreferredSearchToolAction(); + + /** Opens preferred search tool for the current location. */ + void openPreferredSearchTool(); + /** Opens a terminal window for the current location. */ void openTerminal(); + /** Focus a Terminal Panel. */ + void focusTerminalPanel(); + /** Opens the settings dialog for Dolphin. */ void editSettings(); @@ -333,9 +408,6 @@ private slots: */ void slotSelectionChanged(const KFileItemList& selection); - /** Emits the signal requestItemInfo(). */ - void slotRequestItemInfo(const KFileItem&); - /** * Updates the state of the 'Back' and 'Forward' menu * actions corresponding to the current history. @@ -348,23 +420,16 @@ private slots: /** Open a new main window. */ void openNewMainWindow(); - /** Opens a new view with the current URL that is part of a tab. */ - void openNewTab(); - /** - * Opens a new tab in the background showing the URL \a url. + * Opens a new view with the current URL that is part of a tab and + * activates it. */ - void openNewTab(const KUrl& url); + void openNewActivatedTab(); /** - * Opens a new tab showing the URL \a url and activates - * the tab. + * Adds the current URL as an entry to the Places panel */ - void openNewActivatedTab(const KUrl& url); - - void activateNextTab(); - - void activatePrevTab(); + void addToPlaces(); /** * Opens the selected folder in a new tab. @@ -376,8 +441,10 @@ private slots: */ void openInNewWindow(); - /** Toggles the active view if two views are shown within the main window. */ - void toggleActiveView(); + /** + * Show the target of the selected symlink + */ + void showTarget(); /** * Indicates in the statusbar that the execution of the command \a command @@ -386,127 +453,143 @@ private slots: void showCommand(CommandType command); /** - * Activates the tab with the index \a index, which means that the current view - * is replaced by the view of the given tab. + * If the URL can be listed, open it in the current view, otherwise + * run it through KRun. */ - void setActiveTab(int index); - - /** Closes the currently active tab. */ - void closeTab(); + void handleUrl(const QUrl& url); /** - * Closes the tab with the index \a index and activates the tab with index - 1. + * Is invoked when the write state of a folder has been changed and + * enables/disables the "Create New..." menu entry. */ - void closeTab(int index); + void slotWriteStateChanged(bool isFolderWritable); /** - * Opens a context menu for the tab with the index \a index - * on the position \a pos. + * 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. + * @url URL which contains \a item. + * @customActions Actions that should be added to the context menu, + * if the file item is null. */ - void openTabContextMenu(int index, const QPoint& pos); + void openContextMenu(const QPoint& pos, + const KFileItem& item, + const QUrl& url, + const QList& customActions); /** - * Is connected to the QTabBar signal tabMoved(int from, int to). - * Reorders the list of tabs after a tab was moved in the tab bar - * and sets m_tabIndex to the new index of the current tab. + * 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 slotTabMoved(int from, int to); + void updateHamburgerMenu(); /** - * Is connected to the KTabBar signal testCanDecode() and adjusts - * the output parameter \a accept. + * 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 slotTestCanDecode(const QDragMoveEvent* event, bool& accept); + void slotPlaceActivated(const QUrl& url); /** - * If the URL can be listed, open it in the current view, otherwise - * run it through KRun. + * 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 handleUrl(const KUrl& url); + void activeViewChanged(DolphinViewContainer* viewContainer); + + void closedTabsCountChanged(unsigned int count); /** - * handleUrl() can trigger a stat job to see if the url can actually - * be listed. + * Is called if a new tab has been opened or a tab has been closed to + * enable/disable the tab actions. */ - void slotHandleUrlStatFinished(KJob* job); + void tabCountChanged(int count); /** - * Is connected to the KTabBar signal receivedDropEvent. - * Allows dragging and dropping files onto tabs. + * Updates the Window Title with the caption from the active view container */ - void tabDropEvent(int tab, QDropEvent* event); + void updateWindowTitle(); /** - * Is invoked when the write state of a folder has been changed and - * enables/disables the "Create New..." menu entry. + * This slot is called when the user requested to unmount a removable media + * from the places menu */ - void slotWriteStateChanged(bool isFolderWritable); + void slotStorageTearDownFromPlacesRequested(const QString& mountPath); /** - * 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. - * @url URL which contains \a item. - * @customActions Actions that should be added to the context menu, - * if the file item is null. + * 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 openContextMenu(const QPoint& pos, - const KFileItem& item, - const KUrl& url, - const QList& customActions); - - void updateControlMenu(); - void updateToolBar(); - void slotControlButtonDeleted(); + void slotStorageTearDownExternallyRequested(const QString& mountPath); /** - * Is called if a panel emits an error-message and shows - * the error-message in the active view-container. + * Is called when the view has finished loading the directory. */ - void slotPanelErrorMessage(const QString& error); + void slotDirectoryLoadingCompleted(); /** - * 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. + * 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 slotPlaceActivated(const KUrl& url); + void slotToolBarActionMiddleClicked(QAction *action); -private: /** - * 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. + * Is called before the Back popup menu is shown. This slot will populate + * the menu with history data */ - void setActiveViewContainer(DolphinViewContainer* view); + void slotAboutToShowBackPopupMenu(); /** - * Creates a view container and does a default initialization. - */ - DolphinViewContainer* createViewContainer(const KUrl& url, QWidget* parent); + * 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); - void setupActions(); - void setupDockWidgets(); - void updateEditActions(); - void updateViewActions(); - void updateGoActions(); + /** + * Middle clicking Back/Forward will open the resulting folder in a new tab. + */ + void slotBackForwardActionMiddleClicked(QAction *action); - void createControlButton(); - void deleteControlButton(); + /** + * Is called before the Forward popup menu is shown. This slot will populate + * the menu with history data + */ + void slotAboutToShowForwardPopupMenu(); /** - * 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. + * 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); +private: + /** + * Sets up the various menus and actions and connects them. */ - bool addActionToMenu(QAction* action, KMenu* menu); + void setupActions(); /** - * Adds the tab[\a index] to the closed tab menu's list of actions. + * Sets up the dock widgets and their panels. */ - void rememberClosedTab(int index); + void setupDockWidgets(); + + void updateFileAndEditActions(); + void updateViewActions(); + void updateGoActions(); /** * Connects the signals from the created DolphinView with @@ -524,27 +607,12 @@ private: */ void updateSplitAction(); - /** Returns the name of the tab for the URL \a url. */ - QString tabName(const KUrl& url) const; - - bool isKompareInstalled() const; - - void createSecondaryView(int tabIndex); - /** - * Helper method for saveProperties() and readProperties(): Returns - * the property string for a tab with the index \a tabIndex and - * the property \a property. + * Sets the window sides the toolbar may be moved to based on toolbar contents. */ - QString tabProperty(const QString& property, int tabIndex) const; + void updateAllowedToolbarAreas(); - /** - * Sets the window caption to url.fileName() if this is non-empty, - * "/" if the URL is "file:///", and url.protocol() otherwise. - */ - void setUrlAsCaption(const KUrl& url); - - QString squeezedText(const QString& text) const; + bool isKompareInstalled() const; /** * Creates an action for showing/hiding a panel, that is accessible @@ -552,11 +620,27 @@ private: * as the action for toggling the dock visibility is done by Qt which * is no KAction instance. */ - void createPanelAction(const KIcon& icon, + 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(); + + /** 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(); + private: /** * Implements a custom error handling for the undo manager. This @@ -567,39 +651,36 @@ private: { public: UndoUiInterface(); - virtual ~UndoUiInterface(); - virtual void jobError(KIO::Job* job); + ~UndoUiInterface() override; + void jobError(KIO::Job* job) override; }; KNewFileMenu* m_newFileMenu; - KActionMenu* m_recentTabsMenu; - KTabBar* m_tabBar; + KHelpMenu* m_helpMenu; + DolphinTabWidget* m_tabWidget; DolphinViewContainer* m_activeViewContainer; - QVBoxLayout* m_centralWidgetLayout; - int m_id; - - // Members for the tab-handling: - struct ViewTab - { - ViewTab() : isPrimaryViewActive(true), wasActive(false), primaryView(0), secondaryView(0), splitter(0) {} - bool isPrimaryViewActive; - bool wasActive; - DolphinViewContainer* primaryView; - DolphinViewContainer* secondaryView; - QSplitter* splitter; - }; - int m_tabIndex; - QList m_viewTab; DolphinViewActionHandler* m_actionHandler; DolphinRemoteEncoding* m_remoteEncoding; - QWeakPointer m_settingsDialog; + 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; - KIO::Job* m_lastHandleUrlStatJob; + KIO::OpenUrlJob *m_lastHandleUrlOpenJob; + + TerminalPanel* m_terminalPanel; + PlacesPanel* m_placesPanel; + bool m_tearDownFromPlacesRequested; + + KToolBarPopupAction* m_backAction; + KToolBarPopupAction* m_forwardAction; + + QMenu m_searchTools; + KFileItemActions m_fileItemActions; + }; inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const @@ -607,20 +688,10 @@ inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const return m_activeViewContainer; } -inline bool DolphinMainWindow::isSplit() const -{ - return m_viewTab[m_tabIndex].secondaryView != 0; -} - inline KNewFileMenu* DolphinMainWindow::newFileMenu() const { return m_newFileMenu; } -inline int DolphinMainWindow::getId() const -{ - return m_id; -} - #endif // DOLPHIN_MAINWINDOW_H