X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/d89548a828dd7d2e08acd85c329ccc2adf67bced..dd07a327:/src/dolphinviewcontainer.h diff --git a/src/dolphinviewcontainer.h b/src/dolphinviewcontainer.h index 4938835d8..a509bab3d 100644 --- a/src/dolphinviewcontainer.h +++ b/src/dolphinviewcontainer.h @@ -1,55 +1,49 @@ -/*************************************************************************** - * Copyright (C) 2007 by Peter Penz * - * * - * 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 + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ #ifndef DOLPHINVIEWCONTAINER_H #define DOLPHINVIEWCONTAINER_H -#include "dolphinview.h" +#include "config-dolphin.h" +#include "dolphinurlnavigator.h" +#include "selectionmode/bottombar.h" +#include "views/dolphinview.h" -#include -#include -#include +#include +#include +#include +#include -#include +#include +#include +#include -#include -#include -#include -#include -#include +#include +namespace Admin +{ +class Bar; +} class FilterBar; -class KUrl; -class DolphinModel; -class KUrlNavigator; -class DolphinDirLister; -class DolphinMainWindow; -class DolphinSortFilterProxyModel; +class QAction; +class QGridLayout; +class QUrl; +class DolphinSearchBox; class DolphinStatusBar; -class QModelIndex; +class KFileItemList; +namespace SelectionMode +{ +class TopBar; +} /** * @short Represents a view for the directory content * including the navigation bar, filter bar and status bar. * - * View modes for icons, details and columns are supported. Currently + * View modes for icons, compact and details are supported. Currently * Dolphin allows to have up to two views inside the main window. * * @see DolphinView @@ -62,12 +56,155 @@ class DolphinViewContainer : public QWidget Q_OBJECT public: - DolphinViewContainer(DolphinMainWindow* mainwindow, - QWidget *parent, - const KUrl& url); + DolphinViewContainer(const QUrl &url, QWidget *parent); + ~DolphinViewContainer() override; + + /** + * Returns the current active URL, where all actions are applied. + * 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 + * view container is defined as view where all actions are applied to. + */ + void setActive(bool active); + bool isActive() const; + + /** + * If \a grab is set to true, the container automatically grabs the focus + * as soon as the URL has been changed. Per default the grabbing + * of the focus is enabled. + */ + void setAutoGrabFocus(bool grab); + bool autoGrabFocus() const; + + QString currentSearchText() const; + + const DolphinStatusBar *statusBar() const; + DolphinStatusBar *statusBar(); + + /** + * @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(); + + /** + * @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 DolphinView *view() const; + DolphinView *view(); + + /** + * @param urlNavigator The UrlNavigator that is supposed to control + * this view. + */ + void connectUrlNavigator(DolphinUrlNavigator *urlNavigator); + + /** + * Disconnects the navigator that is currently controlling the view. + * This method completely reverses connectUrlNavigator(). + */ + void disconnectUrlNavigator(); + + /** + * 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 buttonActions = {}); + + /** + * Refreshes the view container to get synchronized with the (updated) Dolphin settings. + */ + void readSettings(); + + /** @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. + */ + QString placesText() const; + + /** + * Reload the view of this container. This will also hide messages in a messagewidget. + */ + 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; - virtual ~DolphinViewContainer(); + /** + * @return Returns a Caption suitable for display to the user. It is + * calculated depending on settings, if a search is active and other + * factors. + */ + QString caption() const; + + /** + * 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 @@ -75,91 +212,125 @@ public: * are emitted. * @see DolphinViewContainer::urlNavigator() */ - void setUrl(const KUrl& url); + void setUrl(const QUrl &url); /** - * Returns the current active URL, where all actions are applied. - * The URL navigator is synchronized with this URL. + * Popups the filter bar above the status bar if \a visible is true. + * It \a visible is true, it is assured that the filter bar gains + * the keyboard focus. */ - const KUrl& url() const; + void setFilterBarVisible(bool visible); /** - * If \a active is true, the view container will marked as active. The active - * view container is defined as view where all actions are applied to. + * 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 setActive(bool active); - bool isActive() const; + void setSearchModeEnabled(bool enabled); - const DolphinStatusBar* statusBar() const; - DolphinStatusBar* statusBar(); + /** Used to notify the m_selectionModeBottomBar that there is no other ViewContainer in the tab. */ + void slotSplitTabDisabled(); +Q_SIGNALS: /** - * Returns true, if the URL shown by the navigation bar is editable. - * @see KUrlNavigator + * Is emitted whenever the filter bar has changed its visibility state. */ - bool isUrlEditable() const; + void showFilterBarChanged(bool shown); + /** + * Is emitted whenever the search mode has changed its state. + */ + void searchModeEnabledChanged(bool enabled); - const KUrlNavigator* urlNavigator() const; - KUrlNavigator* urlNavigator(); + void selectionModeChanged(bool enabled); - const DolphinView* view() const; - DolphinView* view(); - /** - * Refreshes the view container to get synchronized with the (updated) Dolphin settings. + * Is emitted when the write state of the folder has been changed. The application + * should disable all actions like "Create New..." that depend on the write + * state. */ - void refresh(); + void writeStateChanged(bool isFolderWritable); - /** Returns true, if the filter bar is visible. */ - bool isFilterBarVisible() const; + /** + * 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); -public slots: /** - * Popups the filter bar above the status bar if \a show is true. + * Is emitted if a new tab should be opened for the URL \a url and set as active. */ - void showFilterBar(bool show); + 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 - * of selected files and the sum of the filesize is shown. + * of selected files and the sum of the filesize is shown. The update + * is done asynchronously, as getting the sum of the + * filesizes can be an expensive operation. + * Unless a previous OperationCompletedMessage was set very shortly before + * calling this method, it will be overwritten (see DolphinStatusBar::setMessage). + * Previous ErrorMessages however are always preserved. */ - void updateStatusBar(); + void delayedStatusBarUpdate(); -signals: /** - * Is emitted whenever the filter bar has changed its visibility state. + * Is invoked by DolphinViewContainer::delayedStatusBarUpdate() and + * updates the status bar synchronously. */ - void showFilterBarChanged(bool shown); + void updateStatusBar(); -private slots: - void updateProgress(int percent); + /** + * Updates the statusbar to show an undetermined progress with the correct + * context information whether a searching or a directory loading is done. + */ + void slotDirectoryLoadingStarted(); /** * Assures that the viewport position is restored and updates the * statusbar to reflect the current content. */ - void slotDirListerCompleted(); + void slotDirectoryLoadingCompleted(); /** - * Handles clicking on an item + * Updates the statusbar to show, that the directory loading has + * been canceled. */ - void slotItemTriggered(const KFileItem& item); + void slotDirectoryLoadingCanceled(); /** - * Shows the information for the item \a item inside the statusbar. If the - * item is null, the default statusbar information is shown. + * Is called if the URL set by DolphinView::setUrl() represents + * a file and not a directory. Takes care to activate the file. */ - void showItemInfo(const KFileItem& item); + void slotUrlIsFileError(const QUrl &url); - /** Shows the information \a msg inside the statusbar. */ - void showInfoMessage(const QString& msg); + /** + * 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); - /** Shows the error message \a msg inside the statusbar. */ - void showErrorMessage(const QString& msg); + /** + * Handles activation of multiple files. The files get started by + * the corresponding applications. + */ + 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 "operation completed" message \a msg inside the statusbar. */ - void showOperationCompletedMessage(const QString& msg); + /** + * 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 closeFilterBar(); @@ -167,97 +338,160 @@ private slots: * 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 + * (see DolphinViewContainer::setActive()). + */ + void activate(); /** - * Opens the context menu on the current mouse position. - * @item File item context. If item is 0, the context menu - * should be applied to \a url. - * @url URL which contains \a item. + * Is invoked if the signal urlAboutToBeChanged() from the URL navigator + * is emitted. Tries to save the view-state. */ - void openContextMenu(const KFileItem& item, const KUrl& url); + void slotUrlNavigatorLocationAboutToBeChanged(const QUrl &url); /** - * Saves the position of the contents to the - * current history element. + * Restores the current view to show \a url and assures + * that the root URL of the view is respected. */ - void saveContentsPos(int x, int y); + void slotUrlNavigatorLocationChanged(const QUrl &url); /** - * Restores the contents position of the view, if the view - * is part of the history. + * @see KUrlNavigator::urlSelectionRequested */ - void restoreContentsPos(); + void slotUrlSelectionRequested(const QUrl &url); /** - * Marks the view container as active - * (see DolphinViewContainer::setActive()). + * 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 activate(); + void redirect(const QUrl &oldUrl, const QUrl &newUrl); + + /** Requests the focus for the view \a m_view. */ + void requestFocus(); /** - * Restores the current view to show \a url and assures - * that the root URL of the view is respected. + * Gets the search URL from the searchbox and starts searching. + */ + void startSearching(); + void openSearchBox(); + void closeSearchBox(); + + /** + * Stops the loading of a directory. Is connected with the "stopPressed" signal + * from the statusbar. + */ + void stopDirectoryLoading(); + + void slotStatusBarZoomLevelChanged(int zoomLevel); + + /** + * Creates and shows an error message based on \p message and \p kioErrorCode. + */ + void slotErrorMessageFromView(const QString &message, const int kioErrorCode); + + /** + * Slot that calls showMessage(message, KMessageWidget::Error). + */ + void showErrorMessage(const QString &message); + + /** + * Is invoked when a KFilePlacesModel has been changed + * @see DolphinPlacesModelSingleton::instance().placesModel() + */ + void slotPlacesModelChanged(); + + void slotHiddenFilesShownChanged(bool showHiddenFiles); + void slotSortHiddenLastChanged(bool hiddenLast); + void slotCurrentDirectoryRemoved(); + + void slotOpenUrlFinished(KJob *job); + +private: + /** + * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://). */ - void restoreView(const KUrl& url); + bool isSearchUrl(const QUrl &url) const; /** - * Saves the root URL of the current URL \a url - * into the URL navigator. + * Saves the state of the current view: contents position, + * root URL, ... */ - void saveRootUrl(const KUrl& url); - + void saveViewState(); + + /** + * Restores the state of the current view iff the URL navigator contains a + * non-empty location state. + */ + 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(); + /** - * Is connected with the URL navigator and drops the URLs - * above the destination \a destination. + * @return Preferred geometry of the small statusbar. */ - void dropUrls(const KUrl& destination, QDropEvent* event); + QRect preferredSmallStatusBarGeometry(); + +protected: + bool eventFilter(QObject *object, QEvent *event) override; private: - bool m_showProgress; + QGridLayout *m_topLayout; - DolphinMainWindow* m_mainWindow; - QVBoxLayout* m_topLayout; - KUrlNavigator* m_urlNavigator; + /** + * 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 m_urlNavigator; - DolphinView* m_view; + /** + * 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 m_urlNavigatorConnected; - FilterBar* m_filterBar; - DolphinStatusBar* m_statusBar; + DolphinSearchBox *m_searchBox; + bool m_searchModeEnabled; - DolphinModel* m_dolphinModel; - DolphinDirLister* m_dirLister; - DolphinSortFilterProxyModel* m_proxyModel; -}; + /// 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; -inline const DolphinStatusBar* DolphinViewContainer::statusBar() const -{ - return m_statusBar; -} + KMessageWidget *m_messageWidget; -inline DolphinStatusBar* DolphinViewContainer::statusBar() -{ - return m_statusBar; -} + /// A bar shown at the top of the view to signify that selection mode is currently active. + SelectionMode::TopBar *m_selectionModeTopBar; -inline const KUrlNavigator* DolphinViewContainer::urlNavigator() const -{ - return m_urlNavigator; -} + DolphinView *m_view; -inline KUrlNavigator* DolphinViewContainer::urlNavigator() -{ - return m_urlNavigator; -} + FilterBar *m_filterBar; -inline const DolphinView* DolphinViewContainer::view() const -{ - return m_view; -} + /// A bar shown at the bottom of the view whose contents depend on what the user is currently doing. + SelectionMode::BottomBar *m_selectionModeBottomBar; -inline DolphinView* DolphinViewContainer::view() -{ - return m_view; -} + DolphinStatusBar *m_statusBar; + QTimer *m_statusBarTimer; // Triggers a delayed update + QElapsedTimer m_statusBarTimestamp; // Time in ms since last update + bool m_autoGrabFocus; + /** + * The visual state to be applied to the next UrlNavigator that gets + * connected to this ViewContainer. + */ + std::unique_ptr m_urlNavigatorVisualState; +}; #endif // DOLPHINVIEWCONTAINER_H