/*************************************************************************** * 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 * ***************************************************************************/ #ifndef DOLPHINVIEWCONTAINER_H #define DOLPHINVIEWCONTAINER_H #include "config-dolphin.h" #include "views/dolphinview.h" #include #include #include #include #include #include #include #ifdef KF5Activities_FOUND namespace KActivities { class ResourceInstance; } #endif class FilterBar; class KMessageWidget; class QUrl; class KUrlNavigator; class DolphinSearchBox; class DolphinStatusBar; /** * @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: 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. */ QUrl url() 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(); const KUrlNavigator* urlNavigator() const; KUrlNavigator* urlNavigator(); const DolphinView* view() const; DolphinView* view(); /** * 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; /** * 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); 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 to the user. It is * calculated depending on settings, if a search is active and other * factors. */ QString caption() const; public 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); signals: /** * Is emitted whenever the filter bar has changed its visibility state. */ void showFilterBarChanged(bool shown); /** * 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); private 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); /** * 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); /** * 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(); /** * 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 stopDirectoryLoading(); void slotStatusBarZoomLevelChanged(int zoomLevel); /** * Slot that calls showMessage(msg, Error). */ void showErrorMessage(const QString& msg); 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(); private: QVBoxLayout* m_topLayout; QWidget* m_navigatorWidget; KUrlNavigator* m_urlNavigator; QPushButton* m_emptyTrashButton; DolphinSearchBox* m_searchBox; bool m_searchModeEnabled; KMessageWidget* m_messageWidget; DolphinView* 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; #ifdef KF5Activities_FOUND private: KActivities::ResourceInstance * m_activityResourceInstance; #endif }; #endif // DOLPHINVIEWCONTAINER_H