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 "panels/panel.h"
  26
  27 #include <config-nepomuk.h>
  28
  29 #include <kfileitemdelegate.h>
  30 #include <kio/fileundomanager.h>
  31 #include <ksortablelist.h>
  32 #include <kxmlguiwindow.h>
  33 #include <kactionmenu.h>
  34
  35 #include "views/dolphinview.h"
  36
  37 #include <QList>
  38
  39 typedef KIO::FileUndoManager::CommandType CommandType;
  40
  41 class KAction;
  42 class DolphinViewActionHandler;
  43 class DolphinApplication;
  44 class DolphinSettingsDialog;
  45 class DolphinViewContainer;
  46 class DolphinRemoteEncoding;
  47 class KNewFileMenu;
  48 class KTabBar;
  49 class KUrl;
  50 class QSplitter;
  51 class KJob;
  52
  53 /**
  54  * @short Main window for Dolphin.
  55  *
  56  * Handles the menus, toolbars and Dolphin views.
  57  */
  58 class DolphinMainWindow: public KXmlGuiWindow
  59 {
  60     Q_OBJECT
  61     Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow")
  62     Q_PROPERTY(int id READ getId SCRIPTABLE true)
  63     friend class DolphinApplication;
  64
  65 public:
  66     virtual ~DolphinMainWindow();
  67
  68     /**
  69      * Returns the currently active view.
  70      * All menu actions are applied to this view. When
  71      * having a split view setup, the nonactive view
  72      * is usually shown in darker colors.
  73      */
  74     DolphinViewContainer* activeViewContainer() const;
  75
  76     /**
  77      * Opens each directory \p in a separate tab. If the "split view"
  78      * option is enabled, 2 directories are collected within one tab.
  79      */
  80     void openDirectories(const QList<KUrl>& dirs);
  81
  82     /**
  83      * Opens the directory which contains the files \p files
  84      * and selects all files (implements the --select option
  85      * of Dolphin).
  86      */
  87     void openFiles(const QList<KUrl>& files);
  88
  89     /**
  90      * Returns true, if the main window contains two instances
  91      * of a view container. The active view constainer can be
  92      * accessed by DolphinMainWindow::activeViewContainer().
  93      */
  94     bool isSplit() const;
  95
  96     /**
  97      * If the main window contains two instances of a view container
  98      * (DolphinMainWindow::isSplit() returns true), then the
  99      * two views get toggled (the right view is on the left, the left
 100      * view on the right).
 101      */
 102     void toggleViews();
 103
 104     /** Renames the item represented by \a oldUrl to \a newUrl. */
 105     void rename(const KUrl& oldUrl, const KUrl& newUrl);
 106
 107     /**
 108      * Refreshes the views of the main window by recreating them dependent from
 109      * the given Dolphin settings.
 110      */
 111     void refreshViews();
 112
 113     /**
 114      * Returns the 'Create New...' sub menu which also can be shared
 115      * with other menus (e. g. a context menu).
 116      */
 117     KNewFileMenu* newFileMenu() const;
 118
 119     /**
 120      * Returns the 'Show Menubar' action which can be shared with
 121      * other menus (e. g. a context menu).
 122      */
 123     KAction* showMenuBarAction() const;
 124
 125 public slots:
 126     /**
 127      * Pastes the clipboard data into the currently selected folder
 128      * of the active view. If not exactly one folder is selected,
 129      * no pasting is done at all.
 130      */
 131     void pasteIntoFolder();
 132
 133     /**
 134      * Returns the main window ID used through DBus.
 135      */
 136     int getId() const;
 137
 138     /**
 139      * Implementation of the MainWindowAdaptor/QDBusAbstractAdaptor interface.
 140      * Inform all affected dolphin components (panels, views) of an URL
 141      * change.
 142      */
 143     void changeUrl(const KUrl& url);
 144
 145     /** Stores all settings and quits Dolphin. */
 146     void quit();
 147
 148 signals:
 149     /**
 150      * Is sent if the selection of the currently active view has
 151      * been changed.
 152      */
 153     void selectionChanged(const KFileItemList& selection);
 154
 155     /**
 156      * Is sent if the url of the currently active view has
 157      * been changed.
 158      */
 159     void urlChanged(const KUrl& url);
 160
 161     /**
 162      * Is emitted if information of an item is requested to be shown e. g. in the panel.
 163      * If item is null, no item information request is pending.
 164      */
 165     void requestItemInfo(const KFileItem& item);
 166
 167 protected:
 168     /** @see QWidget::showEvent() */
 169     virtual void showEvent(QShowEvent* event);
 170
 171     /** @see QMainWindow::closeEvent() */
 172     virtual void closeEvent(QCloseEvent* event);
 173
 174     /** @see KMainWindow::saveProperties() */
 175     virtual void saveProperties(KConfigGroup& group);
 176
 177     /** @see KMainWindow::readProperties() */
 178     virtual void readProperties(const KConfigGroup& group);
 179
 180 private slots:
 181     void clearStatusBar();
 182
 183     /** Updates the 'Create New...' sub menu. */
 184     void updateNewMenu();
 185
 186     void createDirectory();
 187
 188     /** Shows the error message in the status bar of the active view. */
 189     void showErrorMessage(const QString& message);
 190
 191     /**
 192      * Updates the state of the 'Undo' menu action dependent
 193      * from the parameter \a available.
 194      */
 195     void slotUndoAvailable(bool available);
 196
 197     /** Invoked when an action in the recent tabs menu is clicked. */
 198     void restoreClosedTab(QAction* action);
 199
 200     /** Sets the text of the 'Undo' menu action to \a text. */
 201     void slotUndoTextChanged(const QString& text);
 202
 203     /** Performs the current undo operation. */
 204     void undo();
 205
 206     /**
 207      * Copies all selected items to the clipboard and marks
 208      * the items as cut.
 209      */
 210     void cut();
 211
 212     /** Copies all selected items to the clipboard. */
 213     void copy();
 214
 215     /** Pastes the clipboard data to the active view. */
 216     void paste();
 217
 218     /** Replaces the URL navigator by a search box to find files. */
 219     void find();
 220
 221     /**
 222      * Updates the text of the paste action dependent from
 223      * the number of items which are in the clipboard.
 224      */
 225     void updatePasteAction();
 226
 227     /** Selects all items from the active view. */
 228     void selectAll();
 229
 230     /**
 231      * Inverts the selection of all items of the active view:
 232      * Selected items get nonselected and nonselected items get
 233      * selected.
 234      */
 235     void invertSelection();
 236
 237     /**
 238      * Switches between one and two views:
 239      * If one view is visible, it will get split into two views.
 240      * If already two views are visible, the nonactivated view gets closed.
 241      */
 242     void toggleSplitView();
 243
 244     /** Reloads the current active view. */
 245     void reloadView();
 246
 247     /** Stops the loading process for the current active view. */
 248     void stopLoading();
 249
 250     void enableStopAction();
 251     void disableStopAction();
 252
 253     void showFilterBar();
 254
 255     /**
 256      * Toggles between edit and browse mode of the navigation bar.
 257      */
 258     void toggleEditLocation();
 259
 260     /**
 261      * Switches to the edit mode of the navigation bar and selects
 262      * the whole URL, so that it can be replaced by the user. If the edit mode is
 263      * already active, it is assured that the navigation bar get focused.
 264      */
 265     void replaceLocation();
 266
 267     /** Goes back on step of the URL history. */
 268     void goBack();
 269
 270     /** Goes forward one step of the URL history. */
 271     void goForward();
 272
 273     /** Goes up one hierarchy of the current URL. */
 274     void goUp();
 275
 276     /**
 277      * Open the previous URL in the URL history in a new tab
 278      * if the middle mouse button is clicked.
 279      */
 280     void goBack(Qt::MouseButtons buttons);
 281
 282     /**
 283      * Open the next URL in the URL history in a new tab
 284      * if the middle mouse button is clicked.
 285      */
 286     void goForward(Qt::MouseButtons buttons);
 287
 288     /**
 289      * Open the URL one hierarchy above the current URL in a new tab
 290      * if the middle mouse button is clicked.
 291      */
 292     void goUp(Qt::MouseButtons buttons);
 293
 294     /** Goes to the home URL. */
 295     void goHome();
 296
 297     /** Opens Kompare for 2 selected files. */
 298     void compareFiles();
 299
 300     /**
 301      * Hides the menu bar if it is visible, makes the menu bar
 302      * visible if it is hidden.
 303      */
 304     void toggleShowMenuBar();
 305
 306     /** Opens a terminal window for the current location. */
 307     void openTerminal();
 308
 309     /** Opens the settings dialog for Dolphin. */
 310     void editSettings();
 311
 312     /** Updates the state of the 'Show Full Location' action. */
 313     void slotEditableStateChanged(bool editable);
 314
 315     /**
 316      * Updates the state of the 'Edit' menu actions and emits
 317      * the signal selectionChanged().
 318      */
 319     void slotSelectionChanged(const KFileItemList& selection);
 320
 321     /** Emits the signal requestItemInfo(). */
 322     void slotRequestItemInfo(const KFileItem&);
 323
 324     /**
 325      * Updates the state of the 'Back' and 'Forward' menu
 326      * actions corresponding to the current history.
 327      */
 328     void updateHistory();
 329
 330     /** Updates the state of the 'Show filter bar' menu action. */
 331     void updateFilterBarAction(bool show);
 332
 333     /** Open a new main window. */
 334     void openNewMainWindow();
 335
 336     /** Opens a new view with the current URL that is part of a tab. */
 337     void openNewTab();
 338
 339     /**
 340      * Opens a new tab showing the URL \a url.
 341      */
 342     void openNewTab(const KUrl& url);
 343
 344     void activateNextTab();
 345
 346     void activatePrevTab();
 347
 348     /**
 349      * Opens the selected folder in a new tab.
 350      */
 351     void openInNewTab();
 352
 353     /**
 354      * Opens the selected folder in a new window.
 355      */
 356     void openInNewWindow();
 357
 358     /** Toggles the active view if two views are shown within the main window. */
 359     void toggleActiveView();
 360
 361     /**
 362      * Indicates in the statusbar that the execution of the command \a command
 363      * has been finished.
 364      */
 365     void showCommand(CommandType command);
 366
 367     /**
 368      * Activates the tab with the index \a index, which means that the current view
 369      * is replaced by the view of the given tab.
 370      */
 371     void setActiveTab(int index);
 372
 373     /** Closes the currently active tab. */
 374     void closeTab();
 375
 376     /**
 377      * Closes the tab with the index \index and activates the tab with index - 1.
 378      */
 379     void closeTab(int index);
 380
 381     /**
 382      * Opens a context menu for the tab with the index \a index
 383      * on the position \a pos.
 384      */
 385     void openTabContextMenu(int index, const QPoint& pos);
 386
 387     /**
 388      * Is connected to the QTabBar signal tabMoved(int from, int to).
 389      * Reorders the list of tabs after a tab was moved in the tab bar
 390      * and sets m_tabIndex to the new index of the current tab.
 391      */
 392     void slotTabMoved(int from, int to);
 393
 394     /**
 395      * Handles a click on a places item: if the middle mouse button is
 396      * clicked, a new tab is opened for \a url, otherwise the current
 397      * view is replaced by \a url.
 398      */
 399     void handlePlacesClick(const KUrl& url, Qt::MouseButtons buttons);
 400
 401     /**
 402      * Is connected to the KTabBar signal testCanDecode() and adjusts
 403      * the output parameter \a accept.
 404      */
 405     void slotTestCanDecode(const QDragMoveEvent* event, bool& accept);
 406
 407     /**
 408      * If the URL can be listed open it in the current view, otherwise
 409      * run it through KRun.
 410      */
 411     void handleUrl(const KUrl& url);
 412
 413     /**
 414      * handleUrl() can trigger a stat job to see if the url can actually
 415      * be listed.
 416      */
 417     void slotHandleUrlStatFinished(KJob* job);
 418
 419     /**
 420      * Is connected to the KTabBar signal receivedDropEvent.
 421      * Allows dragging and dropping files onto tabs.
 422      */
 423     void tabDropEvent(int tab, QDropEvent* event);
 424
 425     /**
 426      * Is invoked when the write state of a folder has been changed and
 427      * enables/disables the "Create New..." menu entry.
 428      */
 429     void slotWriteStateChanged(bool isFolderWritable);
 430
 431     void slotSearchModeChanged(bool enabled);
 432
 433     /**
 434      * Opens the context menu on the current mouse position.
 435      * @item          File item context. If item is null, the context menu
 436      *                should be applied to \a url.
 437      * @url           URL which contains \a item.
 438      * @customActions Actions that should be added to the context menu,
 439      *                if the file item is null.
 440      */
 441     void openContextMenu(const KFileItem& item,
 442                          const KUrl& url,
 443                          const QList<QAction*>& customActions);
 444
 445 private:
 446     DolphinMainWindow(int id);
 447     void init();
 448
 449     /**
 450      * Activates the given view, which means that
 451      * all menu actions are applied to this view. When
 452      * having a split view setup, the nonactive view
 453      * is usually shown in darker colors.
 454      */
 455     void setActiveViewContainer(DolphinViewContainer* view);
 456
 457     void setupActions();
 458     void setupDockWidgets();
 459     void updateEditActions();
 460     void updateViewActions();
 461     void updateGoActions();
 462
 463     /**
 464      * Adds the tab[\a index] to the closed tab menu's list of actions.
 465      */
 466     void rememberClosedTab(int index);
 467
 468     /**
 469      * Connects the signals from the created DolphinView with
 470      * the DolphinViewContainer \a container with the corresponding slots of
 471      * the DolphinMainWindow. This method must be invoked each
 472      * time a DolphinView has been created.
 473      */
 474     void connectViewSignals(DolphinViewContainer* container);
 475
 476     /**
 477      * Updates the text of the split action:
 478      * If two views are shown, the text is set to "Split",
 479      * otherwise the text is set to "Join". The icon
 480      * is updated to match with the text and the currently active view.
 481      */
 482     void updateSplitAction();
 483
 484     /** Returns the name of the tab for the URL \a url. */
 485     QString tabName(const KUrl& url) const;
 486
 487     bool isKompareInstalled() const;
 488
 489     void createSecondaryView(int tabIndex);
 490
 491     /**
 492      * Helper method for saveProperties() and readProperties(): Returns
 493      * the property string for a tab with the index \a tabIndex and
 494      * the property \a property.
 495      */
 496     QString tabProperty(const QString& property, int tabIndex) const;
 497
 498     /**
 499      * Sets the window caption to url.fileName() if this is non-empty,
 500      * "/" if the URL is "file:///", and url.protocol() otherwise.
 501      */
 502     void setUrlAsCaption(const KUrl& url);
 503
 504     QString squeezedText(const QString& text) const;
 505
 506 private:
 507     /**
 508      * Implements a custom error handling for the undo manager. This
 509      * assures that all errors are shown in the status bar of Dolphin
 510      * instead as modal error dialog with an OK button.
 511      */
 512     class UndoUiInterface : public KIO::FileUndoManager::UiInterface
 513     {
 514     public:
 515         UndoUiInterface();
 516         virtual ~UndoUiInterface();
 517         virtual void jobError(KIO::Job* job);
 518     };
 519
 520     KNewFileMenu* m_newFileMenu;
 521     KActionMenu* m_recentTabsMenu;
 522     KAction* m_showMenuBar;
 523     KTabBar* m_tabBar;
 524     DolphinViewContainer* m_activeViewContainer;
 525     QVBoxLayout* m_centralWidgetLayout;
 526     int m_id;
 527
 528     struct ViewTab
 529     {
 530         ViewTab() : isPrimaryViewActive(true), primaryView(0), secondaryView(0), splitter(0) {}
 531         bool isPrimaryViewActive;
 532         DolphinViewContainer* primaryView;
 533         DolphinViewContainer* secondaryView;
 534         QSplitter* splitter;
 535     };
 536
 537     int m_tabIndex;
 538     QList<ViewTab> m_viewTab;
 539
 540     DolphinViewActionHandler* m_actionHandler;
 541     DolphinRemoteEncoding* m_remoteEncoding;
 542     QPointer<DolphinSettingsDialog> m_settingsDialog;
 543
 544     KJob* m_lastHandleUrlStatJob;
 545
 546     /**
 547      * Set to true, if the filter dock visibility is only temporary set
 548      * to true by enabling the search mode.
 549      */
 550     bool m_filterDockIsTemporaryVisible;
 551 };
 552
 553 inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
 554 {
 555     return m_activeViewContainer;
 556 }
 557
 558 inline bool DolphinMainWindow::isSplit() const
 559 {
 560     return m_viewTab[m_tabIndex].secondaryView != 0;
 561 }
 562
 563 inline KNewFileMenu* DolphinMainWindow::newFileMenu() const
 564 {
 565     return m_newFileMenu;
 566 }
 567
 568 inline KAction* DolphinMainWindow::showMenuBarAction() const
 569 {
 570     return m_showMenuBar;
 571 }
 572
 573 inline int DolphinMainWindow::getId() const
 574 {
 575     return m_id;
 576 }
 577
 578 #endif // DOLPHIN_MAINWINDOW_H
 579