GIT_SILENT Upgrade release service version to 20.11.70.

[dolphin.git] / src / dolphinmainwindow.h

diff --git a/src/dolphinmainwindow.h b/src/dolphinmainwindow.h
index 7bce7f13e982c0252836eab28826d868225693b3..dcd73c6a75755a339c111e09280ee9dacec00ba9 100644 (file)
--- a/src/dolphinmainwindow.h
+++ b/src/dolphinmainwindow.h
@@ -22,32 +22,37 @@
 #ifndef DOLPHIN_MAINWINDOW_H
 #define DOLPHIN_MAINWINDOW_H
 
 #ifndef DOLPHIN_MAINWINDOW_H
 #define DOLPHIN_MAINWINDOW_H
 

+#include "dolphintabwidget.h"

 #include <config-baloo.h>
 #include <config-baloo.h>

-
-#include <KFileItemDelegate>

 #include <kio/fileundomanager.h>
 #include <ksortablelist.h>
 #include <kxmlguiwindow.h>
 #include <kio/fileundomanager.h>
 #include <ksortablelist.h>
 #include <kxmlguiwindow.h>

-#include <KIcon>

 
 

+#include <QIcon>

 #include <QList>
 #include <QList>

-#include <QWeakPointer>
+#include <QMenu>
+#include <QPointer>
+#include <QUrl>
+#include <QVector>

 
 typedef KIO::FileUndoManager::CommandType CommandType;
 
 
 typedef KIO::FileUndoManager::CommandType CommandType;
 

+class DolphinBookmarkHandler;

 class DolphinViewActionHandler;
 class DolphinViewActionHandler;

-class DolphinApplication;

 class DolphinSettingsDialog;
 class DolphinViewContainer;
 class DolphinRemoteEncoding;
 class DolphinTabWidget;
 class DolphinSettingsDialog;
 class DolphinViewContainer;
 class DolphinRemoteEncoding;
 class DolphinTabWidget;

-class KAction;

 class KFileItem;
 class KFileItemList;
 class KJob;
 class KNewFileMenu;
 class KFileItem;
 class KFileItemList;
 class KJob;
 class KNewFileMenu;

-class KUrl;
+class KHelpMenu;
+class KToolBarPopupAction;

 class QToolButton;
 class QToolButton;

+class QIcon;
+class PlacesPanel;
+class TerminalPanel;

 
 /**
  * @short Main window for Dolphin.
 
 /**
  * @short Main window for Dolphin.


@@ -58,12 +63,10 @@ class DolphinMainWindow: public KXmlGuiWindow
 {
     Q_OBJECT
     Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow")
 {
     Q_OBJECT
     Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow")

-    Q_PROPERTY(int id READ getId SCRIPTABLE true)
-    friend class DolphinApplication;

 
 public:
     DolphinMainWindow();
 
 public:
     DolphinMainWindow();

-    virtual ~DolphinMainWindow();
+    ~DolphinMainWindow() override;

 
     /**
      * Returns the currently active view.
 
     /**
      * Returns the currently active view.


@@ -74,17 +77,23 @@ public:
     DolphinViewContainer* activeViewContainer() const;
 
     /**
     DolphinViewContainer* activeViewContainer() const;
 
     /**

-     * Opens each directory in \p dirs in a separate tab. If the "split view"
-     * option is enabled, 2 directories are collected within one tab.
+     * Returns view container for all tabs
+     */
+    QVector<DolphinViewContainer*> viewContainers() const;
+
+    /**
+     * 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 openDirectories(const QList<KUrl>& dirs);
+    void openDirectories(const QList<QUrl> &dirs, bool splitView);

 
     /**
 
     /**

-     * Opens the directory which contains the files \p files
-     * and selects all files (implements the --select option
-     * of Dolphin).
+     * 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.

      */
      */

-    void openFiles(const QList<KUrl>& files);
+    void openFiles(const QList<QUrl>& files, bool splitView);

 
     /**
      * Returns the 'Create New...' sub menu which also can be shared
 
     /**
      * Returns the 'Create New...' sub menu which also can be shared


@@ -92,7 +101,42 @@ public:
      */
     KNewFileMenu* newFileMenu() const;
 
      */
     KNewFileMenu* newFileMenu() const;
 

+    void setTabsToHomeIfMountPathOpen(const QString& mountPath);
+

 public slots:
 public 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,
     /**
      * Pastes the clipboard data into the currently selected folder
      * of the active view. If not exactly one folder is selected,


@@ -100,28 +144,33 @@ public slots:
      */
     void pasteIntoFolder();
 
      */
     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.
      */
     /**
      * 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.
      */
 
     /**
      * 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 KUrl& url);
+    void slotTerminalDirectoryChanged(const QUrl& url);

 
     /** Stores all settings and quits Dolphin. */
     void quit();
 
 
     /** 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
 signals:
     /**
      * Is sent if the selection of the currently active view has


@@ -133,7 +182,7 @@ signals:
      * Is sent if the url of the currently active view has
      * been changed.
      */
      * 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.
 
     /**
      * Is emitted if information of an item is requested to be shown e. g. in the panel.


@@ -148,16 +197,21 @@ signals:
 
 protected:
     /** @see QWidget::showEvent() */
 
 protected:
     /** @see QWidget::showEvent() */

