]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphinmainwindow.h
* allow to toggle the content of split views by the context menu
[dolphin.git] / src / dolphinmainwindow.h
index 62327b4694c7465f71c86b9121bef277b38b83d9..a165573a1c08e7449ad00b0c5b0af0802d20e8b9 100644 (file)
  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  ***************************************************************************/
 
-#ifndef _DOLPHIN_MAINWINDOW_H_
-#define _DOLPHIN_MAINWINDOW_H_
+#ifndef DOLPHIN_MAINWINDOW_H
+#define DOLPHIN_MAINWINDOW_H
 
-#ifdef HAVE_CONFIG_H
-#include <config.h>
-#endif
+#include "dolphinview.h"
+#include "sidebarpage.h"
 
-#include <kapplication.h>
-#include <kmainwindow.h>
+#include <kxmlguiwindow.h>
 #include <ksortablelist.h>
-#include <kvbox.h>
-
-#include <q3valuelist.h>
-#include <q3ptrlist.h>
+#include <konq_undo.h>
 
-#include <QCloseEvent>
-#include <QString>
-
-#include "dolphinview.h"
-#include "undomanager.h"
+#include <QtCore/QList>
 
-class KPrinter;
+class DolphinApplication;
+class DolphinViewContainer;
+class KNewMenu;
 class KUrl;
-class QLineEdit;
-class KFileIconView;
-class KHBox;
-class Q3IconViewItem;
 class QSplitter;
-class KAction;
-class UrlNavigator;
-class DolphinApplication;
 
 /**
  * @short Main window for Dolphin.
  *
  * Handles the menus, toolbars and Dolphin views.
- *
- * @author Peter Penz <peter.penz@gmx.at>
-*/
-class DolphinMainWindow: public KMainWindow
+ */
+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();
 
-       /**
-     * Activates the given view, which means that
-     * all menu actions are applied to this view. When
-     * having a split view setup the nonactive 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.
      */
-    void setActiveView(DolphinView* view);
+    inline 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().
+     */
+    inline bool isSplit() const;
 
     /**
-     * Returns the currently active view. See
-     * DolphinMainWindow::setActiveView() for more details.
+     * 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).
      */
-    DolphinView* activeView() const { return m_activeView; }
+    void toggleViews();
+
+    /** Renames the item represented by \a oldUrl to \a newUrl. */
+    void rename(const KUrl& oldUrl, const KUrl& newUrl);
 
     /**
-     * Handles the dropping of Urls to the given
+     * Refreshs the views of the main window by recreating them dependent from
+     * the given Dolphin settings.
+     */
+    void refreshViews();
+
+    /**
+     * Returns the 'Create New...' sub menu which also can be shared
+     * with other menus (e. g. a context menu).
+     */
+    inline KNewMenu* newMenu() 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
+     * @param urls        List of URLs which have been
      *                    dropped.
-     * @param destination Destination Url, where the
-     *                    list or Urls should be moved,
+     * @param destination Destination URL, where the
+     *                    list or URLs should be moved,
      *                    copied or linked to.
      */
     void dropUrls(const KUrl::List& urls,
                   const KUrl& destination);
 
     /**
-     * Returns 'true', if the clipboard contains data
-     * which has been cutted by the Cut action (Ctrl + X).
+     * Returns the main window ID used through DBus.
      */
-    bool clipboardContainsCutData() const { return m_clipboardContainsCutData; }
+    inline int getId() const;
 
     /**
-     * Returns the list of actions which are part of the file group
-     * of the 'Create New...' sub menu. Usually the list contains actions
-     * for creating folders, text files, HTML files etc.
+     * Inform all affected dolphin components (sidebars, views) of an URL
+     * change.
      */
-    QLinkedList<QAction*> fileGroupActions() const { return m_fileGroupActions; }
-    //QLinkedList<QAction*>& linkGroupActions() const { return m_linkGroupActions; }
-    //QLinkedList<QAction*>& linkToDeviceActions() const { return m_linkToDeviceActions; }
+    void changeUrl(const KUrl& url);
 
     /**
-     * Refreshs the views of the main window by recreating them dependent from
-     * the given Dolphin settings.
+     * Inform all affected dolphin components that a selection change is
+     * requested.
      */
-    void refreshViews();
+    void changeSelection(const KFileItemList& selection);
+
+    /** Stores all settings and quits Dolphin. */
+    void quit();
 
 signals:
     /**
@@ -122,10 +133,22 @@ signals:
     void activeViewChanged();
 
     /**
-     * Is send if the selection of the currently active view has
+     * Is sent if the selection of the currently active view has
      * been changed.
      */
-    void selectionChanged();
+    void selectionChanged(const KFileItemList& selection);
+
+    /**
+     * Is sent if the url of the currently active view has
+     * been changed.
+     */
+    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.
+     */
+    void requestItemInfo(const KUrl& url);
 
 protected:
     /** @see QMainWindow::closeEvent */
@@ -145,13 +168,13 @@ protected:
     void readProperties(KConfig*);
 
 private slots:
