src/dolphinmainwindow.h

   1 /*
   2  * SPDX-FileCopyrightText: 2006 Peter Penz <peter.penz19@gmail.com>
   3  * SPDX-FileCopyrightText: 2006 Stefan Monov <logixoul@gmail.com>
   4  * SPDX-FileCopyrightText: 2006 Cvetoslav Ludmiloff <ludmiloff@gmail.com>
   5  *
   6  * SPDX-License-Identifier: GPL-2.0-or-later
   7  */
   8
   9 #ifndef DOLPHIN_MAINWINDOW_H
  10 #define DOLPHIN_MAINWINDOW_H
  11
  12 #include "dolphintabwidget.h"
  13 #include <config-baloo.h>
  14 #include <kio/fileundomanager.h>
  15 #include <KSortableList>
  16 #include <kxmlguiwindow.h>
  17
  18 #include <QIcon>
  19 #include <QList>
  20 #include <QMenu>
  21 #include <QPointer>
  22 #include <QUrl>
  23 #include <QVector>
  24
  25 typedef KIO::FileUndoManager::CommandType CommandType;
  26
  27 class DolphinBookmarkHandler;
  28 class DolphinViewActionHandler;
  29 class DolphinSettingsDialog;
  30 class DolphinViewContainer;
  31 class DolphinRemoteEncoding;
  32 class DolphinTabWidget;
  33 class KFileItem;
  34 class KFileItemList;
  35 class KJob;
  36 class KNewFileMenu;
  37 class KHelpMenu;
  38 class KToolBarPopupAction;
  39 class QToolButton;
  40 class QIcon;
  41 class PlacesPanel;
  42 class TerminalPanel;
  43
  44 namespace KIO {
  45     class OpenUrlJob;
  46 }
  47
  48 /**
  49  * @short Main window for Dolphin.
  50  *
  51  * Handles the menus, toolbars and Dolphin views.
  52  */
  53 class DolphinMainWindow: public KXmlGuiWindow
  54 {
  55     Q_OBJECT
  56     Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow")
  57
  58 public:
  59     DolphinMainWindow();
  60     ~DolphinMainWindow() override;
  61
  62     /**
  63      * Returns the currently active view.
  64      * All menu actions are applied to this view. When
  65      * having a split view setup, the nonactive view
  66      * is usually shown in darker colors.
  67      */
  68     DolphinViewContainer* activeViewContainer() const;
  69
  70     /**
  71      * Returns view container for all tabs
  72      */
  73     QVector<DolphinViewContainer*> viewContainers() const;
  74
  75     /**
  76      * Opens each directory in \p dirs in a separate tab. If \a splitView is set,
  77      * 2 directories are collected within one tab.
  78      * \pre \a dirs must contain at least one url.
  79      */
  80     void openDirectories(const QList<QUrl> &dirs, bool splitView);
  81
  82     /**
  83      * Opens the directories which contain the files \p files and selects all files.
  84      * If \a splitView is set, 2 directories are collected within one tab.
  85      * \pre \a files must contain at least one url.
  86      */
  87     void openFiles(const QList<QUrl>& files, bool splitView);
  88
  89     /**
  90      * Returns the 'Create New...' sub menu which also can be shared
  91      * with other menus (e. g. a context menu).
  92      */
  93     KNewFileMenu* newFileMenu() const;
  94
  95     /**
  96      * Switch the window's view containers' locations to display the home path
  97      * for any which are currently displaying a location corresponding to or
  98      * within mountPath.
  99      *
 100      * This typically done after unmounting a disk at mountPath to ensure that
 101      * the window is not displaying an invalid location.
 102      */
 103     void setViewsToHomeIfMountPathOpen(const QString& mountPath);
 104
 105     /**
 106      * Sets any of the window's view containers which are currently displaying
 107      * invalid locations to the home path
 108      */
 109     void setViewsWithInvalidPathsToHome();
 110
 111     bool isFoldersPanelEnabled() const;
 112     bool isInformationPanelEnabled() const;
 113
 114 public slots:
 115     /**
 116      * Opens each directory in \p dirs in a separate tab. If \a splitView is set,
 117      * 2 directories are collected within one tab.
 118      * \pre \a dirs must contain at least one url.
 119      *
 120      * @note this function is overloaded so that it is callable via DBus.
 121      */
 122     void openDirectories(const QStringList &dirs, bool splitView);
 123
 124     /**
 125      * Opens the directories which contain the files \p files and selects all files.
 126      * If \a splitView is set, 2 directories are collected within one tab.
 127      * \pre \a files must contain at least one url.
 128      *
 129      * @note this is overloaded so that this function is callable via DBus.
 130      */
 131     void openFiles(const QStringList &files, bool splitView);
 132
 133     /**
 134      * Tries to raise/activate the Dolphin window.
 135      */
 136     void activateWindow();
 137
 138     /**
 139      * Determines if a URL is open in any tab.
 140      * @note Use of QString instead of QUrl is required to be callable via DBus.
 141      *
 142      * @param url URL to look for
 143      * @returns true if url is currently open in a tab, false otherwise.
 144      */
 145     bool isUrlOpen(const QString &url);
 146
 147
 148     /**
 149      * Pastes the clipboard data into the currently selected folder
 150      * of the active view. If not exactly one folder is selected,
 151      * no pasting is done at all.
 152      */
 153     void pasteIntoFolder();
 154
 155     /**
 156      * Implementation of the MainWindowAdaptor/QDBusAbstractAdaptor interface.
 157      * Inform all affected dolphin components (panels, views) of an URL
 158      * change.
 159      */
 160     void changeUrl(const QUrl& url);
 161
 162     /**
 163      * The current directory of the Terminal Panel has changed, probably because
 164      * the user entered a 'cd' command. This slot calls changeUrl(url) and makes
 165      * sure that the panel keeps the keyboard focus.
 166      */
 167     void slotTerminalDirectoryChanged(const QUrl& url);
 168
 169     /** Stores all settings and quits Dolphin. */
 170     void quit();
 171
 172     /**
 173      * Opens a new tab and places it after the current tab
 174      */
 175     void openNewTabAfterCurrentTab(const QUrl& url);
 176
 177     /**
 178      * Opens a new tab and places it as the last tab
 179      */
 180     void openNewTabAfterLastTab(const QUrl& url);
 181
 182 signals:
 183     /**
 184      * Is sent if the selection of the currently active view has
 185      * been changed.
 186      */
 187     void selectionChanged(const KFileItemList& selection);
 188
 189     /**
 190      * Is sent if the url of the currently active view has
 191      * been changed.
 192      */
 193     void urlChanged(const QUrl& url);
 194
 195     /**
 196      * Is emitted if information of an item is requested to be shown e. g. in the panel.
 197      * If item is null, no item information request is pending.
 198      */
 199     void requestItemInfo(const KFileItem& item);
 200
 201     /**
 202      * Is emitted if the settings have been changed.
 203      */
 204     void settingsChanged();
 205
 206 protected:
 207     /** @see QWidget::showEvent() */
 208     void showEvent(QShowEvent* event) override;
 209
 210     /** @see QMainWindow::closeEvent() */
 211     void closeEvent(QCloseEvent* event) override;
 212
 213     /** @see KMainWindow::saveProperties() */
 214     void saveProperties(KConfigGroup& group) override;
 215
 216     /** @see KMainWindow::readProperties() */
 217     void readProperties(const KConfigGroup& group) override;
 218
 219     /** Handles QWhatsThisClickedEvent and passes all others on. */
 220     bool event(QEvent* event) override;
 221     /** Handles QWhatsThisClickedEvent and passes all others on. */
 222     bool eventFilter(QObject*, QEvent*) override;
 223
 224 protected slots:
 225     /**
 226      * Calls the base method KXmlGuiWindow::saveNewToolbarConfig().
 227      * Is also used to set toolbar constraints and UrlNavigator position
 228      * based on the newly changed toolbar configuration.
 229      */
 230     void saveNewToolbarConfig() override;
 231
 232 private slots:
 233     /**
 234      * Refreshes the views of the main window by recreating them according to
 235      * the given Dolphin settings.
 236      */
 237     void refreshViews();
 238
 239     void clearStatusBar();
 240
 241     /** Updates the 'Create New...' sub menu. */
 242     void updateNewMenu();
 243
 244     void createDirectory();
 245
 246     /** Shows the error message in the status bar of the active view. */
 247     void showErrorMessage(const QString& message);
 248
 249     /**
 250      * Updates the state of the 'Undo' menu action dependent
 251      * on the parameter \a available.
 252      */
 253     void slotUndoAvailable(bool available);
 254
 255     /** Sets the text of the 'Undo' menu action to \a text. */
 256     void slotUndoTextChanged(const QString& text);
 257
 258     /** Performs the current undo operation. */
 259     void undo();
 260
 261     /**
 262      * Copies all selected items to the clipboard and marks
 263      * the items as cut.
 264      */
 265     void cut();
 266
 267     /** Copies all selected items to the clipboard. */
 268     void copy();
 269
 270     /** Pastes the clipboard data to the active view. */
 271     void paste();
 272
 273     /** Replaces the URL navigator by a search box to find files. */
 274     void find();
 275
 276     /** Updates the state of the search action according to the view container. */
 277     void updateSearchAction();
 278
 279     /**
 280      * Updates the text of the paste action dependent on
 281      * the number of items which are in the clipboard.
 282      */
 283     void updatePasteAction();
 284
 285     /** Selects all items from the active view. */
 286     void selectAll();
 287
 288     /**
 289      * Inverts the selection of all items of the active view:
 290      * Selected items get nonselected and nonselected items get
 291      * selected.
 292      */
 293     void invertSelection();
 294
 295     /**
 296      * Switches between one and two views:
 297      * If one view is visible, it will get split into two views.
 298      * If already two views are visible, the active view gets closed.
 299      */
 300     void toggleSplitView();
 301
 302     /** Dedicated action to open the stash:/ ioslave in split view. */
 303     void toggleSplitStash();
 304
 305     /** Reloads the currently active view. */
 306     void reloadView();
 307
 308     /** Stops the loading process for the currently active view. */
 309     void stopLoading();
 310
 311     void enableStopAction();
 312     void disableStopAction();
 313
 314     void showFilterBar();
 315     void toggleFilterBar();
 316
 317     /**
 318      * Toggles between edit and browse mode of the navigation bar.
 319      */
 320     void toggleEditLocation();
 321
 322     /**
 323      * Switches to the edit mode of the navigation bar and selects
 324      * the whole URL, so that it can be replaced by the user. If the edit mode is
 325      * already active, it is assured that the navigation bar get focused.
 326      */
 327     void replaceLocation();
 328
 329     /**
 330      * Toggles the state of the panels between a locked and unlocked layout.
 331      */
 332     void togglePanelLockState();
 333
 334     /**
 335      * Is invoked if the Terminal panel got visible/invisible and takes care
 336      * that the active view has the focus if the Terminal panel is invisible.
 337      */
 338     void slotTerminalPanelVisibilityChanged();
 339
 340     /** Goes back one step of the URL history. */
 341     void goBack();
 342
 343     /** Goes forward one step of the URL history. */
 344     void goForward();
 345
 346     /** Goes up one hierarchy of the current URL. */
 347     void goUp();
 348
 349     /** Changes the location to the home URL. */
 350     void goHome();
 351
 352     /** Open the previous URL in the URL history in a new tab. */
 353     void goBackInNewTab();
 354
 355     /** Open the next URL in the URL history in a new tab. */
 356     void goForwardInNewTab();
 357
 358     /** Open the URL one hierarchy above the current URL in a new tab. */
 359     void goUpInNewTab();
 360
 361     /** * Open the home URL in a new tab. */
 362     void goHomeInNewTab();
 363
 364     /** Opens Kompare for 2 selected files. */
 365     void compareFiles();
 366
 367     /**
 368      * Hides the menu bar if it is visible, makes the menu bar
 369      * visible if it is hidden.
 370      */
 371     void toggleShowMenuBar();
 372
 373     /** Updates "Open Preferred Search Tool" action. */
 374     void updateOpenPreferredSearchToolAction();
 375
 376     /** Opens preferred search tool for the current location. */
 377     void openPreferredSearchTool();
 378
 379     /** Opens a terminal window for the current location. */
 380     void openTerminal();
 381
 382     /** Focus a Terminal Panel. */
 383     void focusTerminalPanel();
 384
 385     /** Opens the settings dialog for Dolphin. */
 386     void editSettings();
 387
 388     /** Updates the state of the 'Show Full Location' action. */
 389     void slotEditableStateChanged(bool editable);
 390
 391     /**
 392      * Updates the state of the 'Edit' menu actions and emits
 393      * the signal selectionChanged().
 394      */
 395     void slotSelectionChanged(const KFileItemList& selection);
 396
 397     /**
 398      * Updates the state of the 'Back' and 'Forward' menu
 399      * actions corresponding to the current history.
 400      */
 401     void updateHistory();
 402
 403     /** Updates the state of the 'Show filter bar' menu action. */
 404     void updateFilterBarAction(bool show);
 405
 406     /** Open a new main window. */
 407     void openNewMainWindow();
 408
 409     /**
 410      * Opens a new view with the current URL that is part of a tab and
 411      * activates it.
 412      */
 413     void openNewActivatedTab();
 414
 415     /**
 416      * Adds the current URL as an entry to the Places panel
 417      */
 418     void addToPlaces();
 419
 420     /**
 421      * Opens a new tab in the background showing the URL \a url.
 422      */
 423     void openNewTab(const QUrl& url, DolphinTabWidget::TabPlacement tabPlacement);
 424
 425     /**
 426      * Opens the selected folder in a new tab.
 427      */
 428     void openInNewTab();
 429
 430     /**
 431      * Opens the selected folder in a new window.
 432      */
 433     void openInNewWindow();
 434
 435     /**
 436      * Show the target of the selected symlink
 437      */
 438     void showTarget();
 439
 440     /**
 441      * Indicates in the statusbar that the execution of the command \a command
 442      * has been finished.
 443      */
 444     void showCommand(CommandType command);
 445
 446     /**
 447      * If the URL can be listed, open it in the current view, otherwise
 448      * run it through KRun.
 449      */
 450     void handleUrl(const QUrl& url);
 451
 452     /**
 453      * Is invoked when the write state of a folder has been changed and
 454      * enables/disables the "Create New..." menu entry.
 455      */
 456     void slotWriteStateChanged(bool isFolderWritable);
 457
 458     /**
 459      * Opens the context menu on the current mouse position.
 460      * @pos           Position in screen coordinates.
 461      * @item          File item context. If item is null, the context menu
 462      *                should be applied to \a url.
 463      * @url           URL which contains \a item.
 464      * @customActions Actions that should be added to the context menu,
 465      *                if the file item is null.
 466      */
 467     void openContextMenu(const QPoint& pos,
 468                          const KFileItem& item,
 469                          const QUrl& url,
 470                          const QList<QAction*>& customActions);
 471
 472     void updateControlMenu();
 473     void updateToolBar();
 474     void slotControlButtonDeleted();
 475
 476     /**
 477      * Is called if the user clicked an item in the Places Panel.
 478      * Reloads the view if \a url is the current URL already, and changes the
 479      * current URL otherwise.
 480      */
 481     void slotPlaceActivated(const QUrl& url);
 482
 483     /**
 484      * Is called if the another view has been activated by changing the current
 485      * tab or activating another view in split-view mode.
 486      *
 487      * Activates the given view, which means that all menu actions are applied
 488      * to this view. When having a split view setup, the nonactive view is
 489      * usually shown in darker colors.
 490      */
 491     void activeViewChanged(DolphinViewContainer* viewContainer);
 492
 493     void closedTabsCountChanged(unsigned int count);
 494
 495     /**
 496      * Is called if a new tab has been opened or a tab has been closed to
 497      * enable/disable the tab actions.
 498      */
 499     void tabCountChanged(int count);
 500
 501     /**
 502      * Updates the Window Title with the caption from the active view container
 503      */
 504     void updateWindowTitle();
 505
 506     /**
 507      * This slot is called when the user requested to unmount a removable media
 508      * from the places menu
 509      */
 510     void slotStorageTearDownFromPlacesRequested(const QString& mountPath);
 511
 512     /**
 513      * This slot is called when the user requested to unmount a removable media
 514      * _not_ from the dolphin's places menu (from the notification area for e.g.)
 515      * This slot is basically connected to each removable device's
 516      * Solid::StorageAccess::teardownRequested(const QString & udi)
 517      * signal through the places panel.
 518      */
 519     void slotStorageTearDownExternallyRequested(const QString& mountPath);
 520
 521     /**
 522      * Is called when the view has finished loading the directory.
 523      */
 524     void slotDirectoryLoadingCompleted();
 525
 526     /**
 527      * Is called when the user middle clicks a toolbar button.
 528      *
 529      * Here middle clicking Back/Forward/Up/Home will open the resulting
 530      * folder in a new tab.
 531      */
 532     void slotToolBarActionMiddleClicked(QAction *action);
 533
 534     /**
 535      * Is called before the Back popup menu is shown. This slot will populate
 536      * the menu with history data
 537      */
 538     void slotAboutToShowBackPopupMenu();
 539
 540     /**
 541       * This slot is used by the Back Popup Menu to go back to a specific
 542       * history index. The QAction::data will carry an int with the index
 543       * to go to.
 544       */
 545     void slotGoBack(QAction* action);
 546
 547     /**
 548      * Middle clicking Back/Forward will open the resulting folder in a new tab.
 549      */
 550     void slotBackForwardActionMiddleClicked(QAction *action);
 551
 552     /**
 553      * Is called before the Forward popup menu is shown. This slot will populate
 554      * the menu with history data
 555      */
 556     void slotAboutToShowForwardPopupMenu();
 557
 558     /**
 559       * This slot is used by the Forward Popup Menu to go forward to a specific
 560       * history index. The QAction::data will carry an int with the index
 561       * to go to.
 562       */
 563     void slotGoForward(QAction* action);
 564 private:
 565     /**
 566      * Sets up the various menus and actions and connects them.
 567      */
 568     void setupActions();
 569
 570     /**
 571      * Sets up the dock widgets and their panels.
 572      */
 573     void setupDockWidgets();
 574
 575     void updateFileAndEditActions();
 576     void updateViewActions();
 577     void updateGoActions();
 578
 579     void createControlButton();
 580     void deleteControlButton();
 581
 582     /**
 583      * Adds the action \p action to the menu \p menu in
 584      * case if it has not added already to the toolbar.
 585      * @return True if the action has been added to the menu.
 586      */
 587     bool addActionToMenu(QAction* action, QMenu* menu);
 588
 589     /**
 590      * Connects the signals from the created DolphinView with
 591      * the DolphinViewContainer \a container with the corresponding slots of
 592      * the DolphinMainWindow. This method must be invoked each
 593      * time a DolphinView has been created.
 594      */
 595     void connectViewSignals(DolphinViewContainer* container);
 596
 597     /**
 598      * Updates the text of the split action:
 599      * If two views are shown, the text is set to "Split",
 600      * otherwise the text is set to "Join". The icon
 601      * is updated to match with the text and the currently active view.
 602      */
 603     void updateSplitAction();
 604
 605     /**
 606      * Sets the window sides the toolbar may be moved to based on toolbar contents.
 607      */
 608     void updateAllowedToolbarAreas();
 609
 610     bool isKompareInstalled() const;
 611
 612     /**
 613      * Creates an action for showing/hiding a panel, that is accessible
 614      * in "Configure toolbars..." and "Configure shortcuts...". This is necessary
 615      * as the action for toggling the dock visibility is done by Qt which
 616      * is no KAction instance.
 617      */
 618     void createPanelAction(const QIcon &icon,
 619                            const QKeySequence& shortcut,
 620                            QAction* dockAction,
 621                            const QString& actionName);
 622
 623     /** Adds "What's This?" texts to many widgets and StandardActions. */
 624     void setupWhatsThis();
 625
 626     /** Returns preferred search tool as configured in "More Search Tools" menu. */
 627     QPointer<QAction> preferredSearchTool();
 628
 629 private:
 630     /**
 631      * Implements a custom error handling for the undo manager. This
 632      * assures that all errors are shown in the status bar of Dolphin
 633      * instead as modal error dialog with an OK button.
 634      */
 635     class UndoUiInterface : public KIO::FileUndoManager::UiInterface
 636     {
 637     public:
 638         UndoUiInterface();
 639         ~UndoUiInterface() override;
 640         void jobError(KIO::Job* job) override;
 641     };
 642
 643     KNewFileMenu* m_newFileMenu;
 644     KHelpMenu* m_helpMenu;
 645     DolphinTabWidget* m_tabWidget;
 646     DolphinViewContainer* m_activeViewContainer;
 647
 648     DolphinViewActionHandler* m_actionHandler;
 649     DolphinRemoteEncoding* m_remoteEncoding;
 650     QPointer<DolphinSettingsDialog> m_settingsDialog;
 651     DolphinBookmarkHandler* m_bookmarkHandler;
 652
 653     // Members for the toolbar menu that is shown when the menubar is hidden:
 654     QToolButton* m_controlButton;
 655     QTimer* m_updateToolBarTimer;
 656
 657     KIO::OpenUrlJob *m_lastHandleUrlOpenJob;
 658
 659     TerminalPanel* m_terminalPanel;
 660     PlacesPanel* m_placesPanel;
 661     bool m_tearDownFromPlacesRequested;
 662
 663     KToolBarPopupAction* m_backAction;
 664     KToolBarPopupAction* m_forwardAction;
 665
 666     /** Makes sure that only one object is ever connected to the history. */
 667     QMetaObject::Connection m_updateHistoryConnection;
 668
 669     QMenu m_searchTools;
 670
 671 };
 672
 673 inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
 674 {
 675     return m_activeViewContainer;
 676 }
 677
 678 inline KNewFileMenu* DolphinMainWindow::newFileMenu() const
 679 {
 680     return m_newFileMenu;
 681 }
 682
 683 #endif // DOLPHIN_MAINWINDOW_H
 684