src/dolphinmainwindow.h

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