]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphinmainwindow.h
Refactor DolphinContextMenu so its actions are retrievable
[dolphin.git] / src / dolphinmainwindow.h
index 0520e1091ebe0b0a7d2ad06d94cf3e11f7f4f75c..17327f2de9f3bbafd6027b9b89b99f34eef19e24 100644 (file)
@@ -1,33 +1,24 @@
-/***************************************************************************
- *   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 <KFileItemActions>
 #include <kio/fileundomanager.h>
-#include <ksortablelist.h>
 #include <kxmlguiwindow.h>
 
+#ifdef HAVE_BALOO
+    #include "panels/information/informationpanel.h"
+#endif
+
 #include <QIcon>
 #include <QList>
 #include <QMenu>
@@ -50,10 +41,13 @@ class KNewFileMenu;
 class KHelpMenu;
 class KToolBarPopupAction;
 class QToolButton;
-class QIcon;
 class PlacesPanel;
 class TerminalPanel;
 
+namespace KIO {
+    class OpenUrlJob;
+}
+
 /**
  * @short Main window for Dolphin.
  *
@@ -101,9 +95,26 @@ public:
      */
     KNewFileMenu* newFileMenu() const;
 
-    void setTabsToHomeIfMountPathOpen(const QString& mountPath);
+    /**
+     * Augments Qt's build-in QMainWindow context menu to add
+     * Dolphin-specific actions, such as "unlock panels".
+     */
+    QMenu *createPopupMenu() override;
 
-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.
@@ -162,16 +173,24 @@ public slots:
     void quit();
 
     /**
-     * Opens a new tab and places it after the current tab
+     * 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 openNewTabAfterCurrentTab(const QUrl& url);
+    void openNewTabAndActivate(const QUrl &url);
 
     /**
-     * Opens a new tab and places it as the last tab
+     * Opens a new window showing the URL \a url.
      */
-    void openNewTabAfterLastTab(const QUrl& url);
+    void openNewWindow(const QUrl &url);
+
+    /** @see GeneralSettings::splitViewChanged() */
+    void slotSplitViewChanged();
 
-signals:
+Q_SIGNALS:
     /**
      * Is sent if the selection of the currently active view has
      * been changed.
@@ -190,6 +209,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.
      */
@@ -213,7 +238,18 @@ protected:
     /** Handles QWhatsThisClickedEvent and passes all others on. */
     bool eventFilter(QObject*, QEvent*) override;
 
-private slots:
+    /** 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.
@@ -296,6 +332,7 @@ private slots:
     void disableStopAction();
 
     void showFilterBar();
+    void toggleFilterBar();
 
     /**
      * Toggles between edit and browse mode of the navigation bar.
@@ -353,9 +390,6 @@ private slots:
      */
     void toggleShowMenuBar();
 
-    /** Sets up updates for "Open Preferred Search Tool" action. */
-    void setupUpdateOpenPreferredSearchToolAction();
-
     /** Updates "Open Preferred Search Tool" action. */
     void updateOpenPreferredSearchToolAction();
 
@@ -365,6 +399,9 @@ private slots:
     /** Opens a terminal window for the current location. */
     void openTerminal();
 
+    /** Focus a Terminal Panel. */
+    void focusTerminalPanel();
+
     /** Opens the settings dialog for Dolphin. */
     void editSettings();
 
@@ -400,11 +437,6 @@ private slots:
      */
     void addToPlaces();
 
-    /**
-     * 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.
      */
@@ -432,12 +464,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.
@@ -449,18 +475,21 @@ private slots:
      * @pos           Position in screen coordinates.
      * @item          File item context. If item is null, the context menu
      *                should be applied to \a url.
+     * @selectedItems The selected items for which the context menu
+     *                is opened. This list generally includes \a item.
      * @url           URL which contains \a item.
-     * @customActions Actions that should be added to the context menu,
-     *                if the file item is null.
      */
-    void openContextMenu(const QPoint& pos,
-                         const KFileItem& item,
-                         const QUrl& url,
-                         const QList<QAction*>& customActions);
+    void openContextMenu(const QPoint& pos, const KFileItem& item, const KFileItemList &selectedItems, const QUrl& url);
 
-    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.
@@ -550,6 +579,12 @@ private slots:
       * to go to.
       */
     void slotGoForward(QAction* action);
+
+    /**
+     * Is called when configuring the keyboard shortcuts
+     */
+    void slotKeyBindings();
+
 private:
     /**
      * Sets up the various menus and actions and connects them.
@@ -565,16 +600,6 @@ private:
     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.
-     */
-    bool addActionToMenu(QAction* action, QMenu* menu);
-
     /**
      * Connects the signals from the created DolphinView with
      * the DolphinViewContainer \a container with the corresponding slots of
@@ -591,6 +616,11 @@ private:
      */
     void updateSplitAction();
 
+    /**
+     * Sets the window sides the toolbar may be moved to based on toolbar contents.
+     */
+    void updateAllowedToolbarAreas();
+
     bool isKompareInstalled() const;
 
     /**
@@ -607,14 +637,21 @@ private:
     /** 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();
+
     /**
-     * Returns the KIO::StatJob::mostLocalUrl() for the active container URL
-     * if it's a local file. Otherwise returns the user's home path.
+     * 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.
      */
-    QString activeContainerLocalPath();
+    bool addHamburgerMenuToToolbar();
 
-    /** Returns preferred search tool as configured in "More Search Tools" menu. */
-    QPointer<QAction> preferredSearchTool();
+    /** Creates an action representing an item in the URL navigator history */
+    static QAction *urlNavigatorHistoryAction(const KUrlNavigator *urlNavigator, int historyIndex, QObject *parent = nullptr);
 
 private:
     /**
@@ -644,7 +681,7 @@ private:
     QToolButton* m_controlButton;
     QTimer* m_updateToolBarTimer;
 
-    KIO::Job* m_lastHandleUrlStatJob;
+    KIO::OpenUrlJob *m_lastHandleUrlOpenJob;
 
     TerminalPanel* m_terminalPanel;
     PlacesPanel* m_placesPanel;
@@ -654,6 +691,7 @@ private:
     KToolBarPopupAction* m_forwardAction;
 
     QMenu m_searchTools;
+    KFileItemActions m_fileItemActions;
 
 };