X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/adde3d4e3cd21d35be78c6a827b4b69a05d6e10c..d27ee07d:/src/dolphinviewcontainer.h diff --git a/src/dolphinviewcontainer.h b/src/dolphinviewcontainer.h index 7586dc13f..0c8b184fe 100644 --- a/src/dolphinviewcontainer.h +++ b/src/dolphinviewcontainer.h @@ -1,52 +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 -#include -#include -#include +#include "config-dolphin.h" +#include "dolphinurlnavigator.h" +#include "selectionmode/bottombar.h" +#include "views/dolphinview.h" -#include +#include +#include +#include #include +#include #include -#include +#if HAVE_KACTIVITIES +namespace KActivities +{ +class ResourceInstance; +} +#endif class FilterBar; -class KUrl; -class DolphinModel; -class KUrlNavigator; -class DolphinDirLister; +class KMessageWidget; +class QAction; +class QGridLayout; +class QUrl; class DolphinSearchBox; -class DolphinSortFilterProxyModel; 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, 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 @@ -59,14 +56,17 @@ class DolphinViewContainer : public QWidget Q_OBJECT public: - DolphinViewContainer(const KUrl& url, QWidget* parent); - virtual ~DolphinViewContainer(); + enum MessageType { Information, Warning, Error }; + + 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. */ - KUrl url() const; + QUrl url() const; + KFileItem rootItem() const; /** * If \a active is true, the view container will marked as active. The active @@ -75,31 +75,137 @@ public: void setActive(bool active); bool isActive() const; - const DolphinStatusBar* statusBar() const; - DolphinStatusBar* statusBar(); + /** + * 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 KUrlNavigator* urlNavigator() const; - KUrlNavigator* urlNavigator(); + 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(); - const DolphinView* view() const; - DolphinView* view(); + /** + * @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 \msg with the given type non-modal above + * the view-content. + */ + void showMessage(const QString &msg, MessageType type); /** * Refreshes the view container to get synchronized with the (updated) Dolphin settings. */ - void refresh(); + void readSettings(); /** Returns true, if the filter bar is visible. */ bool isFilterBarVisible() const; + /** Returns true if the search mode is enabled. */ + bool isSearchModeEnabled() const; + /** - * 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. + * @return Text that should be used for the current URL when creating + * a new place. */ - void setSearchModeEnabled(bool enabled); - bool isSearchModeEnabled() const; + 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 slots: +public Q_SLOTS: /** * Sets the current active URL, where all actions are applied. The * URL navigator is synchronized with this URL. The signals @@ -107,7 +213,7 @@ public slots: * are emitted. * @see DolphinViewContainer::urlNavigator() */ - void setUrl(const KUrl& url); + void setUrl(const QUrl &url); /** * Popups the filter bar above the status bar if \a visible is true. @@ -116,11 +222,26 @@ public slots: */ void setFilterBarVisible(bool visible); -signals: + /** + * 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 @@ -130,19 +251,31 @@ signals: void writeStateChanged(bool isFolderWritable); /** - * Is emitted if the search mode has been enabled or disabled. - * (see DolphinViewContainer::setSearchModeEnabled() and - * DolphinViewContainer::isSearchModeEnabled()) + * Is emitted when the Caption has been changed. + * @see DolphinViewContainer::caption() */ - void searchModeChanged(bool enabled); + void captionChanged(); -private slots: + /** + * 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(); @@ -152,48 +285,57 @@ private slots: */ void updateStatusBar(); - void updateProgress(int percent); + 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. */ - void slotStartedPathLoading(); + void slotDirectoryLoadingStarted(); /** * Assures that the viewport position is restored and updates the * statusbar to reflect the current content. */ - void slotFinishedPathLoading(); + 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 slotItemTriggered(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); /** - * Opens a the file \a url by opening the corresponding application. - * Is connected with the signal urlIsFile() from DolphinDirLister and will - * get invoked if the user manually has entered a file into the URL navigator. + * Handles middle click of file. It opens the file passed using the second application associated with the file's mimetype. */ - void openFile(const KUrl& url); + 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); - - /** Shows the information \a msg inside the statusbar. */ - void showInfoMessage(const QString& msg); - - /** Shows the error message \a msg inside the statusbar. */ - void showErrorMessage(const QString& msg); - - /** Shows the "operation completed" message \a msg inside the statusbar. */ - void showOperationCompletedMessage(const QString& msg); + void showItemInfo(const KFileItem &item); void closeFilterBar(); @@ -201,7 +343,7 @@ 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 @@ -210,106 +352,132 @@ private slots: void activate(); /** - * Saves the state of the current view: contents position, - * root URL, ... + * Is invoked if the signal urlAboutToBeChanged() from the URL navigator + * is emitted. Tries to save the view-state. */ - void saveViewState(); + 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 KUrl& url); + void slotUrlNavigatorLocationChanged(const QUrl &url); /** - * Is connected with the URL navigator and drops the URLs - * above the destination \a destination. + * @see KUrlNavigator::urlSelectionRequested */ - void dropUrls(const KUrl& destination, QDropEvent* event); + 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 KUrl& oldUrl, const KUrl& 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(KGlobalSettings::Completion completion); - - void slotHistoryChanged(); - /** * Gets the search URL from the searchbox and starts searching. - * @param text Text the user has entered into the searchbox. */ - void startSearching(const QString& text); + void startSearching(); void closeSearchBox(); /** * Stops the loading of a directory. Is connected with the "stopPressed" signal * from the statusbar. */ - void stopLoading(); + void stopDirectoryLoading(); + + void slotStatusBarZoomLevelChanged(int zoomLevel); + + /** + * Slot that calls showMessage(msg, Error). + */ + void showErrorMessage(const QString &msg); + + /** + * 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. nepomuksearch:// or filenamesearch://). + * @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. */ - bool isSearchUrl(const KUrl& url) const; + void tryRestoreViewState(); + + /** + * @return Path of nearest existing ancestor directory. + */ + QString getNearestExistingAncestorOfPath(const QString &path) const; private: - QVBoxLayout* m_topLayout; - KUrlNavigator* m_urlNavigator; - DolphinSearchBox* m_searchBox; + QGridLayout *m_topLayout; - DolphinView* m_view; + /** + * 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; - FilterBar* m_filterBar; + /** + * 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; - DolphinStatusBar* m_statusBar; - QTimer* m_statusBarTimer; // Triggers a delayed update - QElapsedTimer m_statusBarTimestamp; // Time in ms since last update + DolphinSearchBox *m_searchBox; + bool m_searchModeEnabled; - DolphinModel* m_dolphinModel; - DolphinDirLister* m_dirLister; - DolphinSortFilterProxyModel* m_proxyModel; -}; + KMessageWidget *m_messageWidget; -inline const DolphinStatusBar* DolphinViewContainer::statusBar() const -{ - 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 DolphinStatusBar* DolphinViewContainer::statusBar() -{ - return m_statusBar; -} + DolphinView *m_view; -inline const KUrlNavigator* DolphinViewContainer::urlNavigator() const -{ - return m_urlNavigator; -} + FilterBar *m_filterBar; -inline KUrlNavigator* DolphinViewContainer::urlNavigator() -{ - return m_urlNavigator; -} + /// A bar shown at the bottom of the view whose contents depend on what the user is currently doing. + SelectionMode::BottomBar *m_selectionModeBottomBar; -inline const DolphinView* DolphinViewContainer::view() const -{ - 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; -inline DolphinView* DolphinViewContainer::view() -{ - return m_view; -} +#if HAVE_KACTIVITIES +private: + KActivities::ResourceInstance *m_activityResourceInstance; +#endif +}; #endif // DOLPHINVIEWCONTAINER_H