]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphinmainwindow.h
Merge branch 'master' into frameworks
[dolphin.git] / src / dolphinmainwindow.h
index 6838b61b0296a94bb79b28d5bfec852642e8e092..fd231cf0b7f3005c5119bcffe4952301e59c9f30 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 <kxmlguiwindow.h>
+#include <KFileItemDelegate>
+#include <kio/fileundomanager.h>
 #include <ksortablelist.h>
-#include <konq_undo.h>
+#include <kxmlguiwindow.h>
+#include <KIcon>
+#include <KUrl>
+
+#include <QList>
+#include <QWeakPointer>
 
-#include <QtCore/QList>
+typedef KIO::FileUndoManager::CommandType CommandType;
 
+class DolphinViewActionHandler;
 class DolphinApplication;
-class KNewMenu;
-class KUrl;
-class QSplitter;
+class DolphinSettingsDialog;
+class DolphinViewContainer;
+class DolphinRemoteEncoding;
+class DolphinTabWidget;
+class KFileItem;
+class KFileItemList;
+class KJob;
+class KNewFileMenu;
+class QToolButton;
+class QIcon;
 
 /**
  * @short Main window for Dolphin.
@@ -49,88 +62,67 @@ class DolphinMainWindow: public KXmlGuiWindow
     friend class DolphinApplication;
 
 public:
+    DolphinMainWindow();
     virtual ~DolphinMainWindow();
 
     /**
-        * 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 setActiveView(DolphinView* view);
+     * Returns the currently active view.
+     * All menu actions are applied to this view. When
+     * having a split view setup, the nonactive view
+     * is usually shown in darker colors.
+     */
+    DolphinViewContainer* activeViewContainer() const;
 
     /**
-     * Returns the currently active view. See
-     * DolphinMainWindow::setActiveView() for more details.
+     * Opens each directory in \p dirs in a separate tab. If the "split view"
+     * option is enabled, 2 directories are collected within one tab.
      */
-    DolphinView* activeView() const
-    {
-        return m_activeView;
-    }
-
-    /** Renames the item represented by \a oldUrl to \a newUrl. */
-    void rename(const KUrl& oldUrl, const KUrl& newUrl);
+    void openDirectories(const QList<KUrl>& dirs);
 
     /**
-     * Refreshs the views of the main window by recreating them dependent from
-     * the given Dolphin settings.
+     * Opens the directory which contains the files \p files
+     * and selects all files (implements the --select option
+     * of Dolphin).
      */
-    void refreshViews();
+    void openFiles(const QList<KUrl>& files);
 
     /**
      * Returns the 'Create New...' sub menu which also can be shared
      * with other menus (e. g. a context menu).
      */
-    KNewMenu* newMenu() const
-    {
-        return m_newMenu;
-    }
+    KNewFileMenu* newFileMenu() const;
 
 public slots:
     /**
-     * Handles the dropping of URLs to the given
-     * destination. A context menu with the options
-     * 'Move Here', 'Copy Here', 'Link Here' and
-     * 'Cancel' is offered to the user.
-     * @param urls        List of URLs which have been
-     *                    dropped.
-     * @param destination Destination URL, where the
-     *                    list or URLs should be moved,
-     *                    copied or linked to.
+     * Pastes the clipboard data into the currently selected folder
+     * of the active view. If not exactly one folder is selected,
+     * no pasting is done at all.
      */
-    void dropUrls(const KUrl::List& urls,
-                  const KUrl& destination);
+    void pasteIntoFolder();
 
     /**
      * Returns the main window ID used through DBus.
      */
-    int getId() const
-    {
-        return m_id;
-    }
+    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);
 
     /**
-     * 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 KUrl& url);
 
     /** Stores all settings and quits Dolphin. */
     void quit();
 
 signals:
-    /**
-     * Is send if the active view has been changed in
-     * the split view mode.
-     */
-    void activeViewChanged();
-
     /**
      * Is sent if the selection of the currently active view has
      * been changed.
@@ -144,66 +136,49 @@ signals:
     void urlChanged(const KUrl& url);
 
     /**
-     * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
-     * It the URL is empty, no item information request is pending.
+     * 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 KUrl& url);
+    void requestItemInfo(const KFileItem& item);
+
+    /**
+     * Is emitted if the settings have been changed.
+     */
+    void settingsChanged();
 
 protected:
-    /** @see QMainWindow::closeEvent */
+    /** @see QWidget::showEvent() */
+    virtual void showEvent(QShowEvent* event);
+
+    /** @see QMainWindow::closeEvent() */
     virtual void closeEvent(QCloseEvent* event);
 
