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     /**
 100      * Returns the 'Create New...' sub menu which also can be shared
 101      * with other menus (e. g. a context menu).
 102      */
 103     KNewFileMenu* newFileMenu() const;
 104
 105 public slots:
 106     /**
 107      * Pastes the clipboard data into the currently selected folder
 108      * of the active view. If not exactly one folder is selected,
 109      * no pasting is done at all.
 110      */
 111     void pasteIntoFolder();
 112
 113     /**
 114      * Returns the main window ID used through DBus.
 115      */
 116     int getId() const;
 117
 118     /**
 119      * Implementation of the MainWindowAdaptor/QDBusAbstractAdaptor interface.
 120      * Inform all affected dolphin components (panels, views) of an URL
 121      * change.
 122      */
 123     void changeUrl(const KUrl& url);
 124
 125     /**
 126      * The current directory of the Terminal Panel has changed, probably because
 127      * the user entered a 'cd' command. This slot calls changeUrl(url) and makes
 128      * sure that the panel keeps the keyboard focus.
 129      */
 130     void slotTerminalDirectoryChanged(const KUrl& url);
 131
 132     /** Stores all settings and quits Dolphin. */
 133     void quit();
 134
 135 signals:
 136     /**
 137      * Is sent if the selection of the currently active view has
 138      * been changed.
 139      */
 140     void selectionChanged(const KFileItemList& selection);
 141
 142     /**
 143      * Is sent if the url of the currently active view has
 144      * been changed.
 145      */
 146     void urlChanged(const KUrl& url);
 147
 148     /**
 149      * Is emitted if information of an item is requested to be shown e. g. in the panel.
 150      * If item is null, no item information request is pending.
 151      */
 152     void requestItemInfo(const KFileItem& item);
 153
 154 protected:
 155     /** @see QWidget::showEvent() */
 156     virtual void showEvent(QShowEvent* event);
 157
 158     /** @see QMainWindow::closeEvent() */
 159     virtual void closeEvent(QCloseEvent* event);
 160
 161     /** @see KMainWindow::saveProperties() */
 162     virtual void saveProperties(KConfigGroup& group);
 163
 164     /** @see KMainWindow::readProperties() */
 165     virtual void readProperties(const KConfigGroup& group);
 166
 167 private slots:
 168     /**
 169      * Refreshes the views of the main window by recreating them according to
 170      * the given Dolphin settings.
 171      */
 172     void refreshViews();
 173
 174     void clearStatusBar();
 175
 176     /** Updates the 'Create New...' sub menu. */
 177     void updateNewMenu();
 178
 179     void createDirectory();
 180
 181     /** Shows the error message in the status bar of the active view. */
 182     void showErrorMessage(const QString& message);
 183
 184     /**
 185      * Updates the state of the 'Undo' menu action dependent
 186      * on the parameter \a available.
 187      */
 188     void slotUndoAvailable(bool available);
 189
 190     /** Invoked when an action in the recent tabs menu is clicked. */
 191     void restoreClosedTab(QAction* action);
 192
 193     /** Sets the text of the 'Undo' menu action to \a text. */
 194     void slotUndoTextChanged(const QString& text);
 195
 196     /** Performs the current undo operation. */
 197     void undo();
 198
 199     /**
 200      * Copies all selected items to the clipboard and marks
 201      * the items as cut.
 202      */
 203     void cut();
 204
 205     /** Copies all selected items to the clipboard. */
 206     void copy();
 207
 208     /** Pastes the clipboard data to the active view. */
 209     void paste();
 210
 211     /** Replaces the URL navigator by a search box to find files. */
 212     void find();
 213
 214     /**
 215      * Updates the text of the paste action dependent on
 216      * the number of items which are in the clipboard.
 217      */
 218     void updatePasteAction();
 219
 220     /** Selects all items from the active view. */
 221     void selectAll();
 222
 223     /**
 224      * Inverts the selection of all items of the active view:
 225      * Selected items get nonselected and nonselected items get
 226      * selected.
 227      */
 228     void invertSelection();
 229
 230     /**
 231      * Switches between one and two views:
 232      * If one view is visible, it will get split into two views.
 233      * If already two views are visible, the active view gets closed.
 234      */
 235     void toggleSplitView();
 236
 237     /** Reloads the currently active view. */
 238     void reloadView();
 239
 240     /** Stops the loading process for the currently active view. */
 241     void stopLoading();
 242
 243     void enableStopAction();
 244     void disableStopAction();
 245
 246     void showFilterBar();
 247
 248     /**
 249      * Toggles between edit and browse mode of the navigation bar.
 250      */
 251     void toggleEditLocation();
 252
 253     /**
 254      * Switches to the edit mode of the navigation bar and selects
 255      * the whole URL, so that it can be replaced by the user. If the edit mode is
 256      * already active, it is assured that the navigation bar get focused.
 257      */
 258     void replaceLocation();
 259
 260     /**
 261      * Toggles the state of the panels between a locked and unlocked layout.
 262      */
 263     void togglePanelLockState();
 264
 265     /**
 266      * Is invoked if the Places panel got visible/invisible and takes care
 267      * that the places-selector of all views is only shown if the Places panel
 268      * is invisible.
 269      */
 270     void slotPlacesPanelVisibilityChanged(bool visible);
 271
 272     /** Goes back one step of the URL history. */
 273     void goBack();
 274
 275     /** Goes forward one step of the URL history. */
 276     void goForward();
 277
 278     /** Goes up one hierarchy of the current URL. */
 279     void goUp();
 280
 281     /** Changes the location to the home URL. */
 282     void goHome();
 283
 284     /**
 285      * Open the previous URL in the URL history in a new tab
 286      * if the middle mouse button is clicked.
 287      */
 288     void goBack(Qt::MouseButtons buttons);
 289
 290     /**
 291      * Open the next URL in the URL history in a new tab
 292      * if the middle mouse button is clicked.
 293      */
 294     void goForward(Qt::MouseButtons buttons);
 295
 296     /**
 297      * Open the URL one hierarchy above the current URL in a new tab
 298      * if the middle mouse button is clicked.
 299      */
 300     void goUp(Qt::MouseButtons buttons);
 301
 302     /**
 303      * Open the home URL in a new tab
 304      */
 305     void goHome(Qt::MouseButtons buttons);
 306
 307     /** Opens Kompare for 2 selected files. */
 308     void compareFiles();
 309
 310     /**
 311      * Hides the menu bar if it is visible, makes the menu bar
 312      * visible if it is hidden.
 313      */
 314     void toggleShowMenuBar();
 315
 316     /** Opens a terminal window for the current location. */
 317     void openTerminal();
 318
 319     /** Opens the settings dialog for Dolphin. */
 320     void editSettings();
 321
 322     /** Updates the state of the 'Show Full Location' action. */
 323     void slotEditableStateChanged(bool editable);
 324
 325     /**
 326      * Updates the state of the 'Edit' menu actions and emits
 327      * the signal selectionChanged().
 328      */
 329     void slotSelectionChanged(const KFileItemList& selection);
 330
 331     /** Emits the signal requestItemInfo(). */
 332     void slotRequestItemInfo(const KFileItem&);
 333
 334     /**
 335      * Updates the state of the 'Back' and 'Forward' menu
 336      * actions corresponding to the current history.
 337      */
 338     void updateHistory();
 339
 340     /** Updates the state of the 'Show filter bar' menu action. */
 341     void updateFilterBarAction(bool show);
 342
 343     /** Open a new main window. */
 344     void openNewMainWindow();
 345
 346     /** Opens a new view with the current URL that is part of a tab. */
 347     void openNewTab();
 348
 349     /**
 350      * Opens a new tab in the background showing the URL \a url.
 351      */
 352     void openNewTab(const KUrl& url);
 353
 354     /**
 355      * Opens a new tab showing the URL \a url and activates
 356      * the tab.
 357      */
 358     void openNewActivatedTab(const KUrl& url);
 359
 360     void activateNextTab();
 361
 362     void activatePrevTab();
 363
 364     /**
 365      * Opens the selected folder in a new tab.
 366      */
 367     void openInNewTab();
 368
 369     /**
 370      * Opens the selected folder in a new window.
 371      */
 372     void openInNewWindow();
 373
 374     /** Toggles the active view if two views are shown within the main window. */
 375     void toggleActiveView();
 376
 377     /**
 378      * Indicates in the statusbar that the execution of the command \a command
 379      * has been finished.
 380      */
 381     void showCommand(CommandType command);
 382
 383     /**
 384      * Activates the tab with the index \a index, which means that the current view
 385      * is replaced by the view of the given tab.
 386      */
 387     void setActiveTab(int index);
 388
 389     /** Closes the currently active tab. */
 390     void closeTab();
 391
 392     /**
 393      * Closes the tab with the index \a index and activates the tab with index - 1.
 394      */
 395     void closeTab(int index);
 396
 397     /**
 398      * Opens a context menu for the tab with the index \a index
 399      * on the position \a pos.
 400      */
 401     void openTabContextMenu(int index, const QPoint& pos);
 402
 403     /**
 404      * Is connected to the QTabBar signal tabMoved(int from, int to).
 405      * Reorders the list of tabs after a tab was moved in the tab bar
 406      * and sets m_tabIndex to the new index of the current tab.
 407      */
 408     void slotTabMoved(int from, int to);
 409
 410     /**
 411      * Is connected to the KTabBar signal testCanDecode() and adjusts
 412      * the output parameter \a accept.
 413      */
 414     void slotTestCanDecode(const QDragMoveEvent* event, bool& accept);
 415
 416     /**
 417      * If the URL can be listed, open it in the current view, otherwise
 418      * run it through KRun.
 419      */
 420     void handleUrl(const KUrl& url);
 421
 422     /**
 423      * handleUrl() can trigger a stat job to see if the url can actually
 424      * be listed.
 425      */
 426     void slotHandleUrlStatFinished(KJob* job);
 427
 428     /**
 429      * Is connected to the KTabBar signal receivedDropEvent.
 430      * Allows dragging and dropping files onto tabs.
 431      */
 432     void tabDropEvent(int tab, QDropEvent* event);
 433
 434     /**
 435      * Is invoked when the write state of a folder has been changed and
 436      * enables/disables the "Create New..." menu entry.
 437      */
 438     void slotWriteStateChanged(bool isFolderWritable);
 439
 440     /**
 441      * Opens the context menu on the current mouse position.
 442      * @pos           Position in screen coordinates.
 443      * @item          File item context. If item is null, the context menu
 444      *                should be applied to \a url.
 445      * @url           URL which contains \a item.
 446      * @customActions Actions that should be added to the context menu,
 447      *                if the file item is null.
 448      */
 449     void openContextMenu(const QPoint& pos,
 450                          const KFileItem& item,
 451                          const KUrl& url,
 452                          const QList<QAction*>& customActions);
 453
 454     void updateControlMenu();
 455     void updateToolBar();
 456     void slotControlButtonDeleted();
 457
 458     /**
 459      * Is called if a panel emits an error-message and shows
 460      * the error-message in the active view-container.
 461      */
 462     void slotPanelErrorMessage(const QString& error);
 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 inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
 594 {
 595     return m_activeViewContainer;
 596 }
 597
 598 inline bool DolphinMainWindow::isSplit() const
 599 {
 600     return m_viewTab[m_tabIndex].secondaryView != 0;
 601 }
 602
 603 inline KNewFileMenu* DolphinMainWindow::newFileMenu() const
 604 {
 605     return m_newFileMenu;
 606 }
 607
 608 inline int DolphinMainWindow::getId() const
 609 {
 610     return m_id;
 611 }
 612
 613 #endif // DOLPHIN_MAINWINDOW_H
 614