]> cloud.milkyroute.net Git - dolphin.git/blob - src/dolphinmainwindow.h
avoid need for activities lib
[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 */
213 void openNewTab(const QUrl &url);
214
215 /**
216 * Opens a new tab showing the URL \a url and activate it.
217 */
218 void openNewTabAndActivate(const QUrl &url);
219
220 /**
221 * Opens a new window showing the URL \a url.
222 */
223 void openNewWindow(const QUrl &url);
224
225 /** @see GeneralSettings::splitViewChanged() */
226 void slotSplitViewChanged();
227
228 Q_SIGNALS:
229 /**
230 * Is sent if the selection of the currently active view has
231 * been changed.
232 */
233 void selectionChanged(const KFileItemList &selection);
234
235 /**
236 * Is sent if the url of the currently active view has
237 * been changed.
238 */
239 void urlChanged(const QUrl &url);
240
241 /**
242 * Is emitted if information of an item is requested to be shown e. g. in the panel.
243 * If item is null, no item information request is pending.
244 */
245 void requestItemInfo(const KFileItem &item);
246
247 /**
248 * It is emitted when in the current view, files are changed,
249 * or dirs have files/removed from them.
250 */
251 void fileItemsChanged(const KFileItemList &changedFileItems);
252
253 /**
254 * Is emitted if the settings have been changed.
255 */
256 void settingsChanged();
257
258 protected:
259 /** @see QObject::event() */
260 bool event(QEvent *event) override;
261
262 /** @see QWidget::showEvent() */
263 void showEvent(QShowEvent *event) override;
264
265 /** @see QMainWindow::closeEvent() */
266 void closeEvent(QCloseEvent *event) override;
267
268 /** @see KMainWindow::saveProperties() */
269 void saveProperties(KConfigGroup &group) override;
270
271 /** @see KMainWindow::readProperties() */
272 void readProperties(const KConfigGroup &group) override;
273
274 /** Sets a sane initial window size **/
275 QSize sizeHint() const override;
276
277 protected Q_SLOTS:
278 /**
279 * Calls the base method KXmlGuiWindow::saveNewToolbarConfig().
280 * Is also used to set toolbar constraints and UrlNavigator position
281 * based on the newly changed toolbar configuration.
282 */
283 void saveNewToolbarConfig() override;
284
285 private Q_SLOTS:
286 /**
287 * Refreshes the views of the main window by recreating them according to
288 * the given Dolphin settings.
289 */
290 void refreshViews();
291
292 void clearStatusBar();
293
294 /** Updates the 'Create New...' sub menu. */
295 void updateNewMenu();
296
297 void createDirectory();
298
299 /** Shows the error message in the status bar of the active view. */
300 void showErrorMessage(const QString &message);
301
302 /**
303 * Updates the state of the 'Undo' menu action dependent
304 * on the parameter \a available.
305 */
306 void slotUndoAvailable(bool available);
307
308 /** Sets the text of the 'Undo' menu action to \a text. */
309 void slotUndoTextChanged(const QString &text);
310
311 /** Performs the current undo operation. */
312 void undo();
313
314 /**
315 * Copies all selected items to the clipboard and marks
316 * the items as cut.
317 */
318 void cut();
319
320 /** Copies all selected items to the clipboard. */
321 void copy();
322
323 /** Pastes the clipboard data to the active view. */
324 void paste();
325
326 /** Replaces the URL navigator by a search box to find files. */
327 void find();
328
329 /** Updates the state of the search action according to the view container. */
330 void updateSearchAction();
331
332 /**
333 * Updates the text of the paste action dependent on
334 * the number of items which are in the clipboard.
335 */
336 void updatePasteAction();
337
338 /** Calls DolphinViewContainer::setSelectionMode() for m_activeViewContainer. */
339 void slotSetSelectionMode(bool enabled, SelectionMode::BottomBar::Contents bottomBarContents);
340
341 /** Selects all items from the active view. */
342 void selectAll();
343
344 /**
345 * Inverts the selection of all items of the active view:
346 * Selected items get nonselected and nonselected items get
347 * selected.
348 */
349 void invertSelection();
350
351 /**
352 * Switches between one and two views:
353 * If one view is visible, it will get split into two views.
354 * If already two views are visible, the active view gets closed.
355 */
356 void toggleSplitView();
357
358 /**
359 * Pops out a split view.
360 * The active view will be popped out, unless the view is not split,
361 * in which case nothing will happen.
362 */
363 void popoutSplitView();
364
365 /** Dedicated action to open the stash:/ ioslave in split view. */
366 void toggleSplitStash();
367
368 /** Copies all selected items to the inactive view. */
369 void copyToInactiveSplitView();
370
371 /** Moves all selected items to the inactive view. */
372 void moveToInactiveSplitView();
373
374 /** Reloads the currently active view. */
375 void reloadView();
376
377 /** Stops the loading process for the currently active view. */
378 void stopLoading();
379
380 void enableStopAction();
381 void disableStopAction();
382
383 void toggleSelectionMode();
384
385 void showFilterBar();
386 void toggleFilterBar();
387
388 /**
389 * Toggles between edit and browse mode of the navigation bar.
390 */
391 void toggleEditLocation();
392
393 /**
394 * Switches to the edit mode of the navigation bar and selects
395 * the whole URL, so that it can be replaced by the user. If the edit mode is
396 * already active, it is assured that the navigation bar get focused.
397 */
398 void replaceLocation();
399
400 /**
401 * Toggles the state of the panels between a locked and unlocked layout.
402 */
403 void togglePanelLockState();
404
405 /**
406 * Is invoked if the Terminal panel got visible/invisible and takes care
407 * that the active view has the focus if the Terminal panel is invisible.
408 */
409 void slotTerminalPanelVisibilityChanged();
410
411 /** Goes back one step of the URL history. */
412 void goBack();
413
414 /** Goes forward one step of the URL history. */
415 void goForward();
416
417 /** Goes up one hierarchy of the current URL. */
418 void goUp();
419
420 /** Changes the location to the home URL. */
421 void goHome();
422
423 /** Open the previous URL in the URL history in a new tab. */
424 void goBackInNewTab();
425
426 /** Open the next URL in the URL history in a new tab. */
427 void goForwardInNewTab();
428
429 /** Open the URL one hierarchy above the current URL in a new tab. */
430 void goUpInNewTab();
431
432 /** * Open the home URL in a new tab. */
433 void goHomeInNewTab();
434
435 /** Opens Kompare for 2 selected files. */
436 void compareFiles();
437
438 /**
439 * Hides the menu bar if it is visible, makes the menu bar
440 * visible if it is hidden.
441 */
442 void toggleShowMenuBar();
443
444 /** Updates "Open Preferred Search Tool" action. */
445 void updateOpenPreferredSearchToolAction();
446
447 /** Opens preferred search tool for the current location. */
448 void openPreferredSearchTool();
449
450 /** Opens a terminal window for the current location. */
451 void openTerminal();
452
453 /** Opens terminal windows for the selected items' locations. */
454 void openTerminalHere();
455
456 /** Opens a terminal window for the URL. */
457 void openTerminalJob(const QUrl &url);
458
459 /** Focus a Terminal Panel. */
460 void focusTerminalPanel();
461
462 /** Opens the settings dialog for Dolphin. */
463 void editSettings();
464
465 /** Updates the state of the 'Show Full Location' action. */
466 void slotEditableStateChanged(bool editable);
467
468 /**
469 * Updates the state of the 'Edit' menu actions and emits
470 * the signal selectionChanged().
471 */
472 void slotSelectionChanged(const KFileItemList &selection);
473
474 /**
475 * Updates the state of the 'Back' and 'Forward' menu
476 * actions corresponding to the current history.
477 */
478 void updateHistory();
479
480 /** Updates the state of the 'Show filter bar' menu action. */
481 void updateFilterBarAction(bool show);
482
483 /** Open a new main window. */
484 void openNewMainWindow();
485
486 /**
487 * Opens a new view with the current URL that is part of a tab and
488 * activates it.
489 */
490 void openNewActivatedTab();
491
492 /**
493 * Adds the current URL as an entry to the Places panel
494 */
495 void addToPlaces();
496
497 /**
498 * Opens the selected folder in a new tab.
499 */
500 void openInNewTab();
501
502 /**
503 * Opens the selected folder in a new window.
504 */
505 void openInNewWindow();
506
507 /**
508 * Opens the selected folder in the other inactive split view, enables split view if necessary.
509 */
510 void openInSplitView(const QUrl &url);
511
512 /**
513 * Show the target of the selected symlink
514 */
515 void showTarget();
516
517 /**
518 * Indicates in the statusbar that the execution of the command \a command
519 * has been finished.
520 */
521 void showCommand(CommandType command);
522
523 /**
524 * If the URL can be listed, open it in the current view, otherwise
525 * run it through KRun.
526 */
527 void handleUrl(const QUrl &url);
528
529 /**
530 * Is invoked when the write state of a folder has been changed and
531 * enables/disables the "Create New..." menu entry.
532 */
533 void slotWriteStateChanged(bool isFolderWritable);
534
535 /**
536 * Opens the context menu on the current mouse position.
537 * @pos Position in screen coordinates.
538 * @item File item context. If item is null, the context menu
539 * should be applied to \a url.
540 * @selectedItems The selected items for which the context menu
541 * is opened. This list generally includes \a item.
542 * @url URL which contains \a item.
543 */
544 void openContextMenu(const QPoint &pos, const KFileItem &item, const KFileItemList &selectedItems, const QUrl &url);
545
546 /**
547 * Updates the menu that is by default at the right end of the toolbar.
548 *
549 * In true "simple by default" fashion, the menu only contains the most important
550 * and necessary actions to be able to use Dolphin. This is supposed to hold true even
551 * if the user does not know how to open a context menu. More advanced actions can be
552 * discovered through a sub-menu (@see KConfigWidgets::KHamburgerMenu::setMenuBarAdvertised()).
553 */
554 void updateHamburgerMenu();
555
556 /**
557 * Is called if the user clicked an item in the Places Panel.
558 * Reloads the view if \a url is the current URL already, and changes the
559 * current URL otherwise.
560 */
561 void slotPlaceActivated(const QUrl &url);
562
563 /**
564 * Is called if the another view has been activated by changing the current
565 * tab or activating another view in split-view mode.
566 *
567 * Activates the given view, which means that all menu actions are applied
568 * to this view. When having a split view setup, the nonactive view is
569 * usually shown in darker colors.
570 */
571 void activeViewChanged(DolphinViewContainer *viewContainer);
572
573 void closedTabsCountChanged(unsigned int count);
574
575 /**
576 * Is called if a new tab has been opened or a tab has been closed to
577 * enable/disable the tab actions.
578 */
579 void tabCountChanged(int count);
580
581 /**
582 * Updates the Window Title with the caption from the active view container
583 */
584 void updateWindowTitle();
585
586 /**
587 * This slot is called when the user requested to unmount a removable media
588 * from the places menu
589 */
590 void slotStorageTearDownFromPlacesRequested(const QString &mountPath);
591
592 /**
593 * This slot is called when the user requested to unmount a removable media
594 * _not_ from the dolphin's places menu (from the notification area for e.g.)
595 * This slot is basically connected to each removable device's
596 * Solid::StorageAccess::teardownRequested(const QString & udi)
597 * signal through the places panel.
598 */
599 void slotStorageTearDownExternallyRequested(const QString &mountPath);
600
601 /**
602 * Is called when the view has finished loading the directory.
603 */
604 void slotDirectoryLoadingCompleted();
605
606 /**
607 * Is called when the user middle clicks a toolbar button.
608 *
609 * Here middle clicking Back/Forward/Up/Home will open the resulting
610 * folder in a new tab.
611 */
612 void slotToolBarActionMiddleClicked(QAction *action);
613
614 /**
615 * Is called before the Back popup menu is shown. This slot will populate
616 * the menu with history data
617 */
618 void slotAboutToShowBackPopupMenu();
619
620 /**
621 * This slot is used by the Back Popup Menu to go back to a specific
622 * history index. The QAction::data will carry an int with the index
623 * to go to.
624 */
625 void slotGoBack(QAction *action);
626
627 /**
628 * Middle clicking Back/Forward will open the resulting folder in a new tab.
629 */
630 void slotBackForwardActionMiddleClicked(QAction *action);
631
632 /**
633 * Is called before the Forward popup menu is shown. This slot will populate
634 * the menu with history data
635 */
636 void slotAboutToShowForwardPopupMenu();
637
638 /**
639 * This slot is used by the Forward Popup Menu to go forward to a specific
640 * history index. The QAction::data will carry an int with the index
641 * to go to.
642 */
643 void slotGoForward(QAction *action);
644
645 /**
646 * Is called when configuring the keyboard shortcuts
647 */
648 void slotKeyBindings();
649
650 /**
651 * Saves the session.
652 */
653 void slotSaveSession();
654
655 private:
656 /**
657 * Sets up the various menus and actions and connects them.
658 */
659 void setupActions();
660
661 /**
662 * Sets up the dock widgets and their panels.
663 */
664 void setupDockWidgets();
665
666 void updateFileAndEditActions();
667 void updateViewActions();
668 void updateGoActions();
669
670 /**
671 * Connects the signals from the created DolphinView with
672 * the DolphinViewContainer \a container with the corresponding slots of
673 * the DolphinMainWindow. This method must be invoked each
674 * time a DolphinView has been created.
675 */
676 void connectViewSignals(DolphinViewContainer *container);
677
678 /**
679 * Updates the text of the split action:
680 * If two views are shown, the text is set to "Split",
681 * otherwise the text is set to "Join". The icon
682 * is updated to match with the text and the currently active view.
683 */
684 void updateSplitActions();
685
686 /**
687 * Sets the window sides the toolbar may be moved to based on toolbar contents.
688 */
689 void updateAllowedToolbarAreas();
690
691 bool isKompareInstalled() const;
692
693 /**
694 * Creates an action for showing/hiding a panel, that is accessible
695 * in "Configure toolbars..." and "Configure shortcuts...".
696 */
697 void createPanelAction(const QIcon &icon, const QKeySequence &shortcut, QDockWidget *dockAction, const QString &actionName);
698
699 /** Adds "What's This?" texts to many widgets and StandardActions. */
700 void setupWhatsThis();
701
702 /** Returns preferred search tool as configured in "More Search Tools" menu. */
703 QPointer<QAction> preferredSearchTool();
704
705 /**
706 * Adds this action to the mainWindow's toolbar and saves the change
707 * in the users ui configuration file.
708 * This method is only needed for migration and should be removed once we can expect
709 * that pretty much all users have been migrated. Remove in 2026 because that's when
710 * even the most risk-averse distros will already have been forced to upgrade.
711 * @return true if successful. Otherwise false.
712 */
713 bool addHamburgerMenuToToolbar();
714
715 /** Creates an action representing an item in the URL navigator history */
716 static QAction *urlNavigatorHistoryAction(const KUrlNavigator *urlNavigator, int historyIndex, QObject *parent = nullptr);
717
718 private:
719 /**
720 * Implements a custom error handling for the undo manager. This
721 * assures that all errors are shown in the status bar of Dolphin
722 * instead as modal error dialog with an OK button.
723 */
724 class UndoUiInterface : public KIO::FileUndoManager::UiInterface
725 {
726 public:
727 UndoUiInterface();
728 ~UndoUiInterface() override;
729 void jobError(KIO::Job *job) override;
730 };
731
732 KNewFileMenu *m_newFileMenu;
733 DolphinTabWidget *m_tabWidget;
734 DolphinViewContainer *m_activeViewContainer;
735
736 DolphinViewActionHandler *m_actionHandler;
737 DolphinRemoteEncoding *m_remoteEncoding;
738 QPointer<DolphinSettingsDialog> m_settingsDialog;
739 DolphinBookmarkHandler *m_bookmarkHandler;
740 SelectionMode::ActionTextHelper *m_actionTextHelper;
741 DisabledActionNotifier *m_disabledActionNotifier;
742
743 KIO::OpenUrlJob *m_lastHandleUrlOpenJob;
744
745 TerminalPanel *m_terminalPanel;
746 PlacesPanel *m_placesPanel;
747 bool m_tearDownFromPlacesRequested;
748
749 KToolBarPopupAction *m_backAction;
750 KToolBarPopupAction *m_forwardAction;
751 KActionMenu *m_splitViewAction;
752 QAction *m_splitViewMenuAction;
753
754 QMenu m_searchTools;
755 KFileItemActions m_fileItemActions;
756
757 QTimer *m_sessionSaveTimer;
758 QFutureWatcher<void> *m_sessionSaveWatcher;
759 bool m_sessionSaveScheduled;
760
761 KIO::CommandLauncherJob *m_job;
762
763 KRecentFilesAction *m_recentFiles = nullptr;
764
765 friend class DolphinMainWindowTest;
766 };
767
768 inline DolphinViewContainer *DolphinMainWindow::activeViewContainer() const
769 {
770 return m_activeViewContainer;
771 }
772
773 inline KNewFileMenu *DolphinMainWindow::newFileMenu() const
774 {
775 return m_newFileMenu;
776 }
777
778 #endif // DOLPHIN_MAINWINDOW_H