/***************************************************************************
- * Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at> *
+ * Copyright (C) 2006-2009 by Peter Penz <peter.penz@gmx.at> *
* Copyright (C) 2006 by Gregor Kališnik <gregor@podnapisi.net> *
* *
* This program is free software; you can redistribute it and/or modify *
#include <QKeyEvent>
#include <QLinkedList>
#include <QListView>
+#include <QSet>
#include <QWidget>
+typedef KIO::FileUndoManager::CommandType CommandType;
+
class DolphinController;
-class DolphinColumnView;
+class DolphinColumnViewContainer;
class DolphinDetailsView;
class DolphinIconsView;
class DolphinMainWindow;
class DolphinModel;
class DolphinSortFilterProxyModel;
-class IconManager;
+class KFilePreviewGenerator;
class KAction;
class KActionCollection;
class KDirLister;
-class KFileItemDelegate;
class KUrl;
-class KToggleAction;
-class ToolTipManager;
-class QModelIndex;
class ViewProperties;
+class DolphinDetailsViewExpander;
/**
* @short Represents a view for the directory content.
{
/**
* The directory items are shown as icons including an
- * icon name. */
+ * icon name.
+ */
IconsView = 0,
/**
/**
* @param parent Parent widget of the view.
* @param url Specifies the content which should be shown.
- * @param dirLister Used directory lister. The lister is not owned
- * by the view and won't get deleted.
- * @param dolphinModel Used directory model. The model is not owned
- * by the view and won't get deleted.
* @param proxyModel Used proxy model which specifies the sorting. The
* model is not owned by the view and won't get
* deleted.
*/
DolphinView(QWidget* parent,
const KUrl& url,
- KDirLister* dirLister,
- DolphinModel* dolphinModel,
DolphinSortFilterProxyModel* proxyModel);
virtual ~DolphinView();
*/
bool supportsCategorizedSorting() const;
- /**
- * 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();
-
- /** Returns true, if at least one item is selected. */
- bool hasSelection() const;
-
- void clearSelection();
-
/**
* Returns the selected items. The list is empty if no item has been
* selected.
*/
KUrl::List selectedUrls() const;
+ /**
+ * Returns the number of selected items (this is faster than
+ * invoking selectedItems().count()).
+ */
+ int selectedItemsCount() const;
+
+ QItemSelectionModel* selectionModel() const;
+
/**
* Sets the upper left position of the view content
* to (x,y). The content of the view might be larger than the visible area
*/
void setContentsPosition(int x, int y);
+ /**
+ * Sets the upper left position of the view content
+ * to (x,y) after the directory loading is finished.
+ * This is useful when going back or forward in history.
+ */
+ void setRestoredContentsPosition(const QPoint& pos);
+
/** Returns the upper left position of the view content. */
QPoint contentsPosition() const;
- /** Increases the size of the current set view mode. */
- void zoomIn();
-
- /** Decreases the size of the current set view mode. */
- void zoomOut();
+ /**
+ * Sets the zoom level to \a level. It is assured that the used
+ * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
+ * ZoomLevelInfo::maximumLevel().
+ */
+ void setZoomLevel(int level);
+ int zoomLevel() const;
/**
* Returns true, if zooming in is possible. If false is returned,
- * the minimal zoom size is possible.
+ * the maximum zooming level has been reached.
*/
bool isZoomInPossible() const;
/**
* Returns true, if zooming out is possible. If false is returned,
- * the maximum zoom size is possible.
+ * the minimum zooming level has been reached.
*/
bool isZoomOutPossible() const;
/** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
Qt::SortOrder sortOrder() const;
+ /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
+ void setSortFoldersFirst(bool foldersFirst);
+
+ /** Returns if files and folders are sorted separately or not. */
+ bool sortFoldersFirst() const;
+
/** Sets the additional information which should be shown for the items. */
void setAdditionalInfo(KFileItemDelegate::InformationList info);
/**
* Calculates the number of currently shown files into
* \a fileCount and the number of folders into \a folderCount.
+ * The size of all files is written into \a totalFileSize.
* It is recommend using this method instead of asking the
* directory lister or the model directly, as it takes
* filtering and hierarchical previews into account.
*/
- void calculateItemCount(int& fileCount, int& folderCount);
+ void calculateItemCount(int& fileCount, int& folderCount, KIO::filesize_t& totalFileSize) const;
+
+ /**
+ * Returns a textual representation of the state of the current
+ * folder or selected items, suitable for use in the status bar.
+ */
+ QString statusBarText() const;
+
+ /**
+ * Returns the version control actions that are provided for the items \p items.
+ * Usually the actions are presented in the context menu.
+ */
+ QList<QAction*> versionControlActions(const KFileItemList& items) const;
/**
* Updates the state of the 'Additional Information' actions in \a collection.
void setTabsForFilesEnabled(bool tabsForFiles);
bool isTabsForFilesEnabled() const;
+ /**
+ * Marks the item \a url as active item as soon as it has
+ * been loaded by the directory lister. This is useful mark
+ * the previously visited directory as active when going
+ * back in history (the URL is known, but the item is not
+ * loaded yet).
+ */
+ void activateItem(const KUrl& url);
+
+ /**
+ * Returns true if the current view allows folders to be expanded,
+ * i.e. presents a hierarchical view to the user.
+ */
+ bool itemsExpandable() const;
+
+ /**
+ * Restores the view state (current item, contents position, details view expansion state)
+ */
+ void restoreState(QDataStream &stream);
+
+ /**
+ * Saves the view state (current item, contents position, details view expansion state)
+ */
+ void saveState(QDataStream &stream);
+
public slots:
/**
* Changes the directory to \a url. If the current directory is equal to
*/
void setUrl(const KUrl& url);
+ /**
+ * 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();
+
+ /** Returns true, if at least one item is selected. */
+ bool hasSelection() const;
+
+ void clearSelection();
+
/**
* Request of a selection change. The view will do its best to accommodate
* the request, but it is not guaranteed that all items in \a selection
/**
* Copies all selected items to the clipboard and marks
- * the items as cutted.
+ * the items as cut.
*/
void cutSelectedItems();
/** Switches between an ascending and descending sorting order. */
void toggleSortOrder();
+ /** Switches between a separate sorting (with folders first) and a mixed sorting of files and folders. */
+ void toggleSortFoldersFirst();
+
/**
* Switches on or off the displaying of additional information
* as specified by \a action.
/** Is emitted if the sort order (ascending or descending) has been changed. */
void sortOrderChanged(Qt::SortOrder order);
+ /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
+ void sortFoldersFirstChanged(bool foldersFirst);
+
/** Is emitted if the additional information shown for this view has been changed. */
void additionalInfoChanged();
+ /** Is emitted if the zoom level has been changed by zooming in or out. */
+ void zoomLevelChanged(int level);
+
/**
- * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
+ * Is emitted if information of an item is requested to be shown e. g. in the panel.
* If item is null, no item information request is pending.
*/
void requestItemInfo(const KFileItem& item);
/**
* Is emitted if a context menu is requested for the item \a item,
- * which is part of \a url. If the item is 0, the context menu
- * for the URL should be shown.
+ * which is part of \a url. If the item is null, the context menu
+ * for the URL should be shown and the custom actions \a customActions
+ * will be added.
*/
- void requestContextMenu(const KFileItem& item, const KUrl& url);
+ void requestContextMenu(const KFileItem& item,
+ const KUrl& url,
+ const QList<QAction*>& customActions);
/**
* Is emitted if an information message with the content \a msg
void startedPathLoading(const KUrl& url);
/**
- * Is emitted when renaming, copying, moving, linking etc.
- * Used for feedback in the mainwindow.
+ * Emitted when KDirLister emits redirection.
+ * Testcase: fish://localhost
*/
- void doingOperation(KIO::FileUndoManager::CommandType type);
+ void redirection(const KUrl& oldUrl, const KUrl& newUrl);
protected:
/** @see QWidget::mouseReleaseEvent */
virtual void mouseReleaseEvent(QMouseEvent* event);
- virtual void wheelEvent(QWheelEvent* event);
virtual bool eventFilter(QObject* watched, QEvent* event);
private slots:
*/
void triggerItem(const KFileItem& index);
+ /**
+ * Emits the signal \a selectionChanged() with a small delay. This is
+ * because getting all file items for the signal can be an expensive
+ * operation. Fast selection changes are collected in this case and
+ * the signal is emitted only after no selection change has been done
+ * within a small delay.
+ */
+ void emitDelayedSelectionChangedSignal();
+
+ /**
+ * Is called by emitDelayedSelectionChangedSignal() and emits the
+ * signal \a selectionChanged() with all selected file items as parameter.
+ */
void emitSelectionChangedSignal();
/**
* is used to check whether the context menu is related to an
* item or to the viewport.
*/
- void openContextMenu(const QPoint& pos);
+ void openContextMenu(const QPoint& pos, const QList<QAction*>& customActions);
/**
- * Drops the URLs \a urls to the destination path \a destPath. If
+ * Drops dragged URLs to the destination path \a destPath. If
* the URLs are dropped above an item inside the destination path,
* the item is indicated by \a destItem.
*/
- void dropUrls(const KUrl::List& urls,
+ void dropUrls(const KFileItem& destItem,
const KUrl& destPath,
- const KFileItem& destItem);
+ QDropEvent* event);
- /**
- * Handles the dropping of URLs to the given destination.
- * @see DolphinDropController
- */
- void dropUrls(const KUrl::List& urls,
- const KUrl& destination);
/**
* Updates the view properties of the current URL to the
* sorting given by \a sorting.
*/
void updateSortOrder(Qt::SortOrder order);
+ /**
+ * Updates the view properties of the current URL to the
+ * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
+ */
+ void updateSortFoldersFirst(bool foldersFirst);
+
/**
* Updates the view properties of the current URL to the
* additional information given by \a info.
*/
void slotDeleteFileFinished(KJob* job);
- /**
- * Called when KDirLister emits redirection.
- * Testcase: fish://localhost
- */
- void slotRedirection(const KUrl& oldUrl, const KUrl& newUrl);
-
/**
* Is emitted if the controller requests a changing of the current
* URL to \a url
void slotRequestUrlChange(const KUrl& url);
/**
- * Restores the current item (= item that has the keyboard focus)
- * to m_currentItemUrl.
+ * Invoked when the directory lister has completed the loading of
+ * items. Assures that pasted items and renamed items get seleced.
*/
- void restoreCurrentItem();
+ void slotDirListerCompleted();
-private:
- void loadDirectory(const KUrl& url, bool reload = false);
+ /**
+ * Invoked when the loading of the directory is finished.
+ * Restores the active item and the scroll position if possible.
+ */
+ void slotLoadingCompleted();
+
+ /**
+ * Is invoked when the KDirLister indicates refreshed items.
+ */
+ void slotRefreshItems();
+
+ /**
+ * Observes the item with the URL \a url. As soon as the directory
+ * model indicates that the item is available, the item will
+ * get selected and it is assure that the item stays visible.
+ *
+ * @see selectAndScrollToCreatedItem()
+ */
+ void observeCreatedItem(const KUrl& url);
+
+ /**
+ * Selects and scrolls to the item that got observed
+ * by observeCreatedItem().
+ */
+ void selectAndScrollToCreatedItem();
+
+ /**
+ * Restore selection after view refresh.
+ */
+ void restoreSelection();
+
+ /**
+ * Called when a redirection happens.
+ * Testcase: fish://localhost
+ */
+ void slotRedirection(const KUrl& oldUrl, const KUrl& newUrl);
/**
- * Returns the URL where the view properties should be stored. Usually
- * DolphinView::url() is returned, but in the case of a Column View the
- * view properties are always stored in the directory represented by the
- * first column. It is recommendend whenever using the ViewProperties class
- * to use DolphinView::viewPropertiesUrl() as URL.
+ * Restores the contents position, if history information about the old position is available.
*/
- KUrl viewPropertiesUrl() const;
+ void restoreContentsPosition();
+
+private:
+ void loadDirectory(const KUrl& url, bool reload = false);
/**
* Applies the view properties which are defined by the current URL
- * m_url to the DolphinView properties.
+ * to the DolphinView properties.
*/
- void applyViewProperties(const KUrl& url);
+ void applyViewProperties();
/**
* Creates a new view representing the given view mode (DolphinView::mode()).
void deleteView();
/**
- * Returns a pointer to the currently used item view, which is either
- * a ListView or a TreeView.
+ * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
+ * Pastes the clipboard data into the URL \a url.
*/
- QAbstractItemView* itemView() const;
+ void pasteToUrl(const KUrl& url);
/**
- * Returns true, if the item \a item has been cut into
- * the clipboard.
+ * Checks whether the current item view has the same zoom level
+ * as \a oldZoomLevel. If this is not the case, the zoom level
+ * of the controller is updated and a zoomLevelChanged() signal
+ * is emitted.
*/
- bool isCutItem(const KFileItem& item) const;
+ void updateZoomLevel(int oldZoomLevel);
/**
- * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
- * Pastes the clipboard data into the URL \a url.
+ * Returns a list of URLs for all selected items. The list is
+ * simplified, so that when the URLs are part of different tree
+ * levels, only the parent is returned.
*/
- void pasteToUrl(const KUrl& url);
+ KUrl::List simplifiedSelectedUrls() const;
/**
- * Returns true, if the ColumnView is activated. As the column view
- * requires some special handling for iterating through directories,
- * this method has been introduced for convenience.
+ * Returns the MIME data for all selected items.
*/
- bool isColumnViewActive() const
- {
- return m_columnView != 0;
- }
+ QMimeData* selectionMimeData() const;
+
+ /**
+ * Is invoked after a paste operation or a drag & drop
+ * operation and adds the filenames of all URLs from \a mimeData to
+ * m_newFileNames. This allows to select all newly added
+ * items in slotDirListerCompleted().
+ */
+ void addNewFileNames(const QMimeData* mimeData);
private:
+ /**
+ * Abstracts the access to the different view implementations
+ * for icons-, details- and column-view.
+ */
+ class ViewAccessor
+ {
+ public:
+ ViewAccessor(DolphinSortFilterProxyModel* proxyModel);
+ ~ViewAccessor();
+
+ void createView(QWidget* parent, DolphinController* controller, Mode mode);
+ void deleteView();
+
+ /**
+ * Must be invoked before the URL has been changed and allows view implementations
+ * like the column view to create a new column.
+ */
+ void prepareUrlChange(const KUrl& url);
+
+ QAbstractItemView* itemView() const;
+ KFileItemDelegate* itemDelegate() const;
+
+ /**
+ * Returns the widget that should be added to the layout as target. Usually
+ * the item view itself is returned, but in the case of the column view
+ * a container widget is returned.
+ */
+ QWidget* layoutTarget() const;
+
+ KUrl rootUrl() const;
+
+ bool supportsCategorizedSorting() const;
+ bool itemsExpandable() const;
+ QSet<KUrl> expandedUrls() const;
+ const DolphinDetailsViewExpander* setExpandedUrls(const QSet<KUrl>& urlsToExpand);
+
+ /**
+ * Returns true, if a reloading of the items is required
+ * when the additional information properties have been changed
+ * by the user.
+ */
+ bool reloadOnAdditionalInfoChange() const;
+
+ DolphinModel* dirModel() const;
+ DolphinSortFilterProxyModel* proxyModel() const;
+ KDirLister* dirLister() const;
+
+ private:
+ DolphinIconsView* m_iconsView;
+ DolphinDetailsView* m_detailsView;
+ DolphinColumnViewContainer* m_columnsContainer;
+ DolphinSortFilterProxyModel* m_proxyModel;
+ QAbstractItemView* m_dragSource;
+ QPointer<DolphinDetailsViewExpander> m_detailsViewExpander;
+ };
+
bool m_active : 1;
bool m_showPreview : 1;
bool m_loadingDirectory : 1;
bool m_storedCategorizedSorting : 1;
bool m_tabsForFiles : 1;
bool m_isContextMenuOpen : 1; // TODO: workaround for Qt-issue 207192
+ bool m_ignoreViewProperties : 1;
+ bool m_assureVisibleCurrentIndex : 1;
+ bool m_expanderActive : 1;
Mode m_mode;
QVBoxLayout* m_topLayout;
DolphinController* m_controller;
- DolphinIconsView* m_iconsView;
- DolphinDetailsView* m_detailsView;
- DolphinColumnView* m_columnView;
- KFileItemDelegate* m_fileItemDelegate;
- QItemSelectionModel* m_selectionModel;
+ ViewAccessor m_viewAccessor;
- DolphinModel* m_dolphinModel;
- KDirLister* m_dirLister;
- DolphinSortFilterProxyModel* m_proxyModel;
-
- IconManager* m_iconManager;
- ToolTipManager* m_toolTipManager;
+ QItemSelectionModel* m_selectionModel; // allow to switch views without losing the selection
+ QTimer* m_selectionChangedTimer;
KUrl m_rootUrl;
- KUrl m_currentItemUrl;
+ KUrl m_activeItemUrl;
+ QPoint m_restoredContentsPosition;
+ KUrl m_createdItemUrl; // URL for a new item that got created by the "Create New..." menu
+ KFileItemList m_selectedItems; // this is used for making the View to remember selections after F5
+
+ /**
+ * Remembers the filenames that have been added by a paste operation
+ * or a drag & drop operation. Allows to select the items in
+ * slotDirListerCompleted().
+ */
+ QSet<QString> m_newFileNames;
};
/// Allow using DolphinView::Mode in QVariant
projects / dolphin.git / blobdiff