-    /**
-     * This method is called when it is time for the app to save its
-     * properties for session management purposes.
-     */
-    void saveProperties(KConfig*);
+    /** @see KMainWindow::saveProperties() */
+    virtual void saveProperties(KConfigGroup& group);
 
-    /**
-     * This method is called when this app is restored.  The KConfig
-     * object points to the session management config file that was saved
-     * with @ref saveProperties
-     */
-    void readProperties(KConfig*);
+    /** @see KMainWindow::readProperties() */
+    virtual void readProperties(const KConfigGroup& group);
 
 private slots:
-    /** Updates the 'Create New...' sub menu. */
-    void updateNewMenu();
-
     /**
-     * Let the user input a name for the selected item(s) and trigger
-     * a renaming afterwards.
+     * Refreshes the views of the main window by recreating them according to
+     * the given Dolphin settings.
      */
-    void rename();
-
-    /** Moves the selected items of the active view to the trash. */
-    void moveToTrash();
+    void refreshViews();
 
-    /** Deletes the selected items of the active view. */
-    void deleteItems();
+    void clearStatusBar();
 
-    /**
-     * Opens the properties window for the selected items of the
-     * active view. The properties windows shows information
-     * like name, size and permissions.
-     */
-    void properties();
+    /** Updates the 'Create New...' sub menu. */
+    void updateNewMenu();
 
-    /**
-     * Shows the error information of the job \a job
-     * in the status bar.
-     */
-    void slotHandleJobError(KJob* job);
+    void createDirectory();
 
-    /**
-     * Indicates in the status bar that the delete operation
-     * of the job \a job has been finished.
-     */
-    void slotDeleteFileFinished(KJob* job);
+    /** 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);
 
@@ -215,7 +190,7 @@ private slots:
 
     /**
      * Copies all selected items to the clipboard and marks
-     * the items as cutted.
+     * the items as cut.
      */
     void cut();
 
@@ -225,8 +200,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();
@@ -241,109 +219,42 @@ private slots:
      */
     void invertSelection();
 
-    /** The current active view is switched to the icons mode. */
-    void setIconsView();
-
-    /** The current active view is switched to the details mode. */
-    void setDetailsView();
-
-    /** The current active view is switched to the column mode. */
-    void setColumnView();
-
-    /** The sorting of the current view should be done by the name. */
-    void sortByName();
-
-    /** The sorting of the current view should be done by the size. */
-    void sortBySize();
-
-    /** The sorting of the current view should be done by the date. */
-    void sortByDate();
-
-    /** The sorting of the current view should be done by the permissions. */
-    void sortByPermissions();
-
-    /** The sorting of the current view should be done by the owner. */
-    void sortByOwner();
-
-    /** The sorting of the current view should be done by the group. */
-    void sortByGroup();
-
-    /** The sorting of the current view should be done by the type. */
-    void sortByType();
-
-    /** Switches between an ascending and descending sorting order. */
-    void toggleSortOrder();
-
-    /** Switches between sorting by categories or not. */
-    void toggleSortCategorization();
-
-    /**
-     * Clears any additional information for an item except for the
-     * name and the icon.
-     */
-    void clearInfo();
-
-    /** Shows the MIME type as additional information for the item. */
-    void showMimeInfo();
-
-    /** Shows the size as additional information for the item. */
-    void showSizeInfo();
-
-    /** Shows the date as additional information for the item. */
-    void showDateInfo();
-
     /**
      * 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. */
+    /** 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();
 
-    /** Switches between showing a preview of the file content and showing the icon. */
-    void togglePreview();
+    void enableStopAction();
+    void disableStopAction();
 
-    /**
-     * Switches between showing and hiding of hidden marked files dependent
-     * from the current state of the 'Show Hidden Files' menu toggle action.
-     */
-    void toggleShowHiddenFiles();
+    void showFilterBar();
 
     /**
-     * Toggles between showing and hiding of the filter bar dependent
-     * from the current state of the 'Show Filter Bar' menu toggle action.
-     */
-    void toggleFilterBarVisibility();
-
-    /** Increases the size of the current set view mode. */
-    void zoomIn();
-
-    /** Decreases the size of the current set view mode. */
-    void zoomOut();
-
-    /**
-     * Toggles between edit and brose mode of the navigation bar.
+     * Toggles between edit and browse mode of the navigation bar.
      */
     void toggleEditLocation();
 
     /**
-     * Switches to the edit mode of the navigation bar. If the edit mode is
+     * Switches to the edit mode of the navigation bar and selects
+     * the whole URL, so that it can be replaced by the user. If the edit mode is
      * already active, it is assured that the navigation bar get focused.
      */
