X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/a567da792ac6a337e9ffeb9468215ef4f2c326ce..5360bc3ab328c8b1161b0c5df9c5785829a3e880:/src/dolphinmainwindow.h diff --git a/src/dolphinmainwindow.h b/src/dolphinmainwindow.h index c1411319a..79084ae7d 100644 --- a/src/dolphinmainwindow.h +++ b/src/dolphinmainwindow.h @@ -1,55 +1,49 @@ -/*************************************************************************** - * 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 "panels/panel.h" - -#include - -#include +#include "dolphintabwidget.h" +#include #include -#include +#include #include -#include -#include +#include +#include +#include +#include +#include +#include typedef KIO::FileUndoManager::CommandType CommandType; -class KAction; +class DolphinBookmarkHandler; class DolphinViewActionHandler; -class DolphinApplication; -class DolphinSearchBox; -class DolphinSearchOptionsConfigurator; class DolphinSettingsDialog; class DolphinViewContainer; class DolphinRemoteEncoding; -class KNewMenu; -class KTabBar; -class KUrl; -class QSplitter; +class DolphinTabWidget; +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. @@ -60,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) - friend class DolphinApplication; public: - virtual ~DolphinMainWindow(); + DolphinMainWindow(); + ~DolphinMainWindow() override; /** * Returns the currently active view. @@ -75,55 +68,66 @@ public: DolphinViewContainer* activeViewContainer() const; /** - * Opens each directory \p 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); /** - * 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). + * Returns the 'Create New...' sub menu which also can be shared + * with other menus (e. g. a context menu). */ - void toggleViews(); + KNewFileMenu* newFileMenu() const; - /** Renames the item represented by \a oldUrl to \a newUrl. */ - void rename(const KUrl& oldUrl, const KUrl& newUrl); + void setTabsToHomeIfMountPathOpen(const QString& mountPath); +public slots: /** - * Refreshes the views of the main window by recreating them dependent from - * the given Dolphin settings. + * 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 refreshViews(); + void openDirectories(const QStringList &dirs, bool splitView); /** - * Returns the 'Create New...' sub menu which also can be shared - * with other menus (e. g. a context menu). + * 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. */ - KNewMenu* newMenu() const; + void openFiles(const QStringList &files, bool splitView); /** - * Returns the 'Show Menubar' action which can be shared with - * other menus (e. g. a context menu). + * Tries to raise/activate the Dolphin window. */ - KAction* showMenuBarAction() const; + 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); + -public slots: /** * Pastes the clipboard data into the currently selected folder * of the active view. If not exactly one folder is selected, @@ -131,21 +135,33 @@ 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 QUrl& url); /** Stores all settings and quits Dolphin. */ void quit(); + /** + * Opens a new tab and places it after the current tab + */ + void openNewTabAfterCurrentTab(const QUrl& url); + + /** + * Opens a new tab and places it as the last tab + */ + void openNewTabAfterLastTab(const QUrl& url); + signals: /** * Is sent if the selection of the currently active view has @@ -157,7 +173,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. @@ -165,20 +181,36 @@ signals: */ void requestItemInfo(const KFileItem& item); + /** + * Is emitted if the settings have been changed. + */ + void settingsChanged(); + 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; private slots: + /** + * Refreshes the views of the main window by recreating them according to + * the given Dolphin settings. + */ + void refreshViews(); + void clearStatusBar(); /** Updates the 'Create New...' sub menu. */ @@ -191,13 +223,10 @@ private slots: /** * Updates the state of the 'Undo' menu action dependent - * from the parameter \a available. + * on the parameter \a available. */ 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,8 +245,14 @@ 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(); @@ -235,20 +270,23 @@ private slots: /** * 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. */ + /** Dedicated action to open the stash:/ ioslave in split view. */ + void toggleSplitStash(); + + /** 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(); - /** - * Toggles between showing and hiding of the filter bar - */ - void toggleFilterBarVisibility(bool show); + void enableStopAction(); + void disableStopAction(); + + void showFilterBar(); /** * Toggles between edit and browse mode of the navigation bar. @@ -262,7 +300,18 @@ private slots: */ void replaceLocation(); - /** Goes back on step of the URL history. */ + /** + * Toggles the state of the panels between a locked and unlocked layout. + */ + 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(); /** Goes forward one step of the URL history. */ @@ -271,26 +320,20 @@ private slots: /** Goes up one hierarchy of the current URL. */ void goUp(); - /** - * Open the previous URL in the URL history in a new tab - * if the middle mouse button is clicked. - */ - void goBack(Qt::MouseButtons buttons); + /** Changes the location to the home URL. */ + void goHome(); - /** - * 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 previous URL in the URL history in a new tab. */ + void goBackInNewTab(); - /** - * 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 next URL in the URL history in a new tab. */ + void goForwardInNewTab(); - /** Goes to the home URL. */ - void goHome(); + /** 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(); @@ -301,9 +344,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(); @@ -316,12 +368,6 @@ private slots: */ void slotSelectionChanged(const KFileItemList& selection); - /** Enables changing of tabs via mouse wheel. */ - void slotWheelMoved(int wheelDelta); - - /** Emits the signal requestItemInfo(). */ - void slotRequestItemInfo(const KFileItem&); - /** * Updates the state of the 'Back' and 'Forward' menu * actions corresponding to the current history. @@ -334,17 +380,21 @@ 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 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(); - void activateNextTab(); + /** + * Adds the current URL as an entry to the Places panel + */ + void addToPlaces(); - void activatePrevTab(); + /** + * 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. @@ -356,8 +406,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 @@ -366,92 +418,147 @@ 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); + void handleUrl(const QUrl& url); - /** Closes the currently active tab. */ - void closeTab(); + /** + * Is invoked when the write state of a folder has been changed and + * enables/disables the "Create New..." menu entry. + */ + void slotWriteStateChanged(bool isFolderWritable); /** - * Closes the tab with the index \index and activates the tab with index - 1. + * 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 closeTab(int index); + void openContextMenu(const QPoint& pos, + const KFileItem& item, + const QUrl& url, + const QList& customActions); + void updateControlMenu(); + void updateToolBar(); + void slotControlButtonDeleted(); /** - * Opens a context menu for the tab with the index \a index - * on the position \a pos. + * 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 openTabContextMenu(int index, const QPoint& pos); + void slotPlaceActivated(const QUrl& url); /** - * Handles a click on a places item: if the middle mouse button is - * clicked, a new tab is opened for \a url, otherwise the current - * view is replaced by \a 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 handlePlacesClick(const KUrl& url, Qt::MouseButtons buttons); + void activeViewChanged(DolphinViewContainer* viewContainer); + + void closedTabsCountChanged(unsigned int count); /** - * Is connected to the KTabBar signal testCanDecode() and adjusts - * the output parameter \a accept. + * Is called if a new tab has been opened or a tab has been closed to + * enable/disable the tab actions. */ - void slotTestCanDecode(const QDragMoveEvent* event, bool& accept); + void tabCountChanged(int count); /** - * Is connected with the Dolphin search box and the search configurator - * and triggers a Nepomuk search. + * Updates the Window Title with the caption from the active view container */ - void searchItems(); + void updateWindowTitle(); /** - * 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. + * This slot is called when the user requested to unmount a removable media + * from the places menu */ - void slotTabMoved(int from, int to); + void slotStorageTearDownFromPlacesRequested(const QString& mountPath); /** - * Is connected to the searchbox signal 'requestSearchOptions' and - * takes care to show the search options. + * 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 showSearchOptions(); + void slotStorageTearDownExternallyRequested(const QString& mountPath); /** - * If the URL can be listed open it in the current view, otherwise - * run it through KRun. + * Is called when the view has finished loading the directory. */ - void handleUrl(const KUrl& url); + void slotDirectoryLoadingCompleted(); /** - * setUrlAsCaption will trigger a stat job which reports its result in - * this slot. + * 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 slotCaptionStatFinished( KJob* job ); + void slotToolBarActionMiddleClicked(QAction *action); -private: - DolphinMainWindow(int id); - void init(); + /** + * Is called before the Back popup menu is shown. This slot will populate + * the menu with history data + */ + void slotAboutToShowBackPopupMenu(); /** - * 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. + * 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); +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(); + void createControlButton(); + void deleteControlButton(); + /** - * Adds the tab[\a index] to the closed tab menu's list of actions. + * 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. */ - void rememberClosedTab(int index); + bool addActionToMenu(QAction* action, QMenu* menu); /** * Connects the signals from the created DolphinView with @@ -469,27 +576,30 @@ 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. + * 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. */ - QString tabProperty(const QString& property, int tabIndex) const; + 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(); /** - * Sets the window caption to url.fileName() if this is non-empty, - * "/" if the URL is "file:///", and url.protocol() otherwise. + * Returns the KIO::StatJob::mostLocalUrl() for the active container URL + * if it's a local file. Otherwise returns the user's home path. */ - void setUrlAsCaption(const KUrl& url); + QString activeContainerLocalPath(); - QString squeezedText(const QString& text) const; + /** Returns preferred search tool as configured in "More Search Tools" menu. */ + QPointer preferredSearchTool(); private: /** @@ -501,62 +611,45 @@ private: { public: UndoUiInterface(); - virtual ~UndoUiInterface(); - virtual void jobError(KIO::Job* job); + ~UndoUiInterface() override; + void jobError(KIO::Job* job) override; }; - KNewMenu* m_newMenu; - KActionMenu* m_recentTabsMenu; - KAction* m_showMenuBar; - KTabBar* m_tabBar; + KNewFileMenu* m_newFileMenu; + KHelpMenu* m_helpMenu; + DolphinTabWidget* m_tabWidget; DolphinViewContainer* m_activeViewContainer; - QVBoxLayout* m_centralWidgetLayout; - DolphinSearchBox* m_searchBox; - DolphinSearchOptionsConfigurator* m_searchOptionsConfigurator; - int m_id; - - struct ViewTab - { - ViewTab() : isPrimaryViewActive(true), primaryView(0), secondaryView(0), splitter(0) {} - bool isPrimaryViewActive; - DolphinViewContainer* primaryView; - DolphinViewContainer* secondaryView; - QSplitter* splitter; - }; - - int m_tabIndex; - QList m_viewTab; DolphinViewActionHandler* m_actionHandler; DolphinRemoteEncoding* m_remoteEncoding; QPointer m_settingsDialog; + DolphinBookmarkHandler* m_bookmarkHandler; - KJob* m_captionStatJob; -}; + // Members for the toolbar menu that is shown when the menubar is hidden: + QToolButton* m_controlButton; + QTimer* m_updateToolBarTimer; -inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const -{ - return m_activeViewContainer; -} + KIO::OpenUrlJob *m_lastHandleUrlOpenJob; -inline bool DolphinMainWindow::isSplit() const -{ - return m_viewTab[m_tabIndex].secondaryView != 0; -} + TerminalPanel* m_terminalPanel; + PlacesPanel* m_placesPanel; + bool m_tearDownFromPlacesRequested; -inline KNewMenu* DolphinMainWindow::newMenu() const -{ - return m_newMenu; -} + KToolBarPopupAction* m_backAction; + KToolBarPopupAction* m_forwardAction; -inline KAction* DolphinMainWindow::showMenuBarAction() const + QMenu m_searchTools; + +}; + +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