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