X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/2f47863c68bb0ac0417eed76f713ced651a4908a..502a5c86feb0015c42f052d242c8115de320a38e:/src/dolphinviewcontainer.h diff --git a/src/dolphinviewcontainer.h b/src/dolphinviewcontainer.h index da317761b..b5bcc78ad 100644 --- a/src/dolphinviewcontainer.h +++ b/src/dolphinviewcontainer.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2007 by Peter Penz * + * 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 * @@ -17,39 +17,39 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * ***************************************************************************/ - #ifndef DOLPHINVIEWCONTAINER_H #define DOLPHINVIEWCONTAINER_H -#include "dolphinview.h" +#include "config-dolphin.h" +#include "views/dolphinview.h" -#include -#include -#include +#include +#include +#include +#include -#include +#include +#include +#include -#include -#include -#include -#include -#include +#ifdef KF5Activities_FOUND +namespace KActivities { + class ResourceInstance; +} +#endif class FilterBar; -class KUrl; -class DolphinModel; +class KMessageWidget; +class QUrl; class KUrlNavigator; -class DolphinDirLister; -class DolphinMainWindow; -class DolphinSortFilterProxyModel; +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 +62,21 @@ class DolphinViewContainer : public QWidget Q_OBJECT public: - DolphinViewContainer(DolphinMainWindow* mainwindow, - QWidget *parent, - const KUrl& url); + enum MessageType + { + Information, + Warning, + Error + }; - virtual ~DolphinViewContainer(); - - /** - * 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,14 +85,18 @@ public: void setActive(bool active); bool isActive() const; - const DolphinStatusBar* statusBar() const; - DolphinStatusBar* statusBar(); - /** - * Returns true, if the URL shown by the navigation bar is editable. - * @see KUrlNavigator + * 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. */ - bool isUrlEditable() const; + void setAutoGrabFocus(bool grab); + bool autoGrabFocus() const; + + QString currentSearchText() const; + + const DolphinStatusBar* statusBar() const; + DolphinStatusBar* statusBar(); const KUrlNavigator* urlNavigator() const; KUrlNavigator* urlNavigator(); @@ -105,26 +104,54 @@ public: 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 refresh(); + 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(); + public slots: /** - * Popups the filter bar above the status bar if \a show is true. + * 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 showFilterBar(bool show); + void setUrl(const QUrl& url); /** - * 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. + * 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 updateStatusBar(); + void setFilterBarVisible(bool visible); signals: /** @@ -132,28 +159,72 @@ signals: */ 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: - void updateProgress(int percent); + /** + * 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 slotDirListerCompleted(); + 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); /** - * 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 activation of multiple files. The files get started by + * the corresponding applications. */ - void openFile(const KUrl& url); + void slotItemsActivated(const KFileItemList& items); /** * Shows the information for the item \a item inside the statusbar. If the @@ -161,15 +232,6 @@ private slots: */ 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(); /** @@ -179,109 +241,104 @@ private slots: void setNameFilter(const QString& nameFilter); /** - * Opens the context menu on the current mouse position. - * @item File item context. If item is null, the context menu - * should be applied to \a url. - * @url URL which contains \a item. - * @customActions Actions that should be added to the context menu, - * if the file item is null. + * Marks the view container as active + * (see DolphinViewContainer::setActive()). */ - void openContextMenu(const KFileItem& item, - const KUrl& url, - const QList& customActions); + 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. + * Saves the currently used URL completion mode of + * the URL navigator. */ - void saveRootUrl(const KUrl& url); + void saveUrlCompletionMode(KCompletion::CompletionMode completion); + + void slotReturnPressed(); /** - * Is connected with the URL navigator and drops the URLs - * above the destination \a destination. + * Gets the search URL from the searchbox and starts searching. */ - void dropUrls(const KUrl& destination, QDropEvent* event); + void startSearching(); + void closeSearchBox(); /** - * 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. + * Stops the loading of a directory. Is connected with the "stopPressed" signal + * from the statusbar. */ - void redirect(const KUrl& oldUrl, const KUrl& newUrl); + void stopDirectoryLoading(); - /** Requests the focus for the view \a m_view. */ - void requestFocus(); + void slotStatusBarZoomLevelChanged(int zoomLevel); + + /** + * Slot that calls showMessage(msg, Error). + */ + void showErrorMessage(const QString& msg); private: - bool m_showProgress; - bool m_isFolderWritable; + /** + * @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(); - DolphinMainWindow* m_mainWindow; +private: QVBoxLayout* m_topLayout; + QWidget* m_navigatorWidget; KUrlNavigator* m_urlNavigator; + QPushButton* m_emptyTrashButton; + DolphinSearchBox* m_searchBox; + 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; - DolphinModel* m_dolphinModel; - DolphinDirLister* m_dirLister; - DolphinSortFilterProxyModel* m_proxyModel; +#ifdef KF5Activities_FOUND +private: + KActivities::ResourceInstance * m_activityResourceInstance; +#endif }; -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