src/dolphinmainwindow.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>                  *
   3  *   Copyright (C) 2006 by Stefan Monov <logixoul@gmail.com>               *
   4  *   Copyright (C) 2006 by Cvetoslav Ludmiloff <ludmiloff@gmail.com>       *
   5  *                                                                         *
   6  *   This program is free software; you can redistribute it and/or modify  *
   7  *   it under the terms of the GNU General Public License as published by  *
   8  *   the Free Software Foundation; either version 2 of the License, or     *
   9  *   (at your option) any later version.                                   *
  10  *                                                                         *
  11  *   This program is distributed in the hope that it will be useful,       *
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  14  *   GNU General Public License for more details.                          *
  15  *                                                                         *
  16  *   You should have received a copy of the GNU General Public License     *
  17  *   along with this program; if not, write to the                         *
  18  *   Free Software Foundation, Inc.,                                       *
  19  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  20  ***************************************************************************/
  21
  22 #ifndef DOLPHIN_MAINWINDOW_H
  23 #define DOLPHIN_MAINWINDOW_H
  24
  25 #include "dolphinview.h"
  26 #include "sidebarpage.h"
  27
  28 #include <config-nepomuk.h>
  29
  30 #include <kfileitemdelegate.h>
  31 #include <kio/fileundomanager.h>
  32 #include <ksortablelist.h>
  33 #include <kxmlguiwindow.h>
  34
  35 #include <QtCore/QList>
  36
  37 class KAction;
  38 class DolphinViewActionHandler;
  39 class DolphinApplication;
  40 class DolphinViewContainer;
  41 class KNewMenu;
  42 class KTabBar;
  43 class KUrl;
  44 class QSplitter;
  45
  46 /**
  47  * @short Main window for Dolphin.
  48  *
  49  * Handles the menus, toolbars and Dolphin views.
  50  */
  51 class DolphinMainWindow: public KXmlGuiWindow
  52 {
  53     Q_OBJECT
  54     Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow")
  55     Q_PROPERTY(int id READ getId SCRIPTABLE true)
  56     friend class DolphinApplication;
  57
  58 public:
  59     virtual ~DolphinMainWindow();
  60
  61     /**
  62      * Returns the currently active view.
  63      * All menu actions are applied to this view. When
  64      * having a split view setup, the nonactive view
  65      * is usually shown in darker colors.
  66      */
  67     DolphinViewContainer* activeViewContainer() const;
  68
  69     /**
  70      * Returns true, if the main window contains two instances
  71      * of a view container. The active view constainer can be
  72      * accessed by DolphinMainWindow::activeViewContainer().
  73      */
  74     bool isSplit() const;
  75
  76     /**
  77      * If the main window contains two instances of a view container
  78      * (DolphinMainWindow::isSplit() returns true), then the
  79      * two views get toggled (the right view is on the left, the left
  80      * view on the right).
  81      */
  82     void toggleViews();
  83
  84     /** Renames the item represented by \a oldUrl to \a newUrl. */
  85     void rename(const KUrl& oldUrl, const KUrl& newUrl);
  86
  87     /**
  88      * Refreshes the views of the main window by recreating them dependent from
  89      * the given Dolphin settings.
  90      */
  91     void refreshViews();
  92
  93     /**
  94      * Returns the 'Create New...' sub menu which also can be shared
  95      * with other menus (e. g. a context menu).
  96      */
  97     KNewMenu* newMenu() const;
  98
  99     /**
 100      * Returns the 'Show Menubar' action which can be shared with
 101      * other menus (e. g. a context menu).
 102      */
 103     KAction* showMenuBarAction() const;
 104
 105 public slots:
 106     /**
 107      * Handles the dropping of URLs to the given
 108      * destination. This is only called by the TreeViewSidebarPage.
 109      */
 110     void dropUrls(const KUrl::List& urls,
 111                   const KUrl& destination);
 112
 113     /**
 114      * Pastes the clipboard data into the currently selected folder
 115      * of the active view. If not exactly one folder is selected,
 116      * no pasting is done at all.
 117      */
 118     void pasteIntoFolder();
 119
 120     /**
 121      * Returns the main window ID used through DBus.
 122      */
 123     int getId() const;
 124
 125     /**
 126      * Inform all affected dolphin components (sidebars, views) of an URL
 127      * change.
 128      */
 129     void changeUrl(const KUrl& url);
 130
 131     /**
 132      * Inform all affected dolphin components that a selection change is
 133      * requested.
 134      */
 135     void changeSelection(const KFileItemList& selection);
 136
 137     /** Stores all settings and quits Dolphin. */
 138     void quit();
 139
 140 signals:
 141     /**
 142      * Is sent if the selection of the currently active view has
 143      * been changed.
 144      */
 145     void selectionChanged(const KFileItemList& selection);
 146
 147     /**
 148      * Is sent if the url of the currently active view has
 149      * been changed.
 150      */
 151     void urlChanged(const KUrl& url);
 152
 153     /**
 154      * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
 155      * If item is null, no item information request is pending.
 156      */
 157     void requestItemInfo(const KFileItem& item);
 158
 159 protected:
 160     /** @see QMainWindow::closeEvent() */
 161     virtual void closeEvent(QCloseEvent* event);
 162
 163     /** @see KMainWindow::saveProperties() */
 164     virtual void saveProperties(KConfigGroup& group);
 165
 166     /** @see KMainWindow::readProperties() */
 167     virtual void readProperties(const KConfigGroup& group);
 168
 169 private slots:
 170     void clearStatusBar();
 171
 172     /** Updates the 'Create New...' sub menu. */
 173     void updateNewMenu();
 174
 175     /**
 176      * Shows the error information from the places model
 177      * in the status bar.
 178      */
 179     void slotHandlePlacesError(const QString &message);
 180
 181     /**
 182      * Updates the state of the 'Undo' menu action dependent
 183      * from the parameter \a available.
 184      */
 185     void slotUndoAvailable(bool available);
 186
 187     /** Sets the text of the 'Undo' menu action to \a text. */
 188     void slotUndoTextChanged(const QString& text);
 189
 190     /** Performs the current undo operation. */
 191     void undo();
 192
 193     /**
 194      * Copies all selected items to the clipboard and marks
 195      * the items as cutted.
 196      */
 197     void cut();
 198
 199     /** Copies all selected items to the clipboard. */
 200     void copy();
 201
 202     /** Pastes the clipboard data to the active view. */
 203     void paste();
 204
 205     /**
 206      * Updates the text of the paste action dependent from
 207      * the number of items which are in the clipboard.
 208      */
 209     void updatePasteAction();
 210
 211     /** Selects all items from the active view. */
 212     void selectAll();
 213
 214     /**
 215      * Inverts the selection of all items of the active view:
 216      * Selected items get nonselected and nonselected items get
 217      * selected.
 218      */
 219     void invertSelection();
 220
 221     /**
 222      * Switches between one and two views:
 223      * If one view is visible, it will get split into two views.
 224      * If already two views are visible, the nonactivated view gets closed.
 225      */
 226     void toggleSplitView();
 227
 228     /** Reloads the current active view. */
 229     void reloadView();
 230
 231     /** Stops the loading process for the current active view. */
 232     void stopLoading();
 233
 234     /**
 235      * Toggles between showing and hiding of the filter bar
 236      */
 237     void toggleFilterBarVisibility(bool show);
 238
 239     /**
 240      * Toggles between edit and browse mode of the navigation bar.
 241      */
 242     void toggleEditLocation();
 243
 244     /**
 245      * Switches to the edit mode of the navigation bar. If the edit mode is
 246      * already active, it is assured that the navigation bar get focused.
 247      */
 248     void editLocation();
 249
 250     /** Goes back on step of the URL history. */
 251     void goBack();
 252
 253     /** Goes forward one step of the URL history. */
 254     void goForward();
 255
 256     /** Goes up one hierarchy of the current URL. */
 257     void goUp();
 258
 259     /** Goes to the home URL. */
 260     void goHome();
 261
 262     /** Opens Kompare for 2 selected files. */
 263     void compareFiles();
 264
 265     /**
 266      * Initiates a preview of the selected files
 267      * on the desktop by the Previewer plasmoid.
 268      */
 269     void quickView();
 270
 271     /**
 272      * Hides the menu bar if it is visible, makes the menu bar
 273      * visible if it is hidden.
 274      */
 275     void toggleShowMenuBar();
 276
 277     /** Opens the settings dialog for Dolphin. */
 278     void editSettings();
 279
 280     /** Updates the state of the 'Show Full Location' action. */
 281     void slotEditableStateChanged(bool editable);
 282
 283     /**
 284      * Updates the state of the 'Edit' menu actions and emits
 285      * the signal selectionChanged().
 286      */
 287     void slotSelectionChanged(const KFileItemList& selection);
 288
 289     /** Emits the signal requestItemInfo(). */
 290     void slotRequestItemInfo(const KFileItem&);
 291
 292     /**
 293      * Updates the state of the 'Back' and 'Forward' menu
 294      * actions corresponding the the current history.
 295      */
 296     void updateHistory();
 297
 298     /** Updates the state of the 'Show filter bar' menu action. */
 299     void updateFilterBarAction(bool show);
 300
 301     /** Open a new main window. */
 302     void openNewMainWindow();
 303
 304     /** Opens a new view with the current URL that is part of a tab. */
 305     void openNewTab();
 306
 307     /**
 308      * Opens a new tab showing the URL \a url.
 309      */
 310     void openNewTab(const KUrl& url);
 311
 312     /** Toggles the active view if two views are shown within the main window. */
 313     void toggleActiveView();
 314
 315     /** Called when the view is doing a file operation, like renaming, copying, moving etc. */
 316     void slotDoingOperation(KIO::FileUndoManager::CommandType type);
 317
 318     /**
 319      * Activates the tab with the index \a index, which means that the current view
 320      * is replaced by the view of the given tab.
 321      */
 322     void setActiveTab(int index);
 323
 324     /** Closes the currently active tab. */
 325     void closeTab();
 326
 327     /**
 328      * Closes the tab with the index \index and activates the tab with index - 1.
 329      */
 330     void closeTab(int index);
 331
 332     /**
 333      * Opens a context menu for the tab with the index \a index
 334      * on the position \a pos.
 335      */
 336     void openTabContextMenu(int index, const QPoint& pos);
 337
 338     /**
 339      * Handles a click on a places item: if the middle mouse button is
 340      * clicked, a new tab is opened for \a url, otherwise the current
 341      * view is replaced by \a url.
 342      */
 343     void handlePlacesClick(const KUrl& url, Qt::MouseButtons buttons);
 344
 345     /**
 346      * Is connected to the KTabBar signal testCanDecode() and adjusts
 347      * the output parameter \a accept.
 348      */
 349     void slotTestCanDecode(const QDragMoveEvent* event, bool& accept);
 350
 351 private:
 352     DolphinMainWindow(int id);
 353     void init();
 354
 355     /**
 356      * Activates the given view, which means that
 357      * all menu actions are applied to this view. When
 358      * having a split view setup, the nonactive view
 359      * is usually shown in darker colors.
 360      */
 361     void setActiveViewContainer(DolphinViewContainer* view);
 362
 363     void setupActions();
 364     void setupDockWidgets();
 365     void updateEditActions();
 366     void updateViewActions();
 367     void updateGoActions();
 368
 369     /**
 370      * Connects the signals from the created DolphinView with
 371      * the DolphinViewContainer \a container with the corresponding slots of
 372      * the DolphinMainWindow. This method must be invoked each
 373      * time a DolphinView has been created.
 374      */
 375     void connectViewSignals(DolphinViewContainer* container);
 376
 377     /**
 378      * Updates the text of the split action:
 379      * If two views are shown, the text is set to "Split",
 380      * otherwise the text is set to "Join". The icon
 381      * is updated to match with the text and the currently active view.
 382      */
 383     void updateSplitAction();
 384
 385     /** Returns the name of the tab for the URL \a url. */
 386     QString tabName(const KUrl& url) const;
 387
 388     bool isKompareInstalled() const;
 389
 390 private:
 391     /**
 392      * Implements a custom error handling for the undo manager. This
 393      * assures that all errors are shown in the status bar of Dolphin
 394      * instead as modal error dialog with an OK button.
 395      */
 396     class UndoUiInterface : public KIO::FileUndoManager::UiInterface
 397     {
 398     public:
 399         UndoUiInterface();
 400         virtual ~UndoUiInterface();
 401         virtual void jobError(KIO::Job* job);
 402     };
 403
 404     KNewMenu* m_newMenu;
 405     KAction* m_showMenuBar;
 406     KTabBar* m_tabBar;
 407     DolphinViewContainer* m_activeViewContainer;
 408     QVBoxLayout* m_centralWidgetLayout;
 409     int m_id;
 410
 411     struct ViewTab
 412     {
 413         ViewTab() : isPrimaryViewActive(true), primaryView(0), secondaryView(0), splitter(0) {}
 414         bool isPrimaryViewActive;
 415         DolphinViewContainer* primaryView;
 416         DolphinViewContainer* secondaryView;
 417         QSplitter* splitter;
 418     };
 419
 420     int m_tabIndex;
 421     QList<ViewTab> m_viewTab;
 422
 423     DolphinViewActionHandler* m_actionHandler;
 424
 425     /// remember pending undo operations until they are finished
 426     QList<KIO::FileUndoManager::CommandType> m_undoCommandTypes;
 427 };
 428
 429 inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
 430 {
 431     return m_activeViewContainer;
 432 }
 433
 434 inline bool DolphinMainWindow::isSplit() const
 435 {
 436     return m_viewTab[m_tabIndex].secondaryView != 0;
 437 }
 438
 439 inline KNewMenu* DolphinMainWindow::newMenu() const
 440 {
 441     return m_newMenu;
 442 }
 443
 444 inline KAction* DolphinMainWindow::showMenuBarAction() const
 445 {
 446     return m_showMenuBar;
 447 }
 448
 449 inline int DolphinMainWindow::getId() const
 450 {
 451     return m_id;
 452 }
 453
 454 #endif // DOLPHIN_MAINWINDOW_H
 455