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