X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/e54e6a9cdbc0e37e7c81abcea4e69838cddabaa3..e9bd295b:/src/dolphinviewcontainer.h diff --git a/src/dolphinviewcontainer.h b/src/dolphinviewcontainer.h index b4f799cb1..f78f85e55 100644 --- a/src/dolphinviewcontainer.h +++ b/src/dolphinviewcontainer.h @@ -1,55 +1,41 @@ -/*************************************************************************** - * 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-kactivities.h" +#include "dolphinurlnavigator.h" +#include "views/dolphinview.h" -#include -#include -#include +#include +#include +#include -#include +#include +#include +#include -#include -#include -#include -#include -#include +#ifdef HAVE_KACTIVITIES +namespace KActivities { + class ResourceInstance; +} +#endif class FilterBar; -class KUrl; -class DolphinModel; -class KUrlNavigator; -class DolphinDirLister; -class DolphinMainWindow; -class DolphinSortFilterProxyModel; +class KMessageWidget; +class QUrl; +class DolphinSearchBox; class DolphinStatusBar; -class QModelIndex; /** * @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,26 +48,21 @@ class DolphinViewContainer : public QWidget Q_OBJECT public: - DolphinViewContainer(DolphinMainWindow* mainwindow, - QWidget *parent, - const KUrl& url); - - virtual ~DolphinViewContainer(); + enum MessageType + { + Information, + Warning, + Error + }; - /** - * 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 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. */ - const KUrl& url() const; + QUrl url() const; /** * If \a active is true, the view container will marked as active. The active @@ -90,71 +71,239 @@ public: 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(); /** - * Returns true, if the URL shown by the navigation bar is editable. - * @see KUrlNavigator + * @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() */ - bool isUrlEditable() const; + DolphinUrlNavigator *urlNavigator(); - const KUrlNavigator* urlNavigator() const; - KUrlNavigator* 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(); + + /** + * 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 readSettings(); + /** Returns true, if the filter bar is visible. */ bool isFilterBarVisible() const; -public slots: + + /** Returns true if the search mode is enabled. */ + bool isSearchModeEnabled() const; + /** - * Popups the filter bar above the status bar if \a show is true. + * @return Text that should be used for the current URL when creating + * a new place. */ - void showFilterBar(bool show); + QString placesText() const; /** - * 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. + * Reload the view of this container. This will also hide messages in a messagewidget. */ - void updateStatusBar(); + void reload(); -signals: + /** + * @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(); + +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); + +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); + + /** + * 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(); + + void updateDirectoryLoadingProgress(int percent); + + void updateDirectorySortingProgress(int percent); -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); - /** 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(); @@ -165,101 +314,124 @@ private slots: void setNameFilter(const QString& nameFilter); /** - * 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. + * Marks the view container as active + * (see DolphinViewContainer::setActive()). */ - void openContextMenu(const KFileItem& item, const KUrl& url); + void activate(); /** - * Saves the position of the contents to the - * current history element. + * Is invoked if the signal urlAboutToBeChanged() from the URL navigator + * is emitted. Tries to save the view-state. */ - void saveContentsPos(int x, int y); + void slotUrlNavigatorLocationAboutToBeChanged(const QUrl& url); /** - * Restores the contents position of the view, if the view - * is part of the history. + * Restores the current view to show \a url and assures + * that the root URL of the view is respected. */ - void restoreContentsPos(); + void slotUrlNavigatorLocationChanged(const QUrl& url); /** - * Marks the view container as active - * (see DolphinViewContainer::setActive()). + * @see KUrlNavigator::urlSelectionRequested */ - void activate(); + void slotUrlSelectionRequested(const QUrl& url); /** - * Restores the current view to show \a url and assures - * that the root URL of the view is respected. + * 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 restoreView(const KUrl& url); + void redirect(const QUrl& oldUrl, const QUrl& newUrl); + + /** Requests the focus for the view \a m_view. */ + void requestFocus(); /** - * Saves the root URL of the current URL \a url - * into the URL navigator. + * Gets the search URL from the searchbox and starts searching. */ - void saveRootUrl(const KUrl& url); + void startSearching(); + void closeSearchBox(); -private: /** - * Returns the default text of the status bar, if no item is - * selected. + * Stops the loading of a directory. Is connected with the "stopPressed" signal + * from the statusbar. */ - QString defaultStatusBarText() const; + void stopDirectoryLoading(); + + void slotStatusBarZoomLevelChanged(int zoomLevel); /** - * Returns the text for the status bar, if at least one item - * is selected. + * Slot that calls showMessage(msg, Error). */ - QString selectionStatusBarText() const; + void showErrorMessage(const QString& msg); -private: - bool m_showProgress; + /** + * Is invoked when a KFilePlacesModel has been changed + * @see DolphinPlacesModelSingleton::instance().placesModel() + */ + void slotPlacesModelChanged(); - DolphinMainWindow* m_mainWindow; - QVBoxLayout* m_topLayout; - KUrlNavigator* m_urlNavigator; + void slotHiddenFilesShownChanged(bool showHiddenFiles); + void slotSortHiddenLastChanged(bool hiddenLast); - DolphinView* m_view; + void slotOpenUrlFinished(KJob* job); - FilterBar* m_filterBar; - DolphinStatusBar* m_statusBar; +private: + /** + * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://). + */ + bool isSearchUrl(const QUrl& url) const; - DolphinModel* m_dolphinModel; - DolphinDirLister* m_dirLister; - DolphinSortFilterProxyModel* m_proxyModel; -}; + /** + * Saves the state of the current view: contents position, + * root URL, ... + */ + void saveViewState(); -inline const DolphinStatusBar* DolphinViewContainer::statusBar() const -{ - return m_statusBar; -} + /** + * Restores the state of the current view iff the URL navigator contains a + * non-empty location state. + */ + void tryRestoreViewState(); -inline DolphinStatusBar* DolphinViewContainer::statusBar() -{ - return m_statusBar; -} +private: + QVBoxLayout* m_topLayout; -inline const KUrlNavigator* DolphinViewContainer::urlNavigator() const -{ - return 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; -inline KUrlNavigator* DolphinViewContainer::urlNavigator() -{ - return 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; + KMessageWidget* m_messageWidget; -inline const DolphinView* DolphinViewContainer::view() const -{ - return m_view; -} + DolphinView* m_view; -inline DolphinView* DolphinViewContainer::view() -{ - return m_view; -} + FilterBar* m_filterBar; + + 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; + +#ifdef HAVE_KACTIVITIES +private: + KActivities::ResourceInstance * m_activityResourceInstance; +#endif +}; #endif // DOLPHINVIEWCONTAINER_H