-/***************************************************************************
- * Copyright (C) 2007 by Peter Penz <peter.penz19@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: 2007 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#ifndef DOLPHINVIEWCONTAINER_H
#define DOLPHINVIEWCONTAINER_H
-#include "config-kactivities.h"
+#include "config-dolphin.h"
+#include "dolphinurlnavigator.h"
+#include "selectionmode/bottombar.h"
#include "views/dolphinview.h"
-#include <KCompletion>
#include <KFileItem>
#include <KIO/Job>
+#include <KMessageWidget>
#include <KUrlNavigator>
#include <QElapsedTimer>
#include <QPushButton>
#include <QWidget>
-#ifdef HAVE_KACTIVITIES
-namespace KActivities {
- class ResourceInstance;
-}
-#endif
+#include <initializer_list>
+namespace Admin
+{
+class Bar;
+}
class FilterBar;
-class KMessageWidget;
+class QAction;
+class QGridLayout;
class QUrl;
-class KUrlNavigator;
-class DolphinSearchBox;
+namespace Search
+{
+class Bar;
+}
class DolphinStatusBar;
+class KFileItemList;
+namespace SelectionMode
+{
+class TopBar;
+}
+
+/**
+ * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
+ */
+bool isSearchUrl(const QUrl &url);
/**
* @short Represents a view for the directory content
Q_OBJECT
public:
- enum MessageType
- {
- Information,
- Warning,
- Error
- };
-
- DolphinViewContainer(const QUrl& url, QWidget* parent);
+ DolphinViewContainer(const QUrl &url, QWidget *parent);
~DolphinViewContainer() override;
/**
* The URL navigator is synchronized with this URL.
*/
QUrl url() const;
+ KFileItem rootItem() const;
/**
* If \a active is true, the view container will marked as active. The active
* as soon as the URL has been changed. Per default the grabbing
* of the focus is enabled.
*/
- void setAutoGrabFocus(bool grab);
- bool autoGrabFocus() const;
+ void setGrabFocusOnUrlChange(bool grabFocus);
+
+ const DolphinStatusBar *statusBar() const;
+ DolphinStatusBar *statusBar();
- QString currentSearchText() const;
+ /**
+ * @return An UrlNavigator that is controlling this view
+ * or nullptr if there is none.
+ * @see connectUrlNavigator()
+ * @see disconnectUrlNavigator()
+ *
+ * Use urlNavigatorInternalWithHistory() if you want to access the history.
+ * @see urlNavigatorInternalWithHistory()
+ */
+ const DolphinUrlNavigator *urlNavigator() const;
+ /**
+ * @return An UrlNavigator that is controlling this view
+ * or nullptr if there is none.
+ * @see connectUrlNavigator()
+ * @see disconnectUrlNavigator()
+ *
+ * Use urlNavigatorInternalWithHistory() if you want to access the history.
+ * @see urlNavigatorInternalWithHistory()
+ */
+ DolphinUrlNavigator *urlNavigator();
- const DolphinStatusBar* statusBar() const;
- DolphinStatusBar* statusBar();
+ /**
+ * @return An UrlNavigator that contains this view's history.
+ * Use urlNavigator() instead when not accessing the history.
+ */
+ const DolphinUrlNavigator *urlNavigatorInternalWithHistory() const;
+ /**
+ * @return An UrlNavigator that contains this view's history.
+ * Use urlNavigator() instead when not accessing the history.
+ */
+ DolphinUrlNavigator *urlNavigatorInternalWithHistory();
- const KUrlNavigator* urlNavigator() const;
- KUrlNavigator* urlNavigator();
+ const DolphinView *view() const;
+ DolphinView *view();
- const DolphinView* view() const;
- DolphinView* view();
+ /**
+ * @param urlNavigator The UrlNavigator that is supposed to control
+ * this view.
+ */
+ void connectUrlNavigator(DolphinUrlNavigator *urlNavigator);
/**
- * Shows the message \msg with the given type non-modal above
- * the view-content.
+ * Disconnects the navigator that is currently controlling the view.
+ * This method completely reverses connectUrlNavigator().
*/
- void showMessage(const QString& msg, MessageType type);
+ void disconnectUrlNavigator();
+
+ /**
+ * Sets the visibility of this objects search configuration user interface. This search bar is the primary interface in Dolphin to search for files and
+ * folders.
+ *
+ * The signal searchBarVisibilityChanged will be emitted when the new visibility state is different from the old.
+ *
+ * Typically an animation will play when the search bar is shown or hidden, so the visibility of the bar will not necessarily match @p visible when this
+ * method returns. Instead use isSearchBarVisible(), which will always communicate the visibility state the search bar is heading to.
+ *
+ * @see Search::Bar.
+ * @see isSearchBarVisible().
+ */
+ void setSearchBarVisible(bool visible);
+
+ /** @returns true if the search bar is visible while not being in the process to hide itself. */
+ bool isSearchBarVisible() const;
+
+ /**
+ * Moves keyboard focus to the search bar. The search term is fully selected to allow easy replacing.
+ */
+ void setFocusToSearchBar();
+
+ /**
+ * Sets a selection mode that is useful for quick and easy selecting or deselecting of files.
+ * This method is the central authority about enabling or disabling selection mode:
+ * All other classes that want to enable or disable selection mode should trigger a call of this method.
+ *
+ * This method sets the selection mode for the view of this viewContainer and sets the visibility of the
+ * selection mode top and bottom bar which also belong to this viewContainer.
+ *
+ * @param enabled Whether to enable or disable selection mode.
+ * @param actionCollection The collection of actions from which the actions on the bottom bar are retrieved.
+ * @param bottomBarContents The contents the bar is supposed to show after this call.
+ */
+ void setSelectionModeEnabled(bool enabled,
+ KActionCollection *actionCollection = nullptr,
+ SelectionMode::BottomBar::Contents bottomBarContents = SelectionMode::BottomBar::Contents::GeneralContents);
+ /** @see setSelectionModeEnabled() */
+ bool isSelectionModeEnabled() const;
+
+ /**
+ * Shows the message \message with the given type \messageType non-modal above the view-content.
+ * \buttonActions defines actions which the user can trigger as a response to this message. They are presented as buttons below the \message.
+ */
+ void showMessage(const QString &message, KMessageWidget::MessageType messageType, std::initializer_list<QAction *> buttonActions = {});
+
+ /**
+ * Forwards to DolphinStatusBar::showProgress(). Only exception: The button to cancel the task is hidden.
+ * @see DolphinStatusBar::showProgress().
+ */
+ void showProgress(const QString ¤tlyRunningTaskTitle, int progressPercent);
/**
* Refreshes the view container to get synchronized with the (updated) Dolphin settings.
*/
void readSettings();
- /** Returns true, if the filter bar is visible. */
+ /** @returns true, if the filter bar is visible.
+ * false, if it is hidden or currently animating towards a hidden state. */
bool isFilterBarVisible() const;
-
- /** Returns true if the search mode is enabled. */
- bool isSearchModeEnabled() const;
-
/**
* @return Text that should be used for the current URL when creating
* a new place.
*/
void reload();
+ /**
+ * @return Returns a Caption suitable for display in the window title.
+ * It is calculated depending on GeneralSettings::showFullPathInTitlebar().
+ * If it's false, it calls caption().
+ */
+ QString captionWindowTitle() const;
+
/**
* @return Returns a Caption suitable for display to the user. It is
* calculated depending on settings, if a search is active and other
*/
QString caption() const;
-public slots:
+ /**
+ * Disable/enable the behavior of "select child when moving to parent folder"
+ * offered by KUrlNavigator.
+ *
+ * See KUrlNavigator::urlSelectionRequested
+ */
+ void disableUrlNavigatorSelectionRequests();
+ void enableUrlNavigatorSelectionRequests();
+ void clearFilterBar();
+
+public Q_SLOTS:
/**
* Sets the current active URL, where all actions are applied. The
* URL navigator is synchronized with this URL. The signals
* are emitted.
* @see DolphinViewContainer::urlNavigator()
*/
- void setUrl(const QUrl& url);
+ void setUrl(const QUrl &url);
/**
* Popups the filter bar above the status bar if \a visible is true.
*/
void setFilterBarVisible(bool visible);
- /**
- * Enables the search mode, if \p enabled is true. In the search mode the URL navigator
- * will be hidden and replaced by a line editor that allows to enter a search term.
- */
- void setSearchModeEnabled(bool enabled);
+ /** Used to notify the m_selectionModeBottomBar that there is no other ViewContainer in the tab. */
+ void slotSplitTabDisabled();
-signals:
+Q_SIGNALS:
/**
* Is emitted whenever the filter bar has changed its visibility state.
*/
void showFilterBarChanged(bool shown);
/**
- * Is emitted whenever the search mode has changed its state.
+ * Is emitted whenever a change to the search bar's visibility is invoked. The visibility change might not have actually already taken effect by the time
+ * this signal is emitted because typically the showing and hiding is animated.
+ * @param visible The visibility state the search bar is going to end up at.
+ * @see Search::Bar.
+ * @see setSearchBarVisible().
+ * @see isSearchBarVisible().
*/
- void searchModeEnabledChanged(bool enabled);
+ void searchBarVisibilityChanged(bool visible);
+
+ void selectionModeChanged(bool enabled);
/**
* Is emitted when the write state of the folder has been changed. The application
*/
void writeStateChanged(bool isFolderWritable);
-private slots:
+ /**
+ * Is emitted when the Caption has been changed.
+ * @see DolphinViewContainer::caption()
+ */
+ void captionChanged();
+
+ /**
+ * Is emitted if a new tab should be opened in the background for the URL \a url.
+ */
+ void tabRequested(const QUrl &url);
+
+ /**
+ * Is emitted if a new tab should be opened for the URL \a url and set as active.
+ */
+ void activeTabRequested(const QUrl &url);
+
+private Q_SLOTS:
/**
* Updates the number of items (= number of files + number of
* directories) in the statusbar. If files are selected, the number
*/
void updateStatusBar();
- void updateDirectoryLoadingProgress(int percent);
-
- void updateDirectorySortingProgress(int percent);
-
/**
* Updates the statusbar to show an undetermined progress with the correct
* context information whether a searching or a directory loading is done.
* Is called if the URL set by DolphinView::setUrl() represents
* a file and not a directory. Takes care to activate the file.
*/
- void slotUrlIsFileError(const QUrl& url);
+ void slotUrlIsFileError(const QUrl &url);
/**
* Handles clicking on an item. If the item is a directory, the
* directory is opened in the view. If the item is a file, the file
* gets started by the corresponding application.
*/
- void slotItemActivated(const KFileItem& item);
+ void slotItemActivated(const KFileItem &item);
/**
* Handles activation of multiple files. The files get started by
* the corresponding applications.
*/
- void slotItemsActivated(const KFileItemList& items);
+ void slotItemsActivated(const KFileItemList &items);
+
+ /**
+ * Handles middle click of file. It opens the file passed using the second application associated with the file's mimetype.
+ */
+ void slotfileMiddleClickActivated(const KFileItem &item);
/**
* Shows the information for the item \a item inside the statusbar. If the
* item is null, the default statusbar information is shown.
*/
- void showItemInfo(const KFileItem& item);
+ void showItemInfo(const KFileItem &item);
void closeFilterBar();
* Filters the currently shown items by \a nameFilter. All items
* which contain the given filter string will be shown.
*/
- void setNameFilter(const QString& nameFilter);
+ void setNameFilter(const QString &nameFilter);
/**
* Marks the view container as active
* Is invoked if the signal urlAboutToBeChanged() from the URL navigator
* is emitted. Tries to save the view-state.
*/
- void slotUrlNavigatorLocationAboutToBeChanged(const QUrl& url);
+ void slotUrlNavigatorLocationAboutToBeChanged(const QUrl &url);
/**
* Restores the current view to show \a url and assures
* that the root URL of the view is respected.
*/
- void slotUrlNavigatorLocationChanged(const QUrl& url);
+ void slotUrlNavigatorLocationChanged(const QUrl &url);
/**
* @see KUrlNavigator::urlSelectionRequested
*/
- void slotUrlSelectionRequested(const QUrl& url);
+ void slotUrlSelectionRequested(const QUrl &url);
/**
* Is invoked when a redirection is done and changes the
* URL of the URL navigator to \a newUrl without triggering
* a reloading of the directory.
*/
- void redirect(const QUrl& oldUrl, const QUrl& newUrl);
+ void redirect(const QUrl &oldUrl, const QUrl &newUrl);
/** Requests the focus for the view \a m_view. */
void requestFocus();
- /**
- * Saves the currently used URL completion mode of
- * the URL navigator.
- */
- void saveUrlCompletionMode(KCompletion::CompletionMode completion);
-
- void slotReturnPressed();
-
- /**
- * Gets the search URL from the searchbox and starts searching.
- */
- void startSearching();
- void closeSearchBox();
-
/**
* Stops the loading of a directory. Is connected with the "stopPressed" signal
* from the statusbar.
void slotStatusBarZoomLevelChanged(int zoomLevel);
/**
- * Slot that calls showMessage(msg, Error).
+ * Creates and shows an error message based on \p message and \p kioErrorCode.
*/
- void showErrorMessage(const QString& msg);
+ void slotErrorMessageFromView(const QString &message, const int kioErrorCode);
+
+ /**
+ * Slot that calls showMessage(message, KMessageWidget::Error).
+ */
+ void showErrorMessage(const QString &message);
-private:
/**
- * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
+ * Is invoked when a KFilePlacesModel has been changed
+ * @see DolphinPlacesModelSingleton::instance().placesModel()
*/
- bool isSearchUrl(const QUrl& url) const;
+ void slotPlacesModelChanged();
+
+ void slotHiddenFilesShownChanged(bool showHiddenFiles);
+ void slotSortHiddenLastChanged(bool hiddenLast);
+ void slotCurrentDirectoryRemoved();
+ void slotOpenUrlFinished(KJob *job);
+
+private:
/**
* Saves the state of the current view: contents position,
* root URL, ...
*/
void tryRestoreViewState();
+ /**
+ * @return Path of nearest existing ancestor directory.
+ */
+ QString getNearestExistingAncestorOfPath(const QString &path) const;
+
+ /**
+ * Update the geometry of statusbar depending on what mode it is using.
+ */
+ void updateStatusBarGeometry();
+
+ /**
+ * @return Preferred geometry of the small statusbar.
+ */
+ QRect preferredSmallStatusBarGeometry();
+
+protected:
+ bool eventFilter(QObject *object, QEvent *event) override;
+
private:
- QVBoxLayout* m_topLayout;
- QWidget* m_navigatorWidget;
- KUrlNavigator* m_urlNavigator;
- QPushButton* m_emptyTrashButton;
- DolphinSearchBox* m_searchBox;
+ QGridLayout *m_topLayout;
+
+ /**
+ * The internal UrlNavigator which is never visible to the user.
+ * m_urlNavigator is used even when another UrlNavigator is controlling
+ * the view to keep track of this object's history.
+ */
+ std::unique_ptr<DolphinUrlNavigator> m_urlNavigator;
+
+ /**
+ * The UrlNavigator that is currently connected to the view.
+ * This is a nullptr if no UrlNavigator is connected.
+ * Otherwise it's one of the UrlNavigators visible in the toolbar.
+ */
+ QPointer<DolphinUrlNavigator> m_urlNavigatorConnected;
+
+ Search::Bar *m_searchBar;
bool m_searchModeEnabled;
- KMessageWidget* m_messageWidget;
- DolphinView* m_view;
+ /// A bar shown at the top of the view to signify that the view is currently viewed and acted on with elevated privileges.
+ Admin::Bar *m_adminBar;
+ /// An action to switch to the admin protocol. This variable will always be nullptr unless kio-admin was installed. @see Admin::WorkerIntegration.
+ QAction *m_authorizeToEnterFolderAction;
- FilterBar* m_filterBar;
+ KMessageWidget *m_messageWidget;
- DolphinStatusBar* m_statusBar;
- QTimer* m_statusBarTimer; // Triggers a delayed update
- QElapsedTimer m_statusBarTimestamp; // Time in ms since last update
- bool m_autoGrabFocus;
+ /// A bar shown at the top of the view to signify that selection mode is currently active.
+ SelectionMode::TopBar *m_selectionModeTopBar;
-#ifdef HAVE_KACTIVITIES
-private:
- KActivities::ResourceInstance * m_activityResourceInstance;
-#endif
+ DolphinView *m_view;
+
+ FilterBar *m_filterBar;
+
+ /// A bar shown at the bottom of the view whose contents depend on what the user is currently doing.
+ SelectionMode::BottomBar *m_selectionModeBottomBar;
+
+ DolphinStatusBar *m_statusBar;
+ QTimer *m_statusBarTimer; // Triggers a delayed update
+ QElapsedTimer m_statusBarTimestamp; // Time in ms since last update
+ bool m_grabFocusOnUrlChange;
+ /**
+ * The visual state to be applied to the next UrlNavigator that gets
+ * connected to this ViewContainer.
+ */
+ std::unique_ptr<DolphinUrlNavigator::VisualState> m_urlNavigatorVisualState;
};
#endif // DOLPHINVIEWCONTAINER_H
projects / dolphin.git / blobdiff