/*************************************************************************** * 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 #include #include #include #include #include #include #include class FilterBar; class KUrl; 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, details and columns 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 KUrl& url, QWidget* parent); virtual ~DolphinViewContainer(); /** * Returns the current active URL, where all actions are applied. * The URL navigator is synchronized with this URL. */ KUrl 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; const DolphinStatusBar* statusBar() const; DolphinStatusBar* statusBar(); const KUrlNavigator* urlNavigator() const; KUrlNavigator* urlNavigator(); const DolphinView* view() const; DolphinView* view(); /** * Refreshes the view container to get synchronized with the (updated) Dolphin settings. */ void refresh(); /** 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; 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 KUrl& 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); /** * Is emitted if the search mode has been enabled or disabled. * (see DolphinViewContainer::setSearchModeEnabled() and * DolphinViewContainer::isSearchModeEnabled()) */ void searchModeChanged(bool enabled); 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. */ void delayedStatusBarUpdate(); /** * Is invoked by DolphinViewContainer::delayedStatusBarUpdate() and * updates the status bar synchronously. */ void updateStatusBar(); 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 slotStartedPathLoading(); /** * Assures that the viewport position is restored and updates the * statusbar to reflect the current content. */ void slotFinishedPathLoading(); /** * 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); /** * 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. */ void openFile(const KUrl& url); /** * 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 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(); /** * Saves the state of the current view: contents position, * root URL, ... */ void saveViewState(); /** * Restores the current view to show \a url and assures * that the root URL of the view is respected. */ void slotUrlNavigatorLocationChanged(const KUrl& url); /** * Is connected with the URL navigator and drops the URLs * above the destination \a destination. */ void dropUrls(const KUrl& destination, QDropEvent* event); /** * 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); /** 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 closeSearchBox(); /** * Stops the loading of a directory. Is connected with the "stopPressed" signal * from the statusbar. */ void stopLoading(); private: /** * @return True if the URL protocol is a search URL (e. g. nepomuksearch:// or filenamesearch://). */ bool isSearchUrl(const KUrl& url) const; private: QVBoxLayout* m_topLayout; KUrlNavigator* m_urlNavigator; DolphinSearchBox* m_searchBox; 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 }; inline const DolphinStatusBar* DolphinViewContainer::statusBar() const { return m_statusBar; } inline DolphinStatusBar* DolphinViewContainer::statusBar() { return m_statusBar; } inline const KUrlNavigator* DolphinViewContainer::urlNavigator() const { return m_urlNavigator; } inline KUrlNavigator* DolphinViewContainer::urlNavigator() { return m_urlNavigator; } inline const DolphinView* DolphinViewContainer::view() const { return m_view; } inline DolphinView* DolphinViewContainer::view() { return m_view; } #endif // DOLPHINVIEWCONTAINER_H