]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphinmainwindow.h
Build with QT_NO_KEYWORDS
[dolphin.git] / src / dolphinmainwindow.h
index 1e2460768bdfb7488c6a8c8cb501020ecbd47b50..921f5a4c94e1444cf332252c08fb2f5c4f4bf379 100644 (file)
@@ -1,23 +1,10 @@
-/***************************************************************************
- *   Copyright (C) 2006 by Peter Penz <peter.penz19@gmail.com>             *
- *   Copyright (C) 2006 by Stefan Monov <logixoul@gmail.com>               *
- *   Copyright (C) 2006 by Cvetoslav Ludmiloff <ludmiloff@gmail.com>       *
- *                                                                         *
- *   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 <peter.penz19@gmail.com>
+ * SPDX-FileCopyrightText: 2006 Stefan Monov <logixoul@gmail.com>
+ * SPDX-FileCopyrightText: 2006 Cvetoslav Ludmiloff <ludmiloff@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #ifndef DOLPHIN_MAINWINDOW_H
 #define DOLPHIN_MAINWINDOW_H
 #include "dolphintabwidget.h"
 #include <config-baloo.h>
 #include <kio/fileundomanager.h>
-#include <ksortablelist.h>
+#include <KSortableList>
 #include <kxmlguiwindow.h>
 
 #include <QIcon>
 #include <QList>
+#include <QMenu>
 #include <QPointer>
 #include <QUrl>
 #include <QVector>
@@ -46,11 +34,17 @@ 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.
  *
@@ -98,9 +92,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,
@@ -126,16 +170,11 @@ public slots:
     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
+     * Opens a new tab in the background showing the URL \a url.
      */
-    void openNewTabAfterLastTab(const QUrl& url);
+    void openNewTab(const QUrl& url);
 
-signals:
+Q_SIGNALS:
     /**
      * Is sent if the selection of the currently active view has
      * been changed.
@@ -172,7 +211,20 @@ 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;
+
+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.
@@ -216,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.
@@ -252,6 +307,7 @@ private slots:
     void disableStopAction();
 
     void showFilterBar();
+    void toggleFilterBar();
 
     /**
      * Toggles between edit and browse mode of the navigation bar.
@@ -309,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();
 
@@ -343,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, DolphinTabWidget::TabPlacement tabPlacement);
+    void addToPlaces();
 
     /**
      * Opens the selected folder in a new tab.
@@ -374,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.
@@ -462,10 +521,48 @@ 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();
+
+    /**
+     * Sets up the dock widgets and their panels.
+     */
     void setupDockWidgets();
-    void updateEditActions();
+
+    void updateFileAndEditActions();
     void updateViewActions();
     void updateGoActions();
 
@@ -495,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;
 
     /**
@@ -508,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<QAction> preferredSearchTool();
+
 private:
     /**
      * Implements a custom error handling for the undo manager. This
@@ -523,6 +631,7 @@ private:
     };
 
     KNewFileMenu* m_newFileMenu;
+    KHelpMenu* m_helpMenu;
     DolphinTabWidget* m_tabWidget;
     DolphinViewContainer* m_activeViewContainer;
 
@@ -535,11 +644,20 @@ private:
     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