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-baloo.h>
  26
  27 #include <kio/fileundomanager.h>
  28 #include <ksortablelist.h>
  29 #include <kxmlguiwindow.h>
  30 #include <QIcon>
  31 #include <QUrl>
  32
  33 #include <QList>
  34 #include <QWeakPointer>
  35
  36 typedef KIO::FileUndoManager::CommandType CommandType;
  37
  38 class DolphinViewActionHandler;
  39 class DolphinApplication;
  40 class DolphinSettingsDialog;
  41 class DolphinViewContainer;
  42 class DolphinRemoteEncoding;
  43 class DolphinTabWidget;
  44 class KFileItem;
  45 class KFileItemList;
  46 class KJob;
  47 class KNewFileMenu;
  48 class QToolButton;
  49 class QIcon;
  50
  51 /**
  52  * @short Main window for Dolphin.
  53  *
  54  * Handles the menus, toolbars and Dolphin views.
  55  */
  56 class DolphinMainWindow: public KXmlGuiWindow
  57 {
  58     Q_OBJECT
  59     Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow")
  60     Q_PROPERTY(int id READ getId SCRIPTABLE true)
  61     friend class DolphinApplication;
  62
  63 public:
  64     DolphinMainWindow();
  65     virtual ~DolphinMainWindow();
  66
  67     /**
  68      * Returns the currently active view.
  69      * All menu actions are applied to this view. When
  70      * having a split view setup, the nonactive view
  71      * is usually shown in darker colors.
  72      */
  73     DolphinViewContainer* activeViewContainer() const;
  74
  75     /**
  76      * Opens each directory in \p dirs in a separate tab. If the "split view"
  77      * option is enabled, 2 directories are collected within one tab.
  78      */
  79     void openDirectories(const QList<QUrl> &dirs);
  80
  81     /**
  82      * Opens the directory which contains the files \p files
  83      * and selects all files (implements the --select option
  84      * of Dolphin).
  85      */
  86     void openFiles(const QList<QUrl>& files);
  87
  88     /**
  89      * Returns the 'Create New...' sub menu which also can be shared
  90      * with other menus (e. g. a context menu).
  91      */
  92     KNewFileMenu* newFileMenu() const;
  93
  94 public slots:
  95     /**
  96      * Pastes the clipboard data into the currently selected folder
  97      * of the active view. If not exactly one folder is selected,
  98      * no pasting is done at all.
  99      */
 100     void pasteIntoFolder();
 101
 102     /**
 103      * Returns the main window ID used through DBus.
 104      */
 105     int getId() const;
 106
 107     /**
 108      * Implementation of the MainWindowAdaptor/QDBusAbstractAdaptor interface.
 109      * Inform all affected dolphin components (panels, views) of an URL
 110      * change.
 111      */
 112     void changeUrl(const QUrl& url);
 113
 114     /**
 115      * The current directory of the Terminal Panel has changed, probably because
 116      * the user entered a 'cd' command. This slot calls changeUrl(url) and makes
 117      * sure that the panel keeps the keyboard focus.
 118      */
 119     void slotTerminalDirectoryChanged(const QUrl& url);
 120
 121     /** Stores all settings and quits Dolphin. */
 122     void quit();
 123
 124 signals:
 125     /**
 126      * Is sent if the selection of the currently active view has
 127      * been changed.
 128      */
 129     void selectionChanged(const KFileItemList& selection);
 130
 131     /**
 132      * Is sent if the url of the currently active view has
 133      * been changed.
 134      */
 135     void urlChanged(const QUrl& url);
 136
 137     /**
 138      * Is emitted if information of an item is requested to be shown e. g. in the panel.
 139      * If item is null, no item information request is pending.
 140      */
 141     void requestItemInfo(const KFileItem& item);
 142
 143     /**
 144      * Is emitted if the settings have been changed.
 145      */
 146     void settingsChanged();
 147
 148 protected:
 149     /** @see QWidget::showEvent() */
 150     virtual void showEvent(QShowEvent* event) Q_DECL_OVERRIDE;
 151
 152     /** @see QMainWindow::closeEvent() */
 153     virtual void closeEvent(QCloseEvent* event) Q_DECL_OVERRIDE;
 154
 155     /** @see KMainWindow::saveProperties() */
 156     virtual void saveProperties(KConfigGroup& group) Q_DECL_OVERRIDE;
 157
 158     /** @see KMainWindow::readProperties() */
 159     virtual void readProperties(const KConfigGroup& group) Q_DECL_OVERRIDE;
 160
 161 private slots:
 162     /**
 163      * Refreshes the views of the main window by recreating them according to
 164      * the given Dolphin settings.
 165      */
 166     void refreshViews();
 167
 168     void clearStatusBar();
 169
 170     /** Updates the 'Create New...' sub menu. */
 171     void updateNewMenu();
 172
 173     void createDirectory();
 174
 175     /** Shows the error message in the status bar of the active view. */
 176     void showErrorMessage(const QString& message);
 177
 178     /**
 179      * Updates the state of the 'Undo' menu action dependent
 180      * on the parameter \a available.
 181      */
 182     void slotUndoAvailable(bool available);
 183
 184     /** Sets the text of the 'Undo' menu action to \a text. */
 185     void slotUndoTextChanged(const QString& text);
 186
 187     /** Performs the current undo operation. */
 188     void undo();
 189
 190     /**
 191      * Copies all selected items to the clipboard and marks
 192      * the items as cut.
 193      */
 194     void cut();
 195
 196     /** Copies all selected items to the clipboard. */
 197     void copy();
 198
 199     /** Pastes the clipboard data to the active view. */
 200     void paste();
 201
 202     /** Replaces the URL navigator by a search box to find files. */
 203     void find();
 204
 205     /**
 206      * Updates the text of the paste action dependent on
 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 active view gets closed.
 225      */
 226     void toggleSplitView();
 227
 228     /** Reloads the currently active view. */
 229     void reloadView();
 230
 231     /** Stops the loading process for the currently active view. */
 232     void stopLoading();
 233
 234     void enableStopAction();
 235     void disableStopAction();
 236
 237     void showFilterBar();
 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 and selects
 246      * the whole URL, so that it can be replaced by the user. If the edit mode is
 247      * already active, it is assured that the navigation bar get focused.
 248      */
 249     void replaceLocation();
 250
 251     /**
 252      * Toggles the state of the panels between a locked and unlocked layout.
 253      */
 254     void togglePanelLockState();
 255
 256     /** Goes back one step of the URL history. */
 257     void goBack();
 258
 259     /** Goes forward one step of the URL history. */
 260     void goForward();
 261
 262     /** Goes up one hierarchy of the current URL. */
 263     void goUp();
 264
 265     /** Changes the location to the home URL. */
 266     void goHome();
 267
 268     /**
 269      * Open the previous URL in the URL history in a new tab
 270      * if the middle mouse button is clicked.
 271      */
 272     void goBack(Qt::MouseButtons buttons);
 273
 274     /**
 275      * Open the next URL in the URL history in a new tab
 276      * if the middle mouse button is clicked.
 277      */
 278     void goForward(Qt::MouseButtons buttons);
 279
 280     /**
 281      * Open the URL one hierarchy above the current URL in a new tab
 282      * if the middle mouse button is clicked.
 283      */
 284     void goUp(Qt::MouseButtons buttons);
 285
 286     /**
 287      * Open the home URL in a new tab
 288      */
 289     void goHome(Qt::MouseButtons buttons);
 290
 291     /** Opens Kompare for 2 selected files. */
 292     void compareFiles();
 293
 294     /**
 295      * Hides the menu bar if it is visible, makes the menu bar
 296      * visible if it is hidden.
 297      */
 298     void toggleShowMenuBar();
 299
 300     /** Opens a terminal window for the current location. */
 301     void openTerminal();
 302
 303     /** Opens the settings dialog for Dolphin. */
 304     void editSettings();
 305
 306     /** Updates the state of the 'Show Full Location' action. */
 307     void slotEditableStateChanged(bool editable);
 308
 309     /**
 310      * Updates the state of the 'Edit' menu actions and emits
 311      * the signal selectionChanged().
 312      */
 313     void slotSelectionChanged(const KFileItemList& selection);
 314
 315     /**
 316      * Updates the state of the 'Back' and 'Forward' menu
 317      * actions corresponding to the current history.
 318      */
 319     void updateHistory();
 320
 321     /** Updates the state of the 'Show filter bar' menu action. */
 322     void updateFilterBarAction(bool show);
 323
 324     /** Open a new main window. */
 325     void openNewMainWindow();
 326
 327     /**
 328      * Opens a new view with the current URL that is part of a tab and
 329      * activates it.
 330      */
 331     void openNewActivatedTab();
 332
 333     /**
 334      * Opens a new tab in the background showing the URL \a url.
 335      */
 336     void openNewTab(const QUrl& url);
 337
 338     /**
 339      * Opens a new tab showing the URL \a url and activates the tab.
 340      */
 341     void openNewActivatedTab(const QUrl& url);
 342
 343     /**
 344      * Opens the selected folder in a new tab.
 345      */
 346     void openInNewTab();
 347
 348     /**
 349      * Opens the selected folder in a new window.
 350      */
 351     void openInNewWindow();
 352
 353     /**
 354      * Indicates in the statusbar that the execution of the command \a command
 355      * has been finished.
 356      */
 357     void showCommand(CommandType command);
 358
 359     /**
 360      * If the URL can be listed, open it in the current view, otherwise
 361      * run it through KRun.
 362      */
 363     void handleUrl(const QUrl& url);
 364
 365     /**
 366      * handleUrl() can trigger a stat job to see if the url can actually
 367      * be listed.
 368      */
 369     void slotHandleUrlStatFinished(KJob* job);
 370
 371     /**
 372      * Is invoked when the write state of a folder has been changed and
 373      * enables/disables the "Create New..." menu entry.
 374      */
 375     void slotWriteStateChanged(bool isFolderWritable);
 376
 377     /**
 378      * Opens the context menu on the current mouse position.
 379      * @pos           Position in screen coordinates.
 380      * @item          File item context. If item is null, the context menu
 381      *                should be applied to \a url.
 382      * @url           URL which contains \a item.
 383      * @customActions Actions that should be added to the context menu,
 384      *                if the file item is null.
 385      */
 386     void openContextMenu(const QPoint& pos,
 387                          const KFileItem& item,
 388                          const QUrl& url,
 389                          const QList<QAction*>& customActions);
 390
 391     void updateControlMenu();
 392     void updateToolBar();
 393     void slotControlButtonDeleted();
 394
 395     /**
 396      * Is called if the user clicked an item in the Places Panel.
 397      * Reloads the view if \a url is the current URL already, and changes the
 398      * current URL otherwise.
 399      */
 400     void slotPlaceActivated(const QUrl& url);
 401
 402     /**
 403      * Is called if the another view has been activated by changing the current
 404      * tab or activating another view in split-view mode.
 405      *
 406      * Activates the given view, which means that all menu actions are applied
 407      * to this view. When having a split view setup, the nonactive view is
 408      * usually shown in darker colors.
 409      */
 410     void activeViewChanged(DolphinViewContainer* viewContainer);
 411
 412     void closedTabsCountChanged(unsigned int count);
 413
 414     /**
 415      * Is called if a new tab has been opened or a tab has been closed to
 416      * enable/disable the tab actions.
 417      */
 418     void tabCountChanged(int count);
 419
 420     /**
 421      * Sets the window caption to url.fileName() if this is non-empty,
 422      * "/" if the URL is "file:///", and url.protocol() otherwise.
 423      */
 424     void setUrlAsCaption(const QUrl& url);
 425
 426     /**
 427      * Is called when the view has finished loading the directory.
 428      */
 429     void slotDirectoryLoadingCompleted();
 430
 431 private:
 432     void setupActions();
 433     void setupDockWidgets();
 434     void updateEditActions();
 435     void updateViewActions();
 436     void updateGoActions();
 437
 438     void createControlButton();
 439     void deleteControlButton();
 440
 441     /**
 442      * Adds the action \p action to the menu \p menu in
 443      * case if it has not added already to the toolbar.
 444      * @return True if the action has been added to the menu.
 445      */
 446     bool addActionToMenu(QAction* action, QMenu* menu);
 447
 448     /**
 449      * Connects the signals from the created DolphinView with
 450      * the DolphinViewContainer \a container with the corresponding slots of
 451      * the DolphinMainWindow. This method must be invoked each
 452      * time a DolphinView has been created.
 453      */
 454     void connectViewSignals(DolphinViewContainer* container);
 455
 456     /**
 457      * Updates the text of the split action:
 458      * If two views are shown, the text is set to "Split",
 459      * otherwise the text is set to "Join". The icon
 460      * is updated to match with the text and the currently active view.
 461      */
 462     void updateSplitAction();
 463
 464     bool isKompareInstalled() const;
 465
 466     /**
 467      * Creates an action for showing/hiding a panel, that is accessible
 468      * in "Configure toolbars..." and "Configure shortcuts...". This is necessary
 469      * as the action for toggling the dock visibility is done by Qt which
 470      * is no KAction instance.
 471      */
 472     void createPanelAction(const QIcon &icon,
 473                            const QKeySequence& shortcut,
 474                            QAction* dockAction,
 475                            const QString& actionName);
 476
 477 private:
 478     /**
 479      * Implements a custom error handling for the undo manager. This
 480      * assures that all errors are shown in the status bar of Dolphin
 481      * instead as modal error dialog with an OK button.
 482      */
 483     class UndoUiInterface : public KIO::FileUndoManager::UiInterface
 484     {
 485     public:
 486         UndoUiInterface();
 487         virtual ~UndoUiInterface();
 488         virtual void jobError(KIO::Job* job) Q_DECL_OVERRIDE;
 489     };
 490
 491     KNewFileMenu* m_newFileMenu;
 492     DolphinTabWidget* m_tabWidget;
 493     DolphinViewContainer* m_activeViewContainer;
 494     int m_id;
 495
 496     DolphinViewActionHandler* m_actionHandler;
 497     DolphinRemoteEncoding* m_remoteEncoding;
 498     QWeakPointer<DolphinSettingsDialog> m_settingsDialog;
 499
 500     // Members for the toolbar menu that is shown when the menubar is hidden:
 501     QToolButton* m_controlButton;
 502     QTimer* m_updateToolBarTimer;
 503
 504     KIO::Job* m_lastHandleUrlStatJob;
 505 };
 506
 507 inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
 508 {
 509     return m_activeViewContainer;
 510 }
 511
 512 inline KNewFileMenu* DolphinMainWindow::newFileMenu() const
 513 {
 514     return m_newFileMenu;
 515 }
 516
 517 inline int DolphinMainWindow::getId() const
 518 {
 519     return m_id;
 520 }
 521
 522 #endif // DOLPHIN_MAINWINDOW_H
 523