X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/0d4924d8bbab256b13ae13040201bea7ea04ab2f..f65b0899c3666561cafac14f67ab0bb8a5bfa00a:/src/dolphinmainwindow.h diff --git a/src/dolphinmainwindow.h b/src/dolphinmainwindow.h index d741eb21e..921f5a4c9 100644 --- a/src/dolphinmainwindow.h +++ b/src/dolphinmainwindow.h @@ -1,40 +1,30 @@ -/*************************************************************************** - * 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 "dolphintabwidget.h" #include - #include -#include +#include #include -#include -#include +#include #include +#include #include +#include +#include typedef KIO::FileUndoManager::CommandType CommandType; +class DolphinBookmarkHandler; class DolphinViewActionHandler; class DolphinSettingsDialog; class DolphinViewContainer; @@ -44,8 +34,16 @@ class KFileItem; class KFileItemList; class KJob; class KNewFileMenu; +class KHelpMenu; +class KToolBarPopupAction; class QToolButton; class QIcon; +class PlacesPanel; +class TerminalPanel; + +namespace KIO { + class OpenUrlJob; +} /** * @short Main window for Dolphin. @@ -56,11 +54,10 @@ class DolphinMainWindow: public KXmlGuiWindow { Q_OBJECT Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow") - Q_PROPERTY(int id READ getId SCRIPTABLE true) public: DolphinMainWindow(); - virtual ~DolphinMainWindow(); + ~DolphinMainWindow() override; /** * Returns the currently active view. @@ -70,6 +67,11 @@ public: */ DolphinViewContainer* activeViewContainer() const; + /** + * Returns view container for all tabs + */ + QVector viewContainers() const; + /** * Opens each directory in \p dirs in a separate tab. If \a splitView is set, * 2 directories are collected within one tab. @@ -90,7 +92,59 @@ 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); + + /** + * Sets any of the window's view containers which are currently displaying + * invalid locations to the home path + */ + void setViewsWithInvalidPathsToHome(); + + 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, @@ -98,11 +152,6 @@ 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 @@ -120,7 +169,12 @@ public slots: /** 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); + +Q_SIGNALS: /** * Is sent if the selection of the currently active view has * been changed. @@ -146,18 +200,31 @@ signals: protected: /** @see QWidget::showEvent() */ - virtual void showEvent(QShowEvent* event) Q_DECL_OVERRIDE; + void showEvent(QShowEvent* event) override; /** @see QMainWindow::closeEvent() */ - virtual void closeEvent(QCloseEvent* event) Q_DECL_OVERRIDE; + void closeEvent(QCloseEvent* event) override; /** @see KMainWindow::saveProperties() */ - virtual void saveProperties(KConfigGroup& group) Q_DECL_OVERRIDE; + void saveProperties(KConfigGroup& group) override; /** @see KMainWindow::readProperties() */ - virtual void readProperties(const KConfigGroup& group) Q_DECL_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; + +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. @@ -201,6 +268,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. @@ -237,6 +307,7 @@ private slots: void disableStopAction(); void showFilterBar(); + void toggleFilterBar(); /** * Toggles between edit and browse mode of the navigation bar. @@ -255,6 +326,12 @@ private slots: */ 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. + */ + void slotTerminalPanelVisibilityChanged(); + /** Goes back one step of the URL history. */ void goBack(); @@ -267,28 +344,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(); @@ -299,9 +365,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,9 @@ private slots: void openNewActivatedTab(); /** - * Opens a new tab in the background showing the URL \a url. + * Adds the current URL as an entry to the Places panel */ - void openNewTab(const QUrl& url); + void addToPlaces(); /** * Opens the selected folder in a new tab. @@ -347,6 +422,11 @@ private slots: */ void openInNewWindow(); + /** + * Show the target of the selected symlink + */ + void showTarget(); + /** * Indicates in the statusbar that the execution of the command \a command * has been finished. @@ -359,12 +439,6 @@ private slots: */ void handleUrl(const QUrl& url); - /** - * handleUrl() can trigger a stat job to see if the url can actually - * be listed. - */ - void slotHandleUrlStatFinished(KJob* job); - /** * Is invoked when the write state of a folder has been changed and * enables/disables the "Create New..." menu entry. @@ -415,20 +489,80 @@ private slots: void tabCountChanged(int count); /** - * Sets the window caption to url.fileName() if this is non-empty, - * "/" if the URL is "file:///", and url.protocol() otherwise. + * 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 setUrlAsCaption(const QUrl& url); + 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 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); private: + /** + * Sets up the various menus and actions and connects them. + */ void setupActions(); + + /** + * Sets up the dock widgets and their panels. + */ void setupDockWidgets(); - void updateEditActions(); + + void updateFileAndEditActions(); void updateViewActions(); void updateGoActions(); @@ -458,6 +592,11 @@ private: */ void updateSplitAction(); + /** + * Sets the window sides the toolbar may be moved to based on toolbar contents. + */ + void updateAllowedToolbarAreas(); + bool isKompareInstalled() const; /** @@ -471,6 +610,12 @@ private: 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(); + private: /** * Implements a custom error handling for the undo manager. This @@ -481,24 +626,38 @@ private: { public: UndoUiInterface(); - virtual ~UndoUiInterface(); - virtual void jobError(KIO::Job* job) Q_DECL_OVERRIDE; + ~UndoUiInterface() override; + void jobError(KIO::Job* job) override; }; KNewFileMenu* m_newFileMenu; + KHelpMenu* m_helpMenu; DolphinTabWidget* m_tabWidget; DolphinViewContainer* m_activeViewContainer; - int m_id; DolphinViewActionHandler* m_actionHandler; DolphinRemoteEncoding* m_remoteEncoding; QPointer m_settingsDialog; + DolphinBookmarkHandler* m_bookmarkHandler; // Members for the toolbar menu that is shown when the menubar is hidden: QToolButton* m_controlButton; QTimer* m_updateToolBarTimer; - KIO::Job* m_lastHandleUrlStatJob; + KIO::OpenUrlJob *m_lastHandleUrlOpenJob; + + 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; + + QMenu m_searchTools; + }; inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const @@ -511,10 +670,5 @@ inline KNewFileMenu* DolphinMainWindow::newFileMenu() const return m_newFileMenu; } -inline int DolphinMainWindow::getId() const -{ - return m_id; -} - #endif // DOLPHIN_MAINWINDOW_H