-    virtual void showEvent(QShowEvent* event);
+    void showEvent(QShowEvent* event) override;

 
     /** @see QMainWindow::closeEvent() */
 
     /** @see QMainWindow::closeEvent() */

-    virtual void closeEvent(QCloseEvent* event);
+    void closeEvent(QCloseEvent* event) override;

 
     /** @see KMainWindow::saveProperties() */
 
     /** @see KMainWindow::saveProperties() */

-    virtual void saveProperties(KConfigGroup& group);
+    void saveProperties(KConfigGroup& group) override;

 
     /** @see KMainWindow::readProperties() */
 
     /** @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:
     /**
 
 private slots:
     /**


@@ -203,6 +257,9 @@ private slots:
     /** Replaces the URL navigator by a search box to find files. */
     void find();
 
     /** 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.
     /**
      * Updates the text of the paste action dependent on
      * the number of items which are in the clipboard.


@@ -226,6 +283,9 @@ private slots:
      */
     void toggleSplitView();
 
      */
     void toggleSplitView();
 

+    /** Dedicated action to open the stash:/ ioslave in split view. */
+    void toggleSplitStash();
+

     /** Reloads the currently active view. */
     void reloadView();
 
     /** Reloads the currently active view. */
     void reloadView();
 


@@ -254,6 +314,12 @@ private slots:
      */
     void togglePanelLockState();
 
      */
     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 back one step of the URL history. */
     void goBack();
 


@@ -266,28 +332,17 @@ private slots:
     /** Changes the location to the home URL. */
     void goHome();
 
     /** 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();
 
     /** Opens Kompare for 2 selected files. */
     void compareFiles();


@@ -298,9 +353,18 @@ private slots:
      */
     void toggleShowMenuBar();
 
      */
     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();
 
     /** Opens a terminal window for the current location. */
     void openTerminal();
 

+    /** Focus a Terminal Panel. */
+    void focusTerminalPanel();
+

     /** Opens the settings dialog for Dolphin. */
     void editSettings();
 
     /** Opens the settings dialog for Dolphin. */
     void editSettings();
 


@@ -313,9 +377,6 @@ private slots:
      */
     void slotSelectionChanged(const KFileItemList& selection);
 
      */
     void slotSelectionChanged(const KFileItemList& selection);
 

-    /** Emits the signal requestItemInfo(). */
-    void slotRequestItemInfo(const KFileItem&);
-

     /**
      * Updates the state of the 'Back' and 'Forward' menu
      * actions corresponding to the current history.
     /**
      * Updates the state of the 'Back' and 'Forward' menu
      * actions corresponding to the current history.


@@ -335,16 +396,14 @@ private slots:
     void openNewActivatedTab();
 
     /**
     void openNewActivatedTab();
 
     /**

-     * Opens a new tab in the background showing the URL \a primaryUrl and the
-     * optional URL \a secondaryUrl.
+     * Adds the current URL as an entry to the Places panel

      */
      */

-    void openNewTab(const KUrl& primaryUrl, const KUrl& secondaryUrl = KUrl());
+    void addToPlaces();

 
     /**
 
     /**

-     * Opens a new tab showing the  URL \a primaryUrl and the optional URL
-     * \a secondaryUrl and activates the tab.
+     * Opens a new tab in the background showing the URL \a url.

      */
      */

-    void openNewActivatedTab(const KUrl& primaryUrl, const KUrl& secondaryUrl = KUrl());
+    void openNewTab(const QUrl& url, DolphinTabWidget::TabPlacement tabPlacement);

 
     /**
      * Opens the selected folder in a new tab.
 
     /**
      * Opens the selected folder in a new tab.


@@ -356,6 +415,11 @@ private slots:
      */
     void openInNewWindow();
 
      */
     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.
     /**
      * Indicates in the statusbar that the execution of the command \a command
      * has been finished.


@@ -366,7 +430,7 @@ private slots:
      * If the URL can be listed, open it in the current view, otherwise
      * run it through KRun.
      */
      * If the URL can be listed, open it in the current view, otherwise
      * run it through KRun.
      */

-    void handleUrl(const KUrl& url);
+    void handleUrl(const QUrl& url);

 
     /**
      * handleUrl() can trigger a stat job to see if the url can actually
 
     /**
      * handleUrl() can trigger a stat job to see if the url can actually


@@ -391,25 +455,19 @@ private slots:
      */
     void openContextMenu(const QPoint& pos,
                          const KFileItem& item,
      */
     void openContextMenu(const QPoint& pos,
                          const KFileItem& item,

-                         const KUrl& url,
+                         const QUrl& url,

                          const QList<QAction*>& customActions);
 
     void updateControlMenu();
     void updateToolBar();
     void slotControlButtonDeleted();
 
                          const QList<QAction*>& customActions);
 
     void updateControlMenu();
     void updateToolBar();
     void slotControlButtonDeleted();
 

