#include <kparts/part.h>
#include <kfileitem.h>
#include <kfileitemdelegate.h>
+#include <kio/fileundomanager.h>
#include <kio/job.h>
#include <QBoxLayout>
#include <QKeyEvent>
#include <QLinkedList>
#include <QListView>
+#include <QSet>
#include <QWidget>
+typedef KIO::FileUndoManager::CommandType CommandType;
+
class DolphinController;
-class KDirLister;
-class KFileItemDelegate;
-class KUrl;
-class DolphinModel;
class DolphinColumnView;
class DolphinDetailsView;
+class DolphinFileItemDelegate;
class DolphinIconsView;
class DolphinMainWindow;
+class DolphinModel;
class DolphinSortFilterProxyModel;
+class KFilePreviewGenerator;
+class KAction;
+class KActionCollection;
+class KDirLister;
+class KUrl;
+class KToggleAction;
+class RevisionControlObserver;
+class ToolTipManager;
class QModelIndex;
class ViewProperties;
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).
- */
+ * 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. */
+ * 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.
+ * @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,
* Changes the view mode for the current directory to \a mode.
* If the view properties should be remembered for each directory
* (GeneralSettings::globalViewProps() returns false), then the
- * changed view mode will be be stored automatically.
+ * changed view mode will be stored automatically.
*/
void setMode(Mode mode);
Mode mode() const;
- /**
- * Turns on the file preview for the all files of the current directory,
- * if \a show is true.
- * If the view properties should be remembered for each directory
- * (GeneralSettings::globalViewProps() returns false), then the
- * preview setting will be be stored automatically.
- */
- void setShowPreview(bool show);
+ /** See setShowPreview */
bool showPreview() const;
- /**
- * Shows all hidden files of the current directory,
- * if \a show is true.
- * If the view properties should be remembered for each directory
- * (GeneralSettings::globalViewProps() returns false), then the
- * show hidden file setting will be be stored automatically.
- */
- void setShowHiddenFiles(bool show);
+ /** See setShowHiddenFiles */
bool showHiddenFiles() const;
- /**
- * Summarizes all sorted items by their category \a categorized
- * is true.
- * If the view properties should be remembered for each directory
- * (GeneralSettings::globalViewProps() returns false), then the
- * categorized sorting setting will be be stored automatically.
- */
- void setCategorizedSorting(bool categorized);
+ /** See setCategorizedSorting */
bool categorizedSorting() const;
/**
* selected.
* @see DolphinView::selectedUrls()
*/
- QList<KFileItem> selectedItems() const;
+ KFileItemList selectedItems() const;
/**
* Returns a list of URLs for all selected items. An empty list
KUrl::List selectedUrls() const;
/**
- * Returns the file item for the given model index \a index.
+ * Returns the number of selected items (this is faster than
+ * invoking selectedItems().count()).
*/
- KFileItem fileItem(const QModelIndex& index) const;
+ int selectedItemsCount() const;
/**
* Sets the upper left position of the view content
/** 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 the additional information which should be shown for the items. */
- void setAdditionalInfo(KFileItemDelegate::InformationList info);
+ /** 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::Information info);
+ void setAdditionalInfo(KFileItemDelegate::InformationList info);
/** Returns the additional information which should be shown for the items. */
KFileItemDelegate::InformationList additionalInfo() const;
*/
void updateView(const KUrl& url, const KUrl& rootUrl);
+ /**
+ * Filters the currently shown items by \a nameFilter. All items
+ * which contain the given filter string will be shown.
+ */
+ void setNameFilter(const QString& nameFilter);
+
+ /**
+ * 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, 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 revision control actions that are provided for the items \p items.
+ * Usually the actions are presented in the context menu.
+ */
+ QList<QAction*> revisionControlActions(const KFileItemList& items) const;
+
+ /**
+ * Updates the state of the 'Additional Information' actions in \a collection.
+ */
+ void updateAdditionalInfoActions(KActionCollection* collection);
+
+ /**
+ * Returns the state of the paste action:
+ * first is whether the action should be enabled
+ * second is the text for the action
+ */
+ QPair<bool, QString> pasteInfo() const;
+
+ /**
+ * If \a tabsForFiles is true, the signal tabRequested() will also
+ * emitted also for files. Per default tabs for files is disabled
+ * and hence the signal tabRequested() will only be emitted for
+ * directories.
+ */
+ 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;
+
public slots:
/**
* Changes the directory to \a url. If the current directory is equal to
* will actually get selected. The view will e.g. not select items which
* are not in the currently displayed folder.
*/
- void changeSelection(const QList<KFileItem>& selection);
+ void changeSelection(const KFileItemList& selection);
+
+ /**
+ * Triggers the renaming of the currently selected items, where
+ * the user must input a new name for the items.
+ */
+ void renameSelectedItems();
+
+ /**
+ * Moves all selected items to the trash.
+ */
+ void trashSelectedItems();
+
+ /**
+ * Deletes all selected items.
+ */
+ void deleteSelectedItems();
+
+ /**
+ * Copies all selected items to the clipboard and marks
+ * the items as cutted.
+ */
+ void cutSelectedItems();
+
+ /** Copies all selected items to the clipboard. */
+ void copySelectedItems();
+
+ /** Pastes the clipboard data to this view. */
+ void paste();
+
+ /**
+ * Pastes the clipboard data into the currently selected
+ * folder. If the current selection is not exactly one folder, no
+ * paste operation is done.
+ */
+ void pasteIntoFolder();
+
+ /**
+ * Turns on the file preview for the all files of the current directory,
+ * if \a show is true.
+ * If the view properties should be remembered for each directory
+ * (GeneralSettings::globalViewProps() returns false), then the
+ * preview setting will be stored automatically.
+ */
+ void setShowPreview(bool show);
+
+ /**
+ * Shows all hidden files of the current directory,
+ * if \a show is true.
+ * If the view properties should be remembered for each directory
+ * (GeneralSettings::globalViewProps() returns false), then the
+ * show hidden file setting will be stored automatically.
+ */
+ void setShowHiddenFiles(bool show);
+
+ /**
+ * Summarizes all sorted items by their category \a categorized
+ * is true.
+ * If the view properties should be remembered for each directory
+ * (GeneralSettings::globalViewProps() returns false), then the
+ * categorized sorting setting will be stored automatically.
+ */
+ void setCategorizedSorting(bool categorized);
+
+ /** 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.
+ */
+ void toggleAdditionalInfo(QAction* action);
signals:
/**
void urlChanged(const KUrl& url);
/**
- * Is emitted when clicking on an item
+ * Is emitted if the view requests a changing of the current
+ * URL to \a url (see DolphinController::triggerUrlChangeRequest()).
+ */
+ void requestUrlChange(const KUrl& url);
+
+ /**
+ * Is emitted when clicking on an item with the left mouse button.
*/
void itemTriggered(const KFileItem& item);
+ /**
+ * Is emitted if a new tab should be opened for the URL \a url.
+ */
+ void tabRequested(const KUrl& url);
+
/**
* Is emitted if the view mode (IconsView, DetailsView,
* PreviewsView) has been changed.
/** Is emitted if the sort order (ascending or descending) has been changed. */
void sortOrderChanged(Qt::SortOrder order);
- /** Is emitted if the additional information for an item has been changed. */
- void additionalInfoChanged(KFileItemDelegate::InformationList info);
+ /** 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 whenever the selection has been changed.
*/
- void selectionChanged(const QList<KFileItem>& selection);
+ void selectionChanged(const KFileItemList& selection);
/**
* 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.
- */
- void requestContextMenu(const KFileItem& item, const KUrl& url);
-
- /**
- * Is emitted if the URLs \a are dropped to the destination URL
- * \a destination. No operation is done within the DolphinView, the
- * receiver of the signal has to take care about the corresponding
- * operation.
+ * 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 urlsDropped(const KUrl::List& urls, const KUrl& destination);
+ void requestContextMenu(const KFileItem& item,
+ const KUrl& url,
+ const QList<QAction*>& customActions);
/**
* Is emitted if an information message with the content \a msg
*/
void errorMessage(const QString& msg);
+ /**
+ * Is emitted if an "operation completed" message with the content \a msg
+ * should be shown.
+ */
+ void operationCompletedMessage(const QString& msg);
+
/**
* Is emitted after DolphinView::setUrl() has been invoked and
* the path \a url is currently loaded. If this signal is emitted,
*/
void startedPathLoading(const KUrl& url);
+ /**
+ * Emitted when KDirLister emits redirection.
+ * Testcase: fish://localhost
+ */
+ 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 activate();
/**
- * If the item specified by \a index is a directory, then this
+ * If the item \a item is a directory, then this
* directory will be loaded. If the item is a file, the corresponding
* application will get started.
*/
- void triggerItem(const QModelIndex& index);
+ void triggerItem(const KFileItem& index);
/**
- * Generates a preview image for each file item in \a items.
- * The current preview settings (maximum size, 'Show Preview' menu)
- * are respected.
+ * 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 generatePreviews(const QList<KFileItem>& items);
+ void emitDelayedSelectionChangedSignal();
/**
- * Replaces the icon of the item \a item by the preview pixmap
- * \a pixmap.
+ * Is called by emitDelayedSelectionChangedSignal() and emits the
+ * signal \a selectionChanged() with all selected file items as parameter.
*/
- void showPreview(const KFileItem& item, const QPixmap& pixmap);
-
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 destIndex. \a source
- * indicates the widget where the dragging has been started from.
+ * the item is indicated by \a destItem.
*/
- void dropUrls(const KUrl::List& urls,
+ void dropUrls(const KFileItem& destItem,
const KUrl& destPath,
- const QModelIndex& destIndex,
- QWidget* source);
+ QDropEvent* event);
- /**
- * Drops the URLs \a urls at the
- * destination \a destination.
- */
- 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 updateAdditionalInfo(const KFileItemDelegate::InformationList& info);
+
/**
* Emits the signal contentsMoved with the current coordinates
* of the viewport as parameters.
*/
void emitContentsMoved();
- /** Applies an item effect to all cut items of the clipboard. */
- void updateCutItems();
-
/**
* Updates the status bar to show hover information for the
- * item with the index \a index. If currently other items are selected,
+ * item \a item. If currently other items are selected,
* no hover information is shown.
* @see DolphinView::clearHoverInformation()
*/
- void showHoverInformation(const QModelIndex& index);
+ void showHoverInformation(const KFileItem& item);
/**
* Clears the hover information shown in the status bar.
*/
void clearHoverInformation();
+ /**
+ * Indicates in the status bar that the delete operation
+ * of the job \a job has been finished.
+ */
+ void slotDeleteFileFinished(KJob* job);
+
+ /**
+ * Is emitted if the controller requests a changing of the current
+ * URL to \a url
+ */
+ void slotRequestUrlChange(const KUrl& url);
+
+ /**
+ * Invoked when the directory lister has completed the loading of
+ * items. Assures that pasted items and renamed items get seleced.
+ */
+ void slotDirListerCompleted();
+
+ /**
+ * Is invoked when the KDirLister indicates refreshed items.
+ */
+ void slotRefreshItems();
+
+ /**
+ * If \a view can be positively identified as not being the source for the
+ * current drag operation, deleteLater() it immediately. Else stores
+ * it for later deletion.
+ */
+ void deleteWhenNotDragSource(QAbstractItemView* view);
+
+ /**
+ * 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();
+
private:
- void startDirLister(const KUrl& url, bool reload = false);
+ void loadDirectory(const KUrl& url, bool reload = false);
/**
* Returns the URL where the view properties should be stored. Usually
*/
void createView();
+ void deleteView();
+
/**
* Returns a pointer to the currently used item view, which is either
* a ListView or a TreeView.
QAbstractItemView* itemView() const;
/**
- * Returns true if the index is valid and represents
- * the column DolphinModel::Name.
+ * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
+ * Pastes the clipboard data into the URL \a url.
*/
- bool isValidNameIndex(const QModelIndex& index) 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;
-
- /** Applies an item effect to all cut items. */
- void applyCutItemEffect();
+ void updateZoomLevel(int oldZoomLevel);
/**
- * Updates the color of the viewport depending from the
- * activation state (see DolphinView::isActive()).
+ * 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 updateViewportColor();
+ 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.
*/
- bool isColumnViewActive() const
- {
- return m_columnView != 0;
- }
+ bool isColumnViewActive() const;
-private:
/**
- * Remembers the original pixmap for an item before
- * the cut effect is applied.
+ * Returns the MIME data for all selected items.
*/
- struct CutItem
- {
- KUrl url;
- QPixmap pixmap;
- };
+ 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:
+ 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_active;
- bool m_loadingDirectory;
- bool m_initializeColumnView;
- bool m_storedCategorizedSorting;
Mode m_mode;
DolphinMainWindow* m_mainWindow;
DolphinIconsView* m_iconsView;
DolphinDetailsView* m_detailsView;
DolphinColumnView* m_columnView;
- KFileItemDelegate* m_fileItemDelegate;
+ DolphinFileItemDelegate* m_fileItemDelegate;
+
+ QItemSelectionModel* m_selectionModel;
+ QTimer* m_selectionChangedTimer;
DolphinModel* m_dolphinModel;
KDirLister* m_dirLister;
DolphinSortFilterProxyModel* m_proxyModel;
- QList<CutItem> m_cutItemsCache;
+ KFilePreviewGenerator* m_previewGenerator;
+ ToolTipManager* m_toolTipManager;
+
+ RevisionControlObserver* m_revisionControlObserver;
KUrl m_rootUrl;
+ KUrl m_activeItemUrl;
+ 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;
+
+ QAbstractItemView* m_expandedDragSource;
};
+inline bool DolphinView::isColumnViewActive() const
+{
+ return m_columnView != 0;
+}
+
+/// Allow using DolphinView::Mode in QVariant
+Q_DECLARE_METATYPE(DolphinView::Mode)
+
#endif // DOLPHINVIEW_H
projects / dolphin.git / blobdiff