]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphinmainwindow.h
Merge remote-tracking branch 'origin/Applications/17.12'
[dolphin.git] / src / dolphinmainwindow.h
index 8ec61d764f3443a7008f4556b43895226a996e77..c7a06c00a9e67f9c5c22888709592cb47564f2b3 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>                  *
+ *   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>       *
  *                                                                         *
 #ifndef DOLPHIN_MAINWINDOW_H
 #define DOLPHIN_MAINWINDOW_H
 
-#include "dolphinview.h"
-#include "sidebarpage.h"
+#include <config-baloo.h>
 
-#include <config-nepomuk.h>
-
-#include <kfileitemdelegate.h>
 #include <kio/fileundomanager.h>
 #include <ksortablelist.h>
 #include <kxmlguiwindow.h>
+#include <QIcon>
+#include <QUrl>
 
-#include <QtCore/QList>
+#include <QList>
+#include <QPointer>
 
 typedef KIO::FileUndoManager::CommandType CommandType;
 
-class KAction;
 class DolphinViewActionHandler;
-class DolphinApplication;
+class DolphinSettingsDialog;
 class DolphinViewContainer;
-class KNewMenu;
-class KTabBar;
-class KUrl;
-class QDropEvent;
-class QSplitter;
+class DolphinRemoteEncoding;
+class DolphinTabWidget;
+class KFileItem;
+class KFileItemList;
+class KJob;
+class KNewFileMenu;
+class QToolButton;
+class QIcon;
+class PlacesPanel;
+#ifndef Q_OS_WIN
+class TerminalPanel;
+#endif
 
 /**
  * @short Main window for Dolphin.
@@ -56,10 +61,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.
@@ -70,40 +75,26 @@ public:
     DolphinViewContainer* activeViewContainer() const;
 
     /**
-     * Returns true, if the main window contains two instances
-     * of a view container. The active view constainer can be
-     * accessed by DolphinMainWindow::activeViewContainer().
+     * 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.
      */
-    bool isSplit() const;
+    void openDirectories(const QList<QUrl> &dirs, 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).
+     * 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 toggleViews();
-
-    /** Renames the item represented by \a oldUrl to \a newUrl. */
-    void rename(const KUrl& oldUrl, const KUrl& newUrl);
-
-    /**
-     * Refreshes the views of the main window by recreating them dependent from
-     * the given Dolphin settings.
-     */
-    void refreshViews();
+    void openFiles(const QList<QUrl>& files, bool splitView);
 
     /**
      * Returns the 'Create New...' sub menu which also can be shared
      * with other menus (e. g. a context menu).
      */
-    KNewMenu* newMenu() const;
+    KNewFileMenu* newFileMenu() const;
 
-    /**
-     * Returns the 'Show Menubar' action which can be shared with
-     * other menus (e. g. a context menu).
-     */
-    KAction* showMenuBarAction() const;
+    void setTabsToHomeIfMountPathOpen(const QString& mountPath);
 
 public slots:
     /**
@@ -119,16 +110,18 @@ public slots:
     int getId() const;
 
     /**
-     * Inform all affected dolphin components (sidebars, views) of an URL
+     * 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);
 
     /**
-     * Inform all affected dolphin components that a selection change is
-     * requested.
+     * 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 changeSelection(const KFileItemList& selection);
+    void slotTerminalDirectoryChanged(const QUrl& url);
 
     /** Stores all settings and quits Dolphin. */
     void quit();
@@ -144,36 +137,52 @@ 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 sidebar.
+     * Is emitted if information of an item is requested to be shown e. g. in the panel.
      * If item is null, no item information request is pending.
      */
     void requestItemInfo(const KFileItem& item);
 
+    /**
+     * Is emitted if the settings have been changed.
+     */
+    void settingsChanged();
+
 protected:
+    /** @see QWidget::showEvent() */
+    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;
 
 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. */
     void updateNewMenu();
 
+    void createDirectory();
+
     /** Shows the error message in the status bar of the active view. */
     void showErrorMessage(const QString& message);
 
     /**
      * Updates the state of the 'Undo' menu action dependent
-     * from the parameter \a available.
+     * on the parameter \a available.
      */
     void slotUndoAvailable(bool available);
 
@@ -185,7 +194,7 @@ private slots:
 
     /**
      * Copies all selected items to the clipboard and marks
-     * the items as cutted.
+     * the items as cut.
      */
     void cut();
 
@@ -195,8 +204,11 @@ 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 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();
@@ -214,20 +226,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.
@@ -241,7 +256,12 @@ 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();
+
+    /** Goes back one step of the URL history. */
     void goBack();
 
     /** Goes forward one step of the URL history. */
@@ -250,24 +270,33 @@ private slots:
     /** Goes up one hierarchy of the current URL. */
     void goUp();
 
-    /** Goes to the home URL. */
+    /** Changes the location to the home URL. */
     void goHome();
 
+    /** 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. */
+    void goForwardInNewTab();
+
+    /** 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();
 
-    /**
-     * Initiates a preview of the selected files
-     * on the desktop by the Previewer plasmoid.
-     */
-    void quickView();
-
     /**
      * Hides the menu bar if it is visible, makes the menu bar
      * visible if it is hidden.
      */
     void toggleShowMenuBar();
 
+    /** Opens a terminal window for the current location. */
+    void openTerminal();
+
     /** Opens the settings dialog for Dolphin. */
     void editSettings();
 
@@ -280,9 +309,6 @@ private slots:
      */
     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.
@@ -295,17 +321,16 @@ 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 activateNextTab();
+    void openNewActivatedTab();
 
-    void activatePrevTab();
+    /**
+     * Opens a new tab in the background showing the URL \a url.
+     */
+    void openNewTab(const QUrl& url);
 
     /**
      * Opens the selected folder in a new tab.
@@ -317,9 +342,6 @@ private slots:
      */
     void openInNewWindow();
 
-    /** Toggles the active view if two views are shown within the main window. */
-    void toggleActiveView();
-
     /**
      * Indicates in the statusbar that the execution of the command \a command
      * has been finished.
@@ -327,56 +349,117 @@ 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();
+    /**
+     * handleUrl() can trigger a stat job to see if the url can actually
+     * be listed.
+     */
+    void slotHandleUrlStatFinished(KJob* job);
 
     /**
-     * Closes the tab with the index \index and activates the tab with index - 1.
+     * Is invoked when the write state of a folder has been changed and
+     * enables/disables the "Create New..." menu entry.
      */
-    void closeTab(int index);
+    void slotWriteStateChanged(bool isFolderWritable);
 
     /**
-     * Opens a context menu for the tab with the index \a index
-     * on the position \a pos.
+     * 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 openTabContextMenu(int index, const QPoint& pos);
+    void openContextMenu(const QPoint& pos,
+                         const KFileItem& item,
+                         const QUrl& url,
+                         const QList<QAction*>& customActions);
+
+    void updateControlMenu();
+    void updateToolBar();
+    void slotControlButtonDeleted();
 
     /**
-     * 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 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 handlePlacesClick(const KUrl& url, Qt::MouseButtons buttons);
+    void slotPlaceActivated(const QUrl& url);
 
     /**
-     * Is connected to the KTabBar signal testCanDecode() and adjusts
-     * the output parameter \a accept.
+     * 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 slotTestCanDecode(const QDragMoveEvent* event, bool& accept);
+    void activeViewChanged(DolphinViewContainer* viewContainer);
 
-private:
-    DolphinMainWindow(int id);
-    void init();
+    void closedTabsCountChanged(unsigned int count);
 
     /**
-     * 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.
+     * Is called if a new tab has been opened or a tab has been closed to
+     * enable/disable the tab actions.
+     */
+    void tabCountChanged(int count);
+
+    /**
+     * Sets the window caption to url.fileName() if this is non-empty,
+     * "/" if the URL is "file:///", and url.protocol() otherwise.
+     */
+    void setUrlAsCaption(const QUrl& url);
+
+    /**
+     * 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 setActiveViewContainer(DolphinViewContainer* view);
+    void slotToolBarActionMiddleClicked(QAction *action);
 
+private:
     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.
+     */
+    bool addActionToMenu(QAction* action, QMenu* menu);
+
     /**
      * Connects the signals from the created DolphinView with
      * the DolphinViewContainer \a container with the corresponding slots of
@@ -393,12 +476,18 @@ 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);
+    /**
+     * 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 QIcon &icon,
+                           const QKeySequence& shortcut,
+                           QAction* dockAction,
+                           const QString& actionName);
 
 private:
     /**
@@ -410,30 +499,30 @@ private:
     {
     public:
         UndoUiInterface();
-        virtual ~UndoUiInterface();
-        virtual void jobError(KIO::Job* job);
+        ~UndoUiInterface() override;
+        void jobError(KIO::Job* job) override;
     };
 
-    KNewMenu* m_newMenu;
-    KAction* m_showMenuBar;
-    KTabBar* m_tabBar;
+    KNewFileMenu* m_newFileMenu;
+    DolphinTabWidget* m_tabWidget;
     DolphinViewContainer* m_activeViewContainer;
-    QVBoxLayout* m_centralWidgetLayout;
     int m_id;
 
-    struct ViewTab
-    {
-        ViewTab() : isPrimaryViewActive(true), primaryView(0), secondaryView(0), splitter(0) {}
-        bool isPrimaryViewActive;
-        DolphinViewContainer* primaryView;
-        DolphinViewContainer* secondaryView;
-        QSplitter* splitter;
-    };
+    DolphinViewActionHandler* m_actionHandler;
+    DolphinRemoteEncoding* m_remoteEncoding;
+    QPointer<DolphinSettingsDialog> m_settingsDialog;
 
-    int m_tabIndex;
-    QList<ViewTab> m_viewTab;
+    // Members for the toolbar menu that is shown when the menubar is hidden:
+    QToolButton* m_controlButton;
+    QTimer* m_updateToolBarTimer;
 
-    DolphinViewActionHandler* m_actionHandler;
+    KIO::Job* m_lastHandleUrlStatJob;
+
+#ifndef Q_OS_WIN
+    TerminalPanel* m_terminalPanel;
+#endif
+    PlacesPanel* m_placesPanel;
+    bool m_tearDownFromPlacesRequested;
 };
 
 inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
@@ -441,19 +530,9 @@ inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
     return m_activeViewContainer;
 }
 
-inline bool DolphinMainWindow::isSplit() const
-{
-    return m_viewTab[m_tabIndex].secondaryView != 0;
-}
-
-inline KNewMenu* DolphinMainWindow::newMenu() const
-{
-    return m_newMenu;
-}
-
-inline KAction* DolphinMainWindow::showMenuBarAction() const
+inline KNewFileMenu* DolphinMainWindow::newFileMenu() const
 {
-    return m_showMenuBar;
+    return m_newFileMenu;
 }
 
 inline int DolphinMainWindow::getId() const