-    /** Opens an input dialog for creating a new folder. */
-    void createFolder();
-
-    /** Creates a file with the MIME type given by the sender. */
-    void createFile();
+    /** Updates the 'Create New...' sub menu. */
+    void updateNewMenu();
 
-    /** Renames the selected item of the active view. */
+    /**
+     * Let the user input a name for the selected item(s) and trigger
+     * a renaming afterwards.
+     */
     void rename();
 
     /** Moves the selected items of the active view to the trash. */
@@ -162,14 +185,11 @@ private slots:
 
     /**
      * Opens the properties window for the selected items of the
-     * active view. The properties windows shows informations
+     * active view. The properties windows shows information
      * like name, size and permissions.
      */
     void properties();
 
-    /** Stores all settings and quits Dolphin. */
-    void quit();
-
     /**
      * Shows the error information of the job \a job
      * in the status bar.
@@ -191,14 +211,8 @@ private slots:
     /** Sets the text of the 'Undo' menu action to \a text. */
     void slotUndoTextChanged(const QString& text);
 
-    /**
-     * Updates the state of the 'Redo' menu action dependent
-     * from the parameter \a available.
-     */
-    void slotRedoAvailable(bool available);
-
-    /** Sets the text of the 'Redo' menu action to \a text. */
-    void slotRedoTextChanged(const QString& text);
+    /** Performs the current undo operation. */
+    void undo();
 
     /**
      * Copies all selected items to the clipboard and marks
@@ -234,8 +248,8 @@ private slots:
     /** The current active view is switched to the details mode. */
     void setDetailsView();
 
-    /** The current active view is switched to the previews mode. */
-    void setPreviewsView();
+    /** 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();
@@ -246,9 +260,39 @@ private slots:
     /** 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.
@@ -262,17 +306,20 @@ private slots:
     /** Stops the loading process for the current active view. */
     void stopLoading();
 
+    /** Switches between showing a preview of the file content and showing the icon. */
+    void togglePreview();
+
     /**
      * Switches between showing and hiding of hidden marked files dependent
      * from the current state of the 'Show Hidden Files' menu toggle action.
      */
-    void showHiddenFiles();
+    void toggleShowHiddenFiles();
 
     /**
-     * Switches between showing and hiding of the filter bar dependent
+     * Toggles between showing and hiding of the filter bar dependent
      * from the current state of the 'Show Filter Bar' menu toggle action.
      */
-    void showFilterBar();
+    void toggleFilterBarVisibility();
 
     /** Increases the size of the current set view mode. */
     void zoomIn();
@@ -297,21 +344,18 @@ private slots:
      */
     void adjustViewProperties();
 
-    /** Goes back on step of the Url history. */
+    /** Goes back on step of the URL history. */
     void goBack();
 
-    /** Goes forward one step of the Url history. */
+    /** Goes forward one step of the URL history. */
     void goForward();
 
-    /** Goes up one hierarchy of the current Url. */
+    /** Goes up one hierarchy of the current URL. */
     void goUp();
 
-    /** Goes to the home Url. */
+    /** Goes to the home URL. */
     void goHome();
 
-    /** Opens a terminal for the current shown directory. */
-    void openTerminal();
-
     /** Opens KFind for the current shown directory. */
     void findFile();
 
@@ -321,71 +365,73 @@ private slots:
     /** Opens the settings dialog for Dolphin. */
     void editSettings();
 
-    /**
-     * Adds the undo operation given by \a job
-     * to the UndoManager.
-     */
-    void addUndoOperation(KJob* job);
-
     /** Updates the state of all 'View' menu actions. */
     void slotViewModeChanged();
 
+    /** Updates the state of the 'Show preview' menu action. */
+    void slotShowPreviewChanged();
+
     /** Updates the state of the 'Show hidden files' menu action. */
     void slotShowHiddenFilesChanged();
 
+    /** Updates the state of the 'Categorized sorting' menu action. */
+    void slotCategorizedSortingChanged();
+
     /** Updates the state of the 'Sort by' actions. */
     void slotSortingChanged(DolphinView::Sorting sorting);
 
     /** Updates the state of the 'Sort Ascending/Descending' action. */
     void slotSortOrderChanged(Qt::SortOrder order);
 
-    /** Updates the state of the 'Edit' menu actions. */
-    void slotSelectionChanged();
+    /** Updates the state of the 'Additional Information' actions. */
+    void slotAdditionalInfoChanged(KFileItemDelegate::AdditionalInformation info);
 
     /**
-     * Updates the state of the 'Back' and 'Forward' menu
-     * actions corresponding the the current history.
+     * Updates the state of the 'Edit' menu actions and emits
+     * the signal selectionChanged().
      */
-    void slotHistoryChanged();
+    void slotSelectionChanged(const KFileItemList& selection);
+
+    /** Emits the signal requestItemInfo(). */
+    void slotRequestItemInfo(const KUrl& url);
 
     /**
-     * Updates the caption of the main window and the state
-     * of all menu actions which depend from a changed Url.
+     * Updates the state of the 'Back' and 'Forward' menu
+     * actions corresponding the the current history.
      */