-    /**
-     * Is called if a panel emits an error-message and shows
-     * the error-message in the active view-container.
-     */
-    void slotPanelErrorMessage(const QString& error);
-

     /**
      * 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.
      */
     /**
      * 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 slotPlaceActivated(const KUrl& url);
+    void slotPlaceActivated(const QUrl& url);

 
     /**
      * Is called if the another view has been activated by changing the current
 
     /**
      * Is called if the another view has been activated by changing the current


@@ -429,10 +487,81 @@ private slots:
      */
     void tabCountChanged(int count);
 
      */
     void tabCountChanged(int count);
 

+    /**
+     * 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 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:
 private:

+    /**
+     * Sets up the various menus and actions and connects them.
+     */

     void setupActions();
     void setupActions();

+
+    /**
+     * Sets up the dock widgets and their panels.
+     */

     void setupDockWidgets();
     void setupDockWidgets();

-    void updateEditActions();
+
+    void updateFileAndEditActions();

     void updateViewActions();
     void updateGoActions();
 
     void updateViewActions();
     void updateGoActions();
 


@@ -444,7 +573,7 @@ private:
      * case if it has not added already to the toolbar.
      * @return True if the action has been added to the menu.
      */
      * 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, KMenu* menu);
+    bool addActionToMenu(QAction* action, QMenu* menu);

 
     /**
      * Connects the signals from the created DolphinView with
 
     /**
      * Connects the signals from the created DolphinView with


@@ -464,23 +593,29 @@ private:
 
     bool isKompareInstalled() const;
 
 
     bool isKompareInstalled() const;
 

-    /**
-     * Sets the window caption to url.fileName() if this is non-empty,
-     * "/" if the URL is "file:///", and url.protocol() otherwise.
-     */
-    void setUrlAsCaption(const KUrl& url);
-

     /**
      * 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.
      */
     /**
      * 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.
      */

-    void createPanelAction(const KIcon& icon,
+    void createPanelAction(const QIcon &icon,

                            const QKeySequence& shortcut,
                            QAction* dockAction,
                            const QString& actionName);
 
                            const QKeySequence& shortcut,
                            QAction* dockAction,
                            const QString& actionName);
 

+    /** Adds "What's This?" texts to many widgets and StandardActions. */
+    void setupWhatsThis();
+
+    /**
+     * Returns the KIO::StatJob::mostLocalUrl() for the active container URL
+     * if it's a local file. Otherwise returns the user's home path.
+     */
+    QString activeContainerLocalPath();
+
+    /** 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
 private:
     /**
      * Implements a custom error handling for the undo manager. This


@@ -491,24 +626,35 @@ private:
     {
     public:
         UndoUiInterface();
     {
     public:
         UndoUiInterface();

-        virtual ~UndoUiInterface();
-        virtual void jobError(KIO::Job* job);
+        ~UndoUiInterface() override;
+        void jobError(KIO::Job* job) override;

     };
 
     KNewFileMenu* m_newFileMenu;
     };
 
     KNewFileMenu* m_newFileMenu;

+    KHelpMenu* m_helpMenu;

     DolphinTabWidget* m_tabWidget;
     DolphinViewContainer* m_activeViewContainer;
     DolphinTabWidget* m_tabWidget;
     DolphinViewContainer* m_activeViewContainer;

-    int m_id;

 
     DolphinViewActionHandler* m_actionHandler;
     DolphinRemoteEncoding* m_remoteEncoding;
 
     DolphinViewActionHandler* m_actionHandler;
     DolphinRemoteEncoding* m_remoteEncoding;

-    QWeakPointer<DolphinSettingsDialog> m_settingsDialog;
+    QPointer<DolphinSettingsDialog> 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;
 
     // Members for the toolbar menu that is shown when the menubar is hidden:
     QToolButton* m_controlButton;
     QTimer* m_updateToolBarTimer;
 
     KIO::Job* m_lastHandleUrlStatJob;

+
+    TerminalPanel* m_terminalPanel;
+    PlacesPanel* m_placesPanel;
+    bool m_tearDownFromPlacesRequested;
+
+    KToolBarPopupAction* m_backAction;
+    KToolBarPopupAction* m_forwardAction;
+
+    QMenu m_searchTools;
+

 };
 
 inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
 };
 
 inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const


@@ -521,10 +667,5 @@ inline KNewFileMenu* DolphinMainWindow::newFileMenu() const
     return m_newFileMenu;
 }
 
     return m_newFileMenu;
 }
 

-inline int DolphinMainWindow::getId() const
-{
-    return m_id;
-}
-

 #endif // DOLPHIN_MAINWINDOW_H
 
 #endif // DOLPHIN_MAINWINDOW_H