Added old KDE3 version of dolphin

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/dolphin@1076309 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 452 insertions, 0 deletions

diff --git a/src/dolphinview.h b/src/dolphinview.h
new file mode 100644
index 0000000..d0ad891
--- /dev/null
+++ b/src/dolphinview.h
@@ -0,0 +1,452 @@
+/***************************************************************************
+ *   Copyright (C) 2006 by Peter Penz <[email protected]>                  *
+ *   Copyright (C) 2006 by Gregor Kališnik <[email protected]>          *
+ *                                                                         *
+ *   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 _DOLPHINVIEW_H_
+#define _DOLPHINVIEW_H_
+
+#include <qwidget.h>
+#include <kparts/part.h>
+#include <kfileitem.h>
+#include <kfileiconview.h>
+#include <kio/job.h>
+#include <urlnavigator.h>
+
+class QPainter;
+class KURL;
+class QLineEdit;
+class URLNavigator;
+class QTimer;
+class QIconViewItem;
+class QListViewItem;
+class QVBoxLayout;
+class KFileView;
+class Dolphin;
+class DolphinDirLister;
+class DolphinStatusBar;
+class DolphinIconsView;
+class DolphinDetailsView;
+class ViewProperties;
+class QScrollView;
+class KProgress;
+class ItemEffectsManager;
+class FilterBar;
+/**
+ * @short Represents a view for the directory content
+ * including the navigation bar and status bar.
+ *
+ * View modes for icons, details and previews are supported. Currently
+ * Dolphin allows to have up to two views inside the main window.
+ *
+ * @see DolphinIconsView
+ * @see DolphinDetailsView
+ * @see URLNavigator
+ * @see DolphinStatusBar
+ *
+ * @author Peter Penz <[email protected]>
+ */
+class DolphinView : public QWidget
+{
+    Q_OBJECT
+
+public:
+	/**
+     * Defines the view mode for a directory. The view mode
+     * can be defined when constructing a DolphinView. The
+     * view mode is automatically updated if the directory itself
+     * defines a view mode (see class ViewProperties for details).
+     */
+    enum Mode
+    {
+        /**
+         * The directory items are shown as icons including an
+         * icon name. */
+        IconsView = 0,
+
+        /**
+         * The icon, the name and at least the size of the directory
+         * items are shown in a table. It is possible to add columns
+         * for date, group and permissions.
+         */
+        DetailsView = 1,
+
+        /**
+         * The directory items are shown as preview if possible. As
+         * fallback the items are shown as icons.
+         */
+        PreviewsView = 2
+    };
+
+    /** Defines the sort order for the items of a directory. */
+    enum Sorting
+    {
+        SortByName = 0,
+        SortBySize = 1,
+        SortByDate = 2
+    };
+
+    DolphinView(QWidget* parent,
+                const KURL& url,
+                Mode mode = IconsView,
+                bool showHiddenFiles = false);
+
+    virtual ~DolphinView();
+
+    /**
+     * Sets the current active URL.
+     * The signals URLNavigator::urlChanged and URLNavigator::historyChanged
+     * are submitted.
+     */
+    void setURL(const KURL& url);
+
+    /** Returns the current active URL. */
+    const KURL& url() const;
+
+    void requestActivation();
+    bool isActive() const;
+
+    void setMode(Mode mode);
+    Mode mode() const;
+    void setShowHiddenFilesEnabled(bool show);
+    bool isShowHiddenFilesEnabled() const;
+
+    void setViewProperties(const ViewProperties& props);
+
+    /**
+     * Triggers the renaming of the currently selected items, where
+     * the user must input a new name for the items.
+     */
+    void renameSelectedItems();
+
+    /**
+     * Selects all items.
+     * @see DolphinView::selectedItems()
+     */
+    void selectAll();
+
+    /**
+     * Inverts the current selection: selected items get unselected,
+     * unselected items get selected.
+     * @see DolphinView::selectedItems()
+     */
+    void invertSelection();
+
+    /**
+     * Goes back one step in the URL history. The signals
+     * URLNavigator::urlChanged and URLNavigator::historyChanged
+     * are submitted.
+     */
+    void goBack();
+
+    /**
+     * Goes forward one step in the URL history. The signals
+     * URLNavigator::urlChanged and URLNavigator::historyChanged
+     * are submitted.
+     */
+    void goForward();
+
+    /**
+     * Goes up one step of the URL path. The signals
+     * URLNavigator::urlChanged and URLNavigator::historyChanged
+     * are submitted.
+     */
+    void goUp();
+
+    /**
+     * Goes to the home URL. The signals URLNavigator::urlChanged
+     * and URLNavigator::historyChanged are submitted.
+     */
+    void goHome();
+
+    /**
+     * Sets the URL of the navigation bar to an editable state
+     * if \a editable is true. If \a editable is false, each part of
+     * the location is presented by a button for a fast navigation.
+     */
+    void setURLEditable(bool editable);
+
+    /**
+     * Allows to edit the URL of the navigation bar and assures that
+     * the focus is assigned to the URL editor.
+     */
+    void editURL();
+
+    /**
+     * Returns the complete URL history. The index 0 indicates the oldest
+     * history element.
+     * @param index     Output parameter which indicates the current
+     *                  index of the location.
+     */
+    const QValueList<URLNavigator::HistoryElem> urlHistory(int& index) const;
+
+    /**
+     * Returns true, if at least one item is selected.
+     */
+    bool hasSelection() const;
+
+    /**
+     * Returns the selected items. 0 is returned, if no item
+     * is selected.
+     * @see DolphinView::selectedURLs()
+     */
+    const KFileItemList* selectedItems() const;
+
+    /**
+     * Returns a list of URLs for all selected items. An empty list
+     * is returned, if no item is selected.
+     * @see DolphinView::selectedItems()
+     */
+    KURL::List selectedURLs() const;
+
+    /**
+     * Returns the current item, where the cursor is. 0 is returned, if there is no
+     * current item (e. g. if the view is empty). Note that the current item must
+     * not be a selected item.
+     * @see DolphinView::selectedItems()
+     */
+    const KFileItem* currentFileItem() const;
+
+    /**
+     * Opens the context menu for the item indicated by \a fileInfo
+     * on the position \a pos. If 0 is passed for the file info, a context
+     * menu for the viewport is opened.
+     */
+    void openContextMenu(KFileItem* fileInfo, const QPoint& pos);
+
+    /**
+     * Renames the filename of the source URL by the new file name.
+     * If the new file name already exists, a dialog is opened which
+     * asks the user to enter a new name.
+     */
+    void rename(const KURL& source, const QString& newName);
+
+    /** Returns the status bar of the view. */
+    DolphinStatusBar* statusBar() const;
+
+    /**
+     * Returns the x-position of the view content.
+     * The content of the view might be larger than the visible area
+     * and hence a scrolling must be done.
+     */
+    int contentsX() const;
+
+    /**
+     * Returns the y-position of the view content.
+     * The content of the view might be larger than the visible area
+     * and hence a scrolling must be done.
+     */
+    int contentsY() const;
+
+    /**
+     * Returns true, if the URL shown by the navigation bar is editable.
+     * @see URLNavigator
+     */
+    bool isURLEditable() const;
+
+    /** Increases the size of the current set view mode. */
+    void zoomIn();
+
+    /** Decreases the size of the current set view mode. */
+    void zoomOut();
+
+    /**
+     * Returns true, if zooming in is possible. If false is returned,
+     * the minimal zoom size is possible.
+     */
+    bool isZoomInPossible() const;
+
+    /**
+     * Returns true, if zooming out is possible. If false is returned,
+     * the maximum zoom size is possible.
+     */
+    bool isZoomOutPossible() const;
+
+    /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
+    void setSorting(Sorting sorting);
+
+    /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
+    Sorting sorting() const;
+
+    /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
+    void setSortOrder(Qt::SortOrder order);
+
+    /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
+    Qt::SortOrder sortOrder() const;
+
+    /** Refreshs the view settings by reading out the stored settings. */
+    void refreshSettings();
+
+    /**
+     * 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.
+     */
+    void updateStatusBar();
+
+    /** Returns the URLNavigator of the view for read access. */
+    const URLNavigator* urlNavigator() const { return m_urlNavigator; }
+
+    /**
+     * Triggers to request user information for the item given
+     * by the URL \a url. The signal signalRequestItemInfo is emitted,
+     * which provides a way for widgets to get an indication to update
+     * the item information.
+     */
+    void requestItemInfo(const KURL& url);
+
+    /**
+     * Checks if the filter bar is visible.
+     *
+     * @return @c true Filter bar is visible.
+     * @return @c false Filter bar is not visible.
+     */
+    bool isFilterBarVisible() const;
+
+public slots:
+    void reload();
+    void slotURLListDropped(QDropEvent* event,
+                            const KURL::List& urls,
+                            const KURL& url);
+
+    /**
+     * Slot that popups the filter bar like FireFox popups his Search bar.
+     */
+    void slotShowFilterBar(bool show);
+
+signals:
+    /** Is emitted if URL of the view has been changed to \a url. */
+    void signalURLChanged(const KURL& url);
+
+    /**
+     * Is emitted if the view mode (IconsView, DetailsView,
+     * PreviewsView) has been changed.
+     */
+    void signalModeChanged();
+
+    /** Is emitted if the 'show hidden files' property has been changed. */
+    void signalShowHiddenFilesChanged();
+
+    /** Is emitted if the sorting by name, size or date has been changed. */
+    void signalSortingChanged(DolphinView::Sorting sorting);
+
+    /** Is emitted if the sort order (ascending or descending) has been changed. */
+    void signalSortOrderChanged(Qt::SortOrder order);
+
+    /**
+     * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
+     * It the URL is empty, no item information request is pending.
+     */
+    void signalRequestItemInfo(const KURL& url);
+
+    /** Is emitted if the contents has been moved to \a x, \a y. */
+    void contentsMoved(int x, int y);
+
+    /**
+     * Is emitted whenever the selection has been changed. The current selection can
+     * be retrieved by Dolphin::mainWin().activeView()->selectedItems() or by
+     * Dolphin::mainWin().activeView()->selectedURLs().
+     */
+    void signalSelectionChanged();
+
+protected:
+    /** @see QWidget::mouseReleaseEvent */
+    virtual void mouseReleaseEvent(QMouseEvent* event);
+
+private slots:
+    void slotURLChanged(const KURL& kurl);
+    void triggerIconsViewItem(QIconViewItem *item);
+    void triggerDetailsViewItem(QListViewItem* item,
+                                const QPoint& pos,
+                                int column);
+    void triggerDetailsViewItem(QListViewItem* item);
+    void updateURL();
+
+    void slotPercent(int percent);
+    void slotClear();
+    void slotDeleteItem(KFileItem* item);
+    void slotCompleted();
+    void slotDelayedUpdate();
+    void slotInfoMessage(const QString& msg);
+    void slotErrorMessage(const QString& msg);
+    void slotRefreshItems(const KFileItemList& list);
+    void slotAddItems(const KFileItemList& list);
+
+    void slotGrabActivation();
+
+    /**
+     * Is invoked shortly before the contents of a view implementation
+     * has been moved and emits the signal contentsMoved. Note that no
+     * signal is emitted when the contents moving is only temporary by
+     * e. g. reloading a directory.
+     */
+    void slotContentsMoving(int x, int y);
+
+    /**
+     * Filters the currently shown items by \a nameFilter. All items
+     * which contain the given filter string will be shown.
+     */
+    void slotChangeNameFilter(const QString& nameFilter);
+
+private:
+    void createView();
+    KFileView* fileView() const;
+    QScrollView* scrollView() const;
+    ItemEffectsManager* itemEffectsManager() const;
+    void startDirLister(const KURL& url, bool reload = false);
+
+    /**
+     * Returns the default text of the status bar, if no item is
+     * selected.
+     */
+    QString defaultStatusBarText() const;
+
+    /**
+     * Returns the text for the status bar, if at least one item
+     * is selected.
+     */
+    QString selectionStatusBarText() const;
+
+    /**
+     * Returns the string representation for the index \a index
+     * for renaming \itemCount items.
+     */
+    QString renameIndexPresentation(int index, int itemCount) const;
+
+    bool m_refreshing;
+    bool m_showProgress;
+    Mode m_mode;
+
+    QVBoxLayout* m_topLayout;
+    URLNavigator* m_urlNavigator;
+
+    DolphinIconsView* m_iconsView;
+    DolphinDetailsView* m_detailsView;
+    DolphinStatusBar* m_statusBar;
+
+    int m_iconSize;
+    int m_folderCount;
+    int m_fileCount;
+
+    DolphinDirLister* m_dirLister;
+
+    FilterBar *m_filterBar;
+};
+
+#endif // _DOLPHINVIEW_H_