-    void slotUrlChanged(const KUrl& url);
+    void slotHistoryChanged();
 
     /** Updates the state of the 'Show filter bar' menu action. */
     void updateFilterBarAction(bool show);
 
-    /** Executes the redo operation (see UndoManager::Redo ()). */
-    void redo();
-
-    /** Executes the undo operation (see UndoManager::Undo()). */
-    void undo();
-
     /** Open a new main window. */
     void openNewMainWindow();
 
+    /** Toggles the active view if two views are shown within the main window. */
+    void toggleActiveView();
+
 private:
-    DolphinMainWindow();
+    DolphinMainWindow(int id);
     void init();
     void loadSettings();
 
-    void setupAccel();
+    /**
+     * 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 setActiveViewContainer(DolphinViewContainer* view);
+
     void setupActions();
     void setupDockWidgets();
-    void setupCreateNewMenuActions();
     void updateHistory();
     void updateEditActions();
     void updateViewActions();
     void updateGoActions();
-    void updateViewProperties(const KUrl::List& urls);
     void copyUrls(const KUrl::List& source, const KUrl& dest);
     void moveUrls(const KUrl::List& source, const KUrl& dest);
-    void addPendingUndoJob(KIO::Job* job,
-                           DolphinCommand::Type commandType,
-                           const KUrl::List& source,
-                           const KUrl& dest);
+    void linkUrls(const KUrl::List& source, const KUrl& dest);
     void clearStatusBar();
 
     /**
@@ -396,58 +442,70 @@ private:
      */
     void connectViewSignals(int viewIndex);
 
-private:
-    QSplitter* m_splitter;
-    DolphinView* m_activeView;
+    /**
+     * Updates the text of the split action:
+     * If \a isSplit is true, the text is set to "Split",
+     * otherwise the text is set to "Join". The icon
+     * is updated to match with the text.
+     */
+    void updateSplitAction(bool isSplit);
 
+private:
     /**
-     * DolphinMainWindowsupports only one or two views, which
-     * are handled internally as primary and secondary view.
+     * DolphinMainWindow supports up to two views beside each other.
      */
     enum ViewIndex
     {
-        PrimaryIdx = 0,
-        SecondaryIdx = 1
+        PrimaryView = 0,   ///< View shown on the left side of the main window.
+        SecondaryView = 1  ///< View shown on the left side of the main window.
     };
-    DolphinView* m_view[SecondaryIdx + 1];
-
-    /// If set to true, the clipboard contains data which should be cutted after pasting.
-    bool m_clipboardContainsCutData;
 
     /**
-     * Asynchronous operations like 'Move' and 'Copy' may only be added as undo
-     * operation after they have been finished successfully. When an asynchronous
-     * operation is started, it is added to a pending undo jobs list in the meantime.
-     * As soon as the job has been finished, the operation is added to the undo mangager.
-     * @see UndoManager
-     * @see DolphinMainWindow::addPendingUndoJob
-     * @see DolphinMainWindow::addUndoOperation
+     * 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.
      */
-    struct UndoInfo
+    class UndoUiInterface : public KonqUndoManager::UiInterface
     {
-        int id;
-        DolphinCommand command;
-    };
-    Q3ValueList<UndoInfo> m_pendingUndoJobs;
+    public:
+        UndoUiInterface(DolphinMainWindow* mainWin);
+        virtual ~UndoUiInterface();
+        virtual void jobError(KIO::Job* job);
 
-    /** Contains meta information for creating files. */
-    struct CreateFileEntry
-    {
-        QString name;
-        QString filePath;
-        QString templatePath;
-        QString icon;
-        QString comment;
+    private:
+        DolphinMainWindow* m_mainWin;
     };
 
-    QLinkedList<QAction*> m_fileGroupActions;
-    KSortableList<CreateFileEntry,QString> m_createFileTemplates;
+    KNewMenu* m_newMenu;
+    QSplitter* m_splitter;
+    DolphinViewContainer* m_activeViewContainer;
+    int m_id;
+
+    DolphinViewContainer* m_viewContainer[SecondaryView + 1];
 
-    // TODO: not used yet. See documentation of DolphinMainWindow::linkGroupActions()
-    // and DolphinMainWindow::linkToDeviceActions() in for details.
-    //QLinkedList<QAction*> m_linkGroupActions;
-    //QLinkedList<QAction*> m_linkToDeviceActions;
+    /// remember pending undo operations until they are finished
+    QList<KonqUndoManager::CommandType> m_undoCommandTypes;
 };
 
-#endif // _DOLPHIN_H_
+DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
+{
+    return m_activeViewContainer;
+}
+
+bool DolphinMainWindow::isSplit() const
+{
+    return m_viewContainer[SecondaryView] != 0;
+}
+
+KNewMenu* DolphinMainWindow::newMenu() const
+{
+    return m_newMenu;
+}
+
+int DolphinMainWindow::getId() const
+{
+    return m_id;
+}
+
+#endif // DOLPHIN_MAINWINDOW_H