]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphinviewcontainer.h
KFileItemModel: interface cleanups
[dolphin.git] / src / dolphinviewcontainer.h
index b7cb4ca5be30787359a034694a57751ce8b40382..b3c48ccf98abef977f81978b5dce855a30ad0fa3 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2007 by Peter Penz <peter.penz@gmx.at>                  *
+ *   Copyright (C) 2007 by Peter Penz <peter.penz19@gmail.com>             *
  *                                                                         *
  *   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  *
  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  ***************************************************************************/
 
-
 #ifndef DOLPHINVIEWCONTAINER_H
 #define DOLPHINVIEWCONTAINER_H
 
-#include "dolphinview.h"
+#include <KFileItem>
+#include <KFileItemDelegate>
+#include <KGlobalSettings>
+#include <KIO/Job>
 
-#include <kfileitem.h>
-#include <kfileitemdelegate.h>
-#include <kio/job.h>
+#include <KUrlNavigator>
 
-#include <kurlnavigator.h>
+#include <QElapsedTimer>
+#include <QWidget>
 
-#include <QtGui/QKeyEvent>
-#include <QtCore/QLinkedList>
-#include <QtGui/QListView>
-#include <QtGui/QBoxLayout>
-#include <QtGui/QWidget>
+#include <views/dolphinview.h>
 
 class FilterBar;
 class KUrl;
-class DolphinModel;
 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 +55,14 @@ class DolphinViewContainer : public QWidget
     Q_OBJECT
 
 public:
-    DolphinViewContainer(DolphinMainWindow* mainwindow,
-                         QWidget *parent,
-                         const KUrl& url);
-
+    DolphinViewContainer(const KUrl& url, QWidget* parent);
     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);
-
     /**
      * Returns the current active URL, where all actions are applied.
      * The URL navigator is synchronized with this URL.
      */
-    const KUrl& url() const;
+    KUrl url() const;
 
     /**
      * If \a active is true, the view container will marked as active. The active
@@ -90,50 +71,49 @@ public:
     void setActive(bool active);
     bool isActive() const;
 
-    /**
-     * Triggers the renaming of the currently selected items, where
-     * the user must input a new name for the items.
-     */
-    void renameSelectedItems();
+    const DolphinStatusBar* statusBar() const;
+    DolphinStatusBar* statusBar();
+
+    const KUrlNavigator* urlNavigator() const;
+    KUrlNavigator* urlNavigator();
 
-    KFileItem fileItem(const QModelIndex& index) const;
+    const DolphinView* view() const;
+    DolphinView* view();
 
-    inline const DolphinStatusBar* statusBar() const;
-    inline DolphinStatusBar* statusBar();
+    const DolphinSearchBox* searchBox() const;
+    DolphinSearchBox* searchBox();
 
     /**
-     * Returns true, if the URL shown by the navigation bar is editable.
-     * @see KUrlNavigator
+     * Refreshes the view container to get synchronized with the (updated) Dolphin settings.
      */
-    bool isUrlEditable() const;
-
-    inline const KUrlNavigator* urlNavigator() const;
-    inline KUrlNavigator* urlNavigator();
-
-    inline const DolphinView* view() const;
-    inline DolphinView* view();
+    void readSettings();
 
     /** Returns true, if the filter bar is visible. */
     bool isFilterBarVisible() const;
 
     /**
-     * Return the DolphinMainWindow this View belongs to. It is guaranteed
-     * that we have one.
+     * 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.
      */
-    inline const DolphinMainWindow* mainWindow() const;
+    void setSearchModeEnabled(bool enabled);
+    bool isSearchModeEnabled() const;
 
 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 KUrl& 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:
     /**
@@ -141,19 +121,61 @@ 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);
+
+    /**
+     * Is emitted if the search mode has been enabled or disabled.
+     * (see DolphinViewContainer::setSearchModeEnabled() and
+     * DolphinViewContainer::isSearchModeEnabled())
+     */
+    void searchModeChanged(bool enabled);
+
 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();
 
     /**
-     * Updates the number of items (= number of directories + number of files)
-     * and shows this information in the statusbar.
+     * Assures that the viewport position is restored and updates the
+     * statusbar to reflect the current content.
      */