-    void editLocation();
+    void replaceLocation();
 
     /**
-     * Opens the view properties dialog, which allows to modify the properties
-     * of the currently active view.
+     * Toggles the state of the panels between a locked and unlocked layout.
      */
-    void adjustViewProperties();
+    void togglePanelLockState();
 
-    /** Goes back on step of the URL history. */
+    /** Goes back one step of the URL history. */
     void goBack();
 
     /** Goes forward one step of the URL history. */
@@ -352,38 +263,49 @@ 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();
 
-    /** Opens KFind for the current shown directory. */
-    void findFile();
-
-    /** Opens Kompare for 2 selected files. */
-    void compareFiles();
+    /**
+     * Open the previous URL in the URL history in a new tab
+     * if the middle mouse button is clicked.
+     */
+    void goBack(Qt::MouseButtons buttons);
 
-    /** Opens the settings dialog for Dolphin. */
-    void editSettings();
+    /**
+     * Open the next URL in the URL history in a new tab
+     * if the middle mouse button is clicked.
+     */
+    void goForward(Qt::MouseButtons buttons);
 
-    /** Updates the state of all 'View' menu actions. */
-    void slotViewModeChanged();
+    /**
+     * 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);
 
-    /** Updates the state of the 'Show preview' menu action. */
-    void slotShowPreviewChanged();
+    /**
+     * Open the home URL in a new tab
+     */
+    void goHome(Qt::MouseButtons buttons);
 
-    /** Updates the state of the 'Show hidden files' menu action. */
-    void slotShowHiddenFilesChanged();
+    /** Opens Kompare for 2 selected files. */
+    void compareFiles();
 
-    /** Updates the state of the 'Categorized sorting' menu action. */
-    void slotCategorizedSortingChanged();
+    /**
+     * Hides the menu bar if it is visible, makes the menu bar
+     * visible if it is hidden.
+     */
+    void toggleShowMenuBar();
 
-    /** Updates the state of the 'Sort by' actions. */
-    void slotSortingChanged(DolphinView::Sorting sorting);
+    /** Opens a terminal window for the current location. */
+    void openTerminal();
 
-    /** Updates the state of the 'Sort Ascending/Descending' action. */
-    void slotSortOrderChanged(Qt::SortOrder order);
+    /** Opens the settings dialog for Dolphin. */
+    void editSettings();
 
-    /** Updates the state of the 'Additional Information' actions. */
-    void slotAdditionalInfoChanged(KFileItemDelegate::AdditionalInformation info);
+    /** Updates the state of the 'Show Full Location' action. */
+    void slotEditableStateChanged(bool editable);
 
     /**
      * Updates the state of the 'Edit' menu actions and emits
@@ -392,13 +314,13 @@ private slots:
     void slotSelectionChanged(const KFileItemList& selection);
 
     /** Emits the signal requestItemInfo(). */
-    void slotRequestItemInfo(const KUrl& url);
+    void slotRequestItemInfo(const KFileItem&);
 
     /**
      * Updates the state of the 'Back' and 'Forward' menu
-     * actions corresponding the the current history.
+     * actions corresponding to the current history.
      */
-    void slotHistoryChanged();
+    void updateHistory();
 
     /** Updates the state of the 'Show filter bar' menu action. */
     void updateFilterBarAction(bool show);
@@ -406,76 +328,203 @@ private slots:
     /** Open a new main window. */
     void openNewMainWindow();
 
