-/***************************************************************************
- * Copyright (C) 2006 by Peter Penz <peter.penz19@gmail.com> *
- * Copyright (C) 2006 by Stefan Monov <logixoul@gmail.com> *
- * Copyright (C) 2006 by Cvetoslav Ludmiloff <ludmiloff@gmail.com> *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2006 Peter Penz <peter.penz19@gmail.com>
+ * SPDX-FileCopyrightText: 2006 Stefan Monov <logixoul@gmail.com>
+ * SPDX-FileCopyrightText: 2006 Cvetoslav Ludmiloff <ludmiloff@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#ifndef DOLPHIN_MAINWINDOW_H
#define DOLPHIN_MAINWINDOW_H
+#include "dolphintabwidget.h"
#include <config-baloo.h>
-
-#include <KFileItemDelegate>
+#include <KFileItemActions>
#include <kio/fileundomanager.h>
-#include <ksortablelist.h>
#include <kxmlguiwindow.h>
-#include <KIcon>
-#include <KUrl>
+#ifdef HAVE_BALOO
+ #include "panels/information/informationpanel.h"
+#endif
+
+#include <QIcon>
#include <QList>
-#include <QWeakPointer>
+#include <QMenu>
+#include <QPointer>
+#include <QUrl>
+#include <QVector>
typedef KIO::FileUndoManager::CommandType CommandType;
+class DolphinBookmarkHandler;
class DolphinViewActionHandler;
-class DolphinApplication;
class DolphinSettingsDialog;
class DolphinViewContainer;
class DolphinRemoteEncoding;
class KFileItemList;
class KJob;
class KNewFileMenu;
+class KHelpMenu;
+class KToolBarPopupAction;
class QToolButton;
-class QIcon;
+class PlacesPanel;
+class TerminalPanel;
+
+namespace KIO {
+ class OpenUrlJob;
+}
/**
* @short Main window for Dolphin.
{
Q_OBJECT
Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow")
- Q_PROPERTY(int id READ getId SCRIPTABLE true)
- friend class DolphinApplication;
public:
DolphinMainWindow();
- virtual ~DolphinMainWindow();
+ ~DolphinMainWindow() override;
/**
* Returns the currently active view.
DolphinViewContainer* activeViewContainer() const;
/**
- * Opens each directory in \p dirs in a separate tab. If the "split view"
- * option is enabled, 2 directories are collected within one tab.
+ * Returns view container for all tabs
+ */
+ QVector<DolphinViewContainer*> viewContainers() const;
+
+ /**
+ * Opens each directory in \p dirs in a separate tab. If \a splitView is set,
+ * 2 directories are collected within one tab.
+ * \pre \a dirs must contain at least one url.
*/
- void openDirectories(const QList<KUrl>& dirs);
+ void openDirectories(const QList<QUrl> &dirs, bool splitView);
/**
- * Opens the directory which contains the files \p files
- * and selects all files (implements the --select option
- * of Dolphin).
+ * Opens the directories which contain the files \p files and selects all files.
+ * If \a splitView is set, 2 directories are collected within one tab.
+ * \pre \a files must contain at least one url.
*/
- void openFiles(const QList<KUrl>& files);
+ void openFiles(const QList<QUrl>& files, bool splitView);
/**
* Returns the 'Create New...' sub menu which also can be shared
*/
KNewFileMenu* newFileMenu() const;
-public slots:
+ /**
+ * Switch the window's view containers' locations to display the home path
+ * for any which are currently displaying a location corresponding to or
+ * within mountPath.
+ *
+ * This typically done after unmounting a disk at mountPath to ensure that
+ * the window is not displaying an invalid location.
+ */
+ void setViewsToHomeIfMountPathOpen(const QString& mountPath);
+
+ bool isFoldersPanelEnabled() const;
+ bool isInformationPanelEnabled() const;
+
+public Q_SLOTS:
+ /**
+ * Opens each directory in \p dirs in a separate tab. If \a splitView is set,
+ * 2 directories are collected within one tab.
+ * \pre \a dirs must contain at least one url.
+ *
+ * @note this function is overloaded so that it is callable via DBus.
+ */
+ void openDirectories(const QStringList &dirs, bool splitView);
+
+ /**
+ * Opens the directories which contain the files \p files and selects all files.
+ * If \a splitView is set, 2 directories are collected within one tab.
+ * \pre \a files must contain at least one url.
+ *
+ * @note this is overloaded so that this function is callable via DBus.
+ */
+ void openFiles(const QStringList &files, bool splitView);
+
+ /**
+ * Tries to raise/activate the Dolphin window.
+ */
+ void activateWindow();
+
+ /**
+ * Determines if a URL is open in any tab.
+ * @note Use of QString instead of QUrl is required to be callable via DBus.
+ *
+ * @param url URL to look for
+ * @returns true if url is currently open in a tab, false otherwise.
+ */
+ bool isUrlOpen(const QString &url);
+
+
/**
* Pastes the clipboard data into the currently selected folder
* of the active view. If not exactly one folder is selected,
*/
void pasteIntoFolder();
- /**
- * Returns the main window ID used through DBus.
- */
- int getId() const;
-
/**
* Implementation of the MainWindowAdaptor/QDBusAbstractAdaptor interface.
* Inform all affected dolphin components (panels, views) of an URL
* change.
*/
- void changeUrl(const KUrl& url);
+ void changeUrl(const QUrl& url);
/**
* The current directory of the Terminal Panel has changed, probably because
* the user entered a 'cd' command. This slot calls changeUrl(url) and makes
* sure that the panel keeps the keyboard focus.
*/
- void slotTerminalDirectoryChanged(const KUrl& url);
+ void slotTerminalDirectoryChanged(const QUrl& url);
/** Stores all settings and quits Dolphin. */
void quit();
-signals:
+ /**
+ * Opens a new tab in the background showing the URL \a url.
+ */
+ void openNewTab(const QUrl& url);
+
+ /**
+ * Opens a new tab showing the URL \a url and activate it.
+ */
+ void openNewTabAndActivate(const QUrl &url);
+
+ /**
+ * Opens a new window showing the URL \a url.
+ */
+ void openNewWindow(const QUrl &url);
+
+ /** @see GeneralSettings::splitViewChanged() */
+ void slotSplitViewChanged();
+
+Q_SIGNALS:
/**
* Is sent if the selection of the currently active view has
* been changed.
* Is sent if the url of the currently active view has
* been changed.
*/
- void urlChanged(const KUrl& url);
+ void urlChanged(const QUrl& url);
/**
* Is emitted if information of an item is requested to be shown e. g. in the panel.
*/
void requestItemInfo(const KFileItem& item);
+ /**
+ * It is emitted when in the current view, files are changed,
+ * or dirs have files/removed from them.
+ */
+ void fileItemsChanged(const KFileItemList &changedFileItems);
+
/**
* Is emitted if the settings have been changed.
*/
protected:
/** @see QWidget::showEvent() */
- virtual void showEvent(QShowEvent* event);
+ void showEvent(QShowEvent* event) override;
/** @see QMainWindow::closeEvent() */
- virtual void closeEvent(QCloseEvent* event);
+ void closeEvent(QCloseEvent* event) override;
/** @see KMainWindow::saveProperties() */
- virtual void saveProperties(KConfigGroup& group);
+ void saveProperties(KConfigGroup& group) override;
/** @see KMainWindow::readProperties() */
- virtual void readProperties(const KConfigGroup& group);
+ void readProperties(const KConfigGroup& group) override;
+
+ /** Handles QWhatsThisClickedEvent and passes all others on. */
+ bool event(QEvent* event) override;
+ /** Handles QWhatsThisClickedEvent and passes all others on. */
+ bool eventFilter(QObject*, QEvent*) override;
+
+ /** Sets a sane initial window size **/
+ QSize sizeHint() const override;
+
+protected Q_SLOTS:
+ /**
+ * Calls the base method KXmlGuiWindow::saveNewToolbarConfig().
+ * Is also used to set toolbar constraints and UrlNavigator position
+ * based on the newly changed toolbar configuration.
+ */
+ void saveNewToolbarConfig() override;
-private slots:
+private Q_SLOTS:
/**
* Refreshes the views of the main window by recreating them according to
* the given Dolphin settings.
/** Replaces the URL navigator by a search box to find files. */
void find();
+ /** Updates the state of the search action according to the view container. */
+ void updateSearchAction();
+
/**
* Updates the text of the paste action dependent on
* the number of items which are in the clipboard.
*/
void toggleSplitView();
+ /** Dedicated action to open the stash:/ ioslave in split view. */
+ void toggleSplitStash();
+
/** Reloads the currently active view. */
void reloadView();
void disableStopAction();
void showFilterBar();
+ void toggleFilterBar();
/**
* Toggles between edit and browse mode of the navigation bar.
*/
void togglePanelLockState();
+ /**
+ * Is invoked if the Terminal panel got visible/invisible and takes care
+ * that the active view has the focus if the Terminal panel is invisible.
+ */
+ void slotTerminalPanelVisibilityChanged();
+
/** Goes back one step of the URL history. */
void goBack();
/** Changes the location to the home URL. */
void goHome();
- /**
- * Open the previous URL in the URL history in a new tab
- * if the middle mouse button is clicked.
- */
- void goBack(Qt::MouseButtons buttons);
+ /** Open the previous URL in the URL history in a new tab. */
+ void goBackInNewTab();
- /**
- * Open the next URL in the URL history in a new tab
- * if the middle mouse button is clicked.
- */
- void goForward(Qt::MouseButtons buttons);
+ /** Open the next URL in the URL history in a new tab. */
+ void goForwardInNewTab();
- /**
- * Open the URL one hierarchy above the current URL in a new tab
- * if the middle mouse button is clicked.
- */
- void goUp(Qt::MouseButtons buttons);
+ /** Open the URL one hierarchy above the current URL in a new tab. */
+ void goUpInNewTab();
- /**
- * Open the home URL in a new tab
- */
- void goHome(Qt::MouseButtons buttons);
+ /** * Open the home URL in a new tab. */
+ void goHomeInNewTab();
/** Opens Kompare for 2 selected files. */
void compareFiles();
*/
void toggleShowMenuBar();
+ /** Updates "Open Preferred Search Tool" action. */
+ void updateOpenPreferredSearchToolAction();
+
+ /** Opens preferred search tool for the current location. */
+ void openPreferredSearchTool();
+
/** Opens a terminal window for the current location. */
void openTerminal();
+ /** Focus a Terminal Panel. */
+ void focusTerminalPanel();
+
/** Opens the settings dialog for Dolphin. */
void editSettings();
*/
void slotSelectionChanged(const KFileItemList& selection);
- /** Emits the signal requestItemInfo(). */
- void slotRequestItemInfo(const KFileItem&);
-
/**
* Updates the state of the 'Back' and 'Forward' menu
* actions corresponding to the current history.
void openNewActivatedTab();
/**
- * Opens a new tab in the background showing the URL \a primaryUrl and the
- * optional URL \a secondaryUrl.
- */
- void openNewTab(const KUrl& primaryUrl, const KUrl& secondaryUrl = KUrl());
-
- /**
- * Opens a new tab showing the URL \a primaryUrl and the optional URL
- * \a secondaryUrl and activates the tab.
+ * Adds the current URL as an entry to the Places panel
*/
- void openNewActivatedTab(const KUrl& primaryUrl, const KUrl& secondaryUrl = KUrl());
+ void addToPlaces();
/**
* Opens the selected folder in a new tab.
*/
void openInNewWindow();
+ /**
+ * Show the target of the selected symlink
+ */
+ void showTarget();
+
/**
* Indicates in the statusbar that the execution of the command \a command
* has been finished.
* If the URL can be listed, open it in the current view, otherwise
* run it through KRun.
*/
- void handleUrl(const KUrl& url);
-
- /**
- * handleUrl() can trigger a stat job to see if the url can actually
- * be listed.
- */
- void slotHandleUrlStatFinished(KJob* job);
+ void handleUrl(const QUrl& url);
/**
* Is invoked when the write state of a folder has been changed and
*/
void openContextMenu(const QPoint& pos,
const KFileItem& item,
- const KUrl& url,
+ const QUrl& url,
const QList<QAction*>& customActions);
- void updateControlMenu();
- void updateToolBar();
- void slotControlButtonDeleted();
-
/**
- * Is called if a panel emits an error-message and shows
- * the error-message in the active view-container.
+ * Updates the menu that is by default at the right end of the toolbar.
+ *
+ * In true "simple by default" fashion, the menu only contains the most important
+ * and necessary actions to be able to use Dolphin. This is supposed to hold true even
+ * if the user does not know how to open a context menu. More advanced actions can be
+ * discovered through a sub-menu (@see KConfigWidgets::KHamburgerMenu::setMenuBarAdvertised()).
*/
- void slotPanelErrorMessage(const QString& error);
+ void updateHamburgerMenu();
/**
* Is called if the user clicked an item in the Places Panel.
* Reloads the view if \a url is the current URL already, and changes the
* current URL otherwise.
*/
- void slotPlaceActivated(const KUrl& url);
+ void slotPlaceActivated(const QUrl& url);
/**
* Is called if the another view has been activated by changing the current
void tabCountChanged(int count);
/**
- * Sets the window caption to url.fileName() if this is non-empty,
- * "/" if the URL is "file:///", and url.protocol() otherwise.
+ * Updates the Window Title with the caption from the active view container
+ */
+ void updateWindowTitle();
+
+ /**
+ * This slot is called when the user requested to unmount a removable media
+ * from the places menu
+ */
+ void slotStorageTearDownFromPlacesRequested(const QString& mountPath);
+
+ /**
+ * This slot is called when the user requested to unmount a removable media
+ * _not_ from the dolphin's places menu (from the notification area for e.g.)
+ * This slot is basically connected to each removable device's
+ * Solid::StorageAccess::teardownRequested(const QString & udi)
+ * signal through the places panel.
+ */
+ void slotStorageTearDownExternallyRequested(const QString& mountPath);
+
+ /**
+ * Is called when the view has finished loading the directory.
+ */
+ void slotDirectoryLoadingCompleted();
+
+ /**
+ * Is called when the user middle clicks a toolbar button.
+ *
+ * Here middle clicking Back/Forward/Up/Home will open the resulting
+ * folder in a new tab.
+ */
+ void slotToolBarActionMiddleClicked(QAction *action);
+
+ /**
+ * Is called before the Back popup menu is shown. This slot will populate
+ * the menu with history data
+ */
+ void slotAboutToShowBackPopupMenu();
+
+ /**
+ * This slot is used by the Back Popup Menu to go back to a specific
+ * history index. The QAction::data will carry an int with the index
+ * to go to.
+ */
+ void slotGoBack(QAction* action);
+
+ /**
+ * Middle clicking Back/Forward will open the resulting folder in a new tab.
+ */
+ void slotBackForwardActionMiddleClicked(QAction *action);
+
+ /**
+ * Is called before the Forward popup menu is shown. This slot will populate
+ * the menu with history data
*/
- void setUrlAsCaption(const KUrl& url);
+ void slotAboutToShowForwardPopupMenu();
+ /**
+ * This slot is used by the Forward Popup Menu to go forward to a specific
+ * history index. The QAction::data will carry an int with the index
+ * to go to.
+ */
+ void slotGoForward(QAction* action);
private:
+ /**
+ * Sets up the various menus and actions and connects them.
+ */
void setupActions();
- void setupDockWidgets();
- void updateEditActions();
- void updateViewActions();
- void updateGoActions();
-
- void createControlButton();
- void deleteControlButton();
/**
- * Adds the action \p action to the menu \p menu in
- * case if it has not added already to the toolbar.
- * @return True if the action has been added to the menu.
+ * Sets up the dock widgets and their panels.
*/
- bool addActionToMenu(QAction* action, KMenu* menu);
+ void setupDockWidgets();
+
+ void updateFileAndEditActions();
+ void updateViewActions();
+ void updateGoActions();
/**
* Connects the signals from the created DolphinView with
*/
void updateSplitAction();
+ /**
+ * Sets the window sides the toolbar may be moved to based on toolbar contents.
+ */
+ void updateAllowedToolbarAreas();
+
bool isKompareInstalled() const;
/**
QAction* dockAction,
const QString& actionName);
+ /** Adds "What's This?" texts to many widgets and StandardActions. */
+ void setupWhatsThis();
+
+ /** Returns preferred search tool as configured in "More Search Tools" menu. */
+ QPointer<QAction> preferredSearchTool();
+
+ /**
+ * Adds this action to the mainWindow's toolbar and saves the change
+ * in the users ui configuration file.
+ * This method is only needed for migration and should be removed once we can expect
+ * that pretty much all users have been migrated. Remove in 2026 because that's when
+ * even the most risk-averse distros will already have been forced to upgrade.
+ * @return true if successful. Otherwise false.
+ */
+ bool addHamburgerMenuToToolbar();
+
private:
/**
* Implements a custom error handling for the undo manager. This
{
public:
UndoUiInterface();
- virtual ~UndoUiInterface();
- virtual void jobError(KIO::Job* job);
+ ~UndoUiInterface() override;
+ void jobError(KIO::Job* job) override;
};
KNewFileMenu* m_newFileMenu;
+ KHelpMenu* m_helpMenu;
DolphinTabWidget* m_tabWidget;
DolphinViewContainer* m_activeViewContainer;
- int m_id;
DolphinViewActionHandler* m_actionHandler;
DolphinRemoteEncoding* m_remoteEncoding;
- QWeakPointer<DolphinSettingsDialog> m_settingsDialog;
+ QPointer<DolphinSettingsDialog> m_settingsDialog;
+ DolphinBookmarkHandler* m_bookmarkHandler;
// Members for the toolbar menu that is shown when the menubar is hidden:
QToolButton* m_controlButton;
QTimer* m_updateToolBarTimer;
- KIO::Job* m_lastHandleUrlStatJob;
+ KIO::OpenUrlJob *m_lastHandleUrlOpenJob;
+
+ TerminalPanel* m_terminalPanel;
+ PlacesPanel* m_placesPanel;
+ bool m_tearDownFromPlacesRequested;
+
+ KToolBarPopupAction* m_backAction;
+ KToolBarPopupAction* m_forwardAction;
+
+ QMenu m_searchTools;
+ KFileItemActions m_fileItemActions;
+
};
inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
return m_newFileMenu;
}
-inline int DolphinMainWindow::getId() const
-{
- return m_id;
-}
-
#endif // DOLPHIN_MAINWINDOW_H
projects / dolphin.git / blobdiff