-    void updateItemCount();
+    void slotDirectoryLoadingCompleted();
 
     /**
-     * Handles clicking on an item
+     * 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);
 
     /**
      * Shows the information for the item \a item inside the statusbar. If the
@@ -167,112 +189,102 @@ private slots:
     /** 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 changeNameFilter(const QString& nameFilter);
+    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 DolphinView
+     * is emitted. Tries to save the view-state.
      */
-    void saveContentsPos(int x, int y);
+    void slotViewUrlAboutToBeChanged(const KUrl& url);
 
     /**
-     * Restores the contents position of the view, if the view
-     * is part of the history.
+     * Is invoked if the signal urlAboutToBeChanged() from the URL navigator
+     * is emitted. Tries to save the view-state.
      */
-    void restoreContentsPos();
+    void slotUrlNavigatorLocationAboutToBeChanged(const KUrl& url);
 
     /**
-     * Marks the view container as active
-     * (see DolphinViewContainer::setActive()).
+     * Restores the current view to show \a url and assures
+     * that the root URL of the view is respected.
      */
-    void activate();
+    void slotUrlNavigatorLocationChanged(const KUrl& url);
 
     /**
-     * Restores the current view to show \a url and assures
-     * that the root URL of the view is respected.
+     * Is connected with the URL navigator and drops the URLs
+     * above the destination \a destination.
      */
-    void restoreView(const KUrl& url);
+    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();
 
-private:
     /**
-     * Returns the default text of the status bar, if no item is
-     * selected.
+     * Gets the search URL from the searchbox and starts searching.
+     * @param text Text the user has entered into the searchbox.
      */
-    QString defaultStatusBarText() const;
+    void startSearching(const QString& text);
+    void closeSearchBox();
 
     /**
-     * Returns the text for the status bar, if at least one item
-     * is selected.
+     * Stops the loading of a directory. Is connected with the "stopPressed" signal
+     * from the statusbar.
      */
-    QString selectionStatusBarText() const;
+    void stopLoading();
 
 private:
-    bool m_showProgress;
+    /**
+     * @return True if the URL protocol is a search URL (e. g. nepomuksearch:// or filenamesearch://).
+     */
+    bool isSearchUrl(const KUrl& url) const;
 
-    int m_iconSize;
-    int m_folderCount;
-    int m_fileCount;
+    /**
+     * Saves the state of the current view: contents position,
+     * root URL, ...
+     */
+    void saveViewState();
 
-    DolphinMainWindow* m_mainWindow;
+private:
     QVBoxLayout* m_topLayout;
     KUrlNavigator* m_urlNavigator;
+    DolphinSearchBox* m_searchBox;
 
     DolphinView* m_view;
 
     FilterBar* m_filterBar;
-    DolphinStatusBar* m_statusBar;
 
-    DolphinModel* m_dolphinModel;
-    DolphinDirLister* m_dirLister;
-    DolphinSortFilterProxyModel* m_proxyModel;
+    DolphinStatusBar* m_statusBar;
+    QTimer* m_statusBarTimer;            // Triggers a delayed update
+    QElapsedTimer m_statusBarTimestamp;  // Time in ms since last update
 };
 
-const DolphinStatusBar* DolphinViewContainer::statusBar() const
-{
-    return m_statusBar;
-}
-
-DolphinStatusBar* DolphinViewContainer::statusBar()
-{
-    return m_statusBar;
-}
-
-const KUrlNavigator* DolphinViewContainer::urlNavigator() const
-{
-    return m_urlNavigator;
-}
-
-KUrlNavigator* DolphinViewContainer::urlNavigator()
-{
-    return m_urlNavigator;
-}
-
-const DolphinView* DolphinViewContainer::view() const
-{
-    return m_view;
-}
-
-DolphinView* DolphinViewContainer::view()
-{
-    return m_view;
-}
-
-const DolphinMainWindow* DolphinViewContainer::mainWindow() const
-{
-    return m_mainWindow;
-}
 #endif // DOLPHINVIEWCONTAINER_H