/* * SPDX-FileCopyrightText: 2007 Peter Penz * * SPDX-License-Identifier: GPL-2.0-or-later */ #ifndef DOLPHINVIEWCONTAINER_H #define DOLPHINVIEWCONTAINER_H #include "config-dolphin.h" #include "dolphinurlnavigator.h" #include "selectionmode/bottombar.h" #include "views/dolphinview.h" #include #include #include #include #include #include #include #include namespace Admin { class Bar; } class FilterBar; class QAction; class QGridLayout; class QUrl; class DolphinSearchBox; class DolphinStatusBar; 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, compact and details are supported. Currently * Dolphin allows to have up to two views inside the main window. * * @see DolphinView * @see FilterBar * @see KUrlNavigator * @see DolphinStatusBar */ class DolphinViewContainer : public QWidget { Q_OBJECT public: 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; /** * @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 * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() * are emitted. * @see DolphinViewContainer::urlNavigator() */ void setUrl(const QUrl &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. */ 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(); 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. */ void searchModeEnabledChanged(bool enabled); void selectionModeChanged(bool enabled); /** * 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 writeStateChanged(bool isFolderWritable); /** * 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 * 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 delayedStatusBarUpdate(); /** * Is invoked by DolphinViewContainer::delayedStatusBarUpdate() and * updates the status bar synchronously. */ void updateStatusBar(); /** * 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 slotDirectoryLoadingCompleted(); /** * Updates the statusbar to show, that the directory loading has * been canceled. */ void slotDirectoryLoadingCanceled(); /** * 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); /** * 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); /** * 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 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(); /** * Filters the currently shown items by \a nameFilter. All items * which contain the given filter string will be shown. */ void setNameFilter(const QString &nameFilter); /** * Marks the view container as active * (see DolphinViewContainer::setActive()). */ void activate(); /** * Is invoked if the signal urlAboutToBeChanged() from the URL navigator * is emitted. Tries to save the view-state. */ 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); /** * @see KUrlNavigator::urlSelectionRequested */ 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); /** Requests the focus for the view \a m_view. */ void requestFocus(); /** * 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://). */ bool isSearchUrl(const QUrl &url) const; /** * Saves the state of the current view: contents position, * root 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; private: 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 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 m_urlNavigatorConnected; DolphinSearchBox *m_searchBox; bool m_searchModeEnabled; /// 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; KMessageWidget *m_messageWidget; /// A bar shown at the top of the view to signify that selection mode is currently active. SelectionMode::TopBar *m_selectionModeTopBar; 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_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