-private:
-    DolphinMainWindow(int id);
-    void init();
-    void loadSettings();
+    /**
+     * Opens a new view with the current URL that is part of a tab and
+     * activates it.
+     */
+    void openNewActivatedTab();
+
+    /**
+     * Opens a new tab in the background showing the URL \a primaryUrl and the
+     * optional URL \a secondaryUrl.
+     */
+    void openNewTab(const KUrl& primaryUrl, const KUrl& secondaryUrl = KUrl());
+
+    /**
+     * Opens a new tab showing the  URL \a primaryUrl and the optional URL
+     * \a secondaryUrl and activates the tab.
+     */
+    void openNewActivatedTab(const KUrl& primaryUrl, const KUrl& secondaryUrl = KUrl());
+
+    /**
+     * Opens the selected folder in a new tab.
+     */
+    void openInNewTab();
+
+    /**
+     * Opens the selected folder in a new window.
+     */
+    void openInNewWindow();
+
+    /**
+     * Indicates in the statusbar that the execution of the command \a command
+     * has been finished.
+     */
+    void showCommand(CommandType command);
+
+    /**
+     * If the URL can be listed, open it in the current view, otherwise
+     * run it through KRun.
+     */
+    void handleUrl(const KUrl& 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.
+     */
+    void slotWriteStateChanged(bool isFolderWritable);
+
+    /**
+     * 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 openContextMenu(const QPoint& pos,
+                         const KFileItem& item,
+                         const KUrl& url,
+                         const QList<QAction*>& customActions);
 
-    void setupAccel();
+    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.
+     */
+    void slotPlaceActivated(const KUrl& url);
+
+    /**
+     * 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 activeViewChanged(DolphinViewContainer* viewContainer);
+
+    void closedTabsCountChanged(unsigned int count);
+
+    /**
+     * 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 KUrl& url);
+
+private:
     void setupActions();
     void setupDockWidgets();
-    void updateHistory();
     void updateEditActions();
     void updateViewActions();
     void updateGoActions();
-    void copyUrls(const KUrl::List& source, const KUrl& dest);
-    void moveUrls(const KUrl::List& source, const KUrl& dest);
-    void linkUrls(const KUrl::List& source, const KUrl& dest);
-    void clearStatusBar();
+
+    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, KMenu* menu);
 
     /**
      * Connects the signals from the created DolphinView with
-     * the index \a viewIndex with the corresponding slots of
+     * the DolphinViewContainer \a container with the corresponding slots of
      * the DolphinMainWindow. This method must be invoked each
      * time a DolphinView has been created.
      */
-    void connectViewSignals(int viewIndex);
+    void connectViewSignals(DolphinViewContainer* container);
 
     /**
      * Updates the text of the split action:
-     * If \a isSplit is true, the text is set to "Split",
+     * If two views are shown, the text is set to "Split",
      * otherwise the text is set to "Join". The icon
-     * is updated to match with the text.
+     * is updated to match with the text and the currently active view.
      */
-    void updateSplitAction(bool isSplit);
+    void updateSplitAction();
+
+    bool isKompareInstalled() const;
 
-private:
     /**
-     * DolphinMainWindowsupports only one or two views, which
-     * are handled internally as primary and secondary view.
+     * 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.
      */
-    enum ViewIndex
-    {
-        PrimaryIdx = 0,
-        SecondaryIdx = 1
-    };
+    void createPanelAction(const QIcon &icon,
+                           const QKeySequence& shortcut,
+                           QAction* dockAction,
+                           const QString& actionName);
 
+private:
     /**
      * Implements a custom error handling for the undo manager. This
      * assures that all errors are shown in the status bar of Dolphin
      * instead as modal error dialog with an OK button.
      */
-class UndoUiInterface : public KonqUndoManager::UiInterface
+    class UndoUiInterface : public KIO::FileUndoManager::UiInterface
     {
     public:
-        UndoUiInterface(DolphinMainWindow* mainWin);
+        UndoUiInterface();
         virtual ~UndoUiInterface();
         virtual void jobError(KIO::Job* job);
-
-    private:
-        DolphinMainWindow* m_mainWin;
     };
 
-    KNewMenu* m_newMenu;
-    QSplitter* m_splitter;
-    DolphinView* m_activeView;
+    KNewFileMenu* m_newFileMenu;
+    DolphinTabWidget* m_tabWidget;
+    DolphinViewContainer* m_activeViewContainer;
     int m_id;
 
-    DolphinView* m_view[SecondaryIdx + 1];
+    DolphinViewActionHandler* m_actionHandler;
+    DolphinRemoteEncoding* m_remoteEncoding;
+    QWeakPointer<DolphinSettingsDialog> m_settingsDialog;
+
+    // Members for the toolbar menu that is shown when the menubar is hidden:
+    QToolButton* m_controlButton;
+    QTimer* m_updateToolBarTimer;
 
-    /// remember pending undo operations until they are finished
-    QList<KonqUndoManager::CommandType> m_undoCommandTypes;
+    KIO::Job* m_lastHandleUrlStatJob;
 };
 
+inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
+{
+    return m_activeViewContainer;
+}
+
+inline KNewFileMenu* DolphinMainWindow::newFileMenu() const
+{
+    return m_newFileMenu;
+}
+
+inline int DolphinMainWindow::getId() const
+{
+    return m_id;
+}
+
 #endif // DOLPHIN_MAINWINDOW_H