X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/30bf49d5d1539e9d02944230cf4489ebbccf5a45..7d6aaf4c07e45977b63cfa4ac4dd695a45756379:/src/dolphinmainwindow.h diff --git a/src/dolphinmainwindow.h b/src/dolphinmainwindow.h index f2876a877..eb7309fc6 100644 --- a/src/dolphinmainwindow.h +++ b/src/dolphinmainwindow.h @@ -1,39 +1,33 @@ -/*************************************************************************** - * 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 +#ifdef HAVE_BALOO + #include "panels/information/informationpanel.h" +#endif + #include #include +#include #include #include +#include typedef KIO::FileUndoManager::CommandType CommandType; +class DolphinBookmarkHandler; class DolphinViewActionHandler; class DolphinSettingsDialog; class DolphinViewContainer; @@ -43,11 +37,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. * @@ -70,6 +69,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,9 +94,59 @@ public: */ KNewFileMenu* newFileMenu() const; - void setTabsToHomeIfMountPathOpen(const QString& mountPath); + /** + * 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); + -public slots: /** * Pastes the clipboard data into the currently selected folder * of the active view. If not exactly one folder is selected, @@ -117,7 +171,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. @@ -136,6 +195,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. */ @@ -154,7 +219,23 @@ protected: /** @see KMainWindow::readProperties() */ void readProperties(const KConfigGroup& group) override; -private slots: + /** 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 Q_SLOTS: /** * Refreshes the views of the main window by recreating them according to * the given Dolphin settings. @@ -198,6 +279,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. @@ -234,6 +318,7 @@ private slots: void disableStopAction(); void showFilterBar(); + void toggleFilterBar(); /** * Toggles between edit and browse mode of the navigation bar. @@ -291,9 +376,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(); @@ -325,9 +419,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. @@ -356,12 +450,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. @@ -382,9 +470,15 @@ private slots: const QUrl& url, const QList& customActions); - 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. @@ -444,22 +538,50 @@ private slots: */ 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(); - void setupDockWidgets(); - void updateEditActions(); - 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. + * Sets up the dock widgets and their panels. */ - bool addActionToMenu(QAction* action, QMenu* menu); + void setupDockWidgets(); + + void updateFileAndEditActions(); + void updateViewActions(); + void updateGoActions(); /** * Connects the signals from the created DolphinView with @@ -477,6 +599,11 @@ private: */ void updateSplitAction(); + /** + * Sets the window sides the toolbar may be moved to based on toolbar contents. + */ + void updateAllowedToolbarAreas(); + bool isKompareInstalled() const; /** @@ -490,6 +617,22 @@ 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(); + + /** + * 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 @@ -505,22 +648,29 @@ private: }; KNewFileMenu* m_newFileMenu; + KHelpMenu* m_helpMenu; DolphinTabWidget* m_tabWidget; DolphinViewContainer* m_activeViewContainer; 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; + + QMenu m_searchTools; }; inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const