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