#ifndef DOLPHINVIEW_H
#define DOLPHINVIEW_H
+#include <config-nepomuk.h>
+
+#include "libdolphin_export.h"
+
#include <kparts/part.h>
#include <kfileitem.h>
#include <kfileitemdelegate.h>
+#include <konq_fileundomanager.h>
#include <kio/job.h>
#include <QBoxLayout>
#include <QListView>
#include <QWidget>
+class QActionGroup;
class DolphinController;
-class KDirLister;
-class KFileItemDelegate;
-class KUrl;
-class KDirModel;
class DolphinColumnView;
class DolphinDetailsView;
class DolphinIconsView;
class DolphinMainWindow;
+class DolphinModel;
class DolphinSortFilterProxyModel;
+class IconManager;
+class KAction;
+class KActionCollection;
+class KDirLister;
+class KFileItemDelegate;
+class KUrl;
+class KToggleAction;
class QModelIndex;
class ViewProperties;
* @see DolphinDetailsView
* @see DolphinColumnView
*/
-class DolphinView : public QWidget
+class LIBDOLPHINPRIVATE_EXPORT DolphinView : public QWidget
{
Q_OBJECT
SortByOwner,
SortByGroup,
SortByType,
- MaxSortEnum = SortByType
+ SortByRating,
+ SortByTags,
+ MaxSortEnum = SortByTags
};
/**
- * @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 dirModel 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 mode Used display mode (IconsView, DetailsView or ColumnsView).
- * @param showHiddenFiles If true, hidden files will be shown in the view.
+ * @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,
- KDirModel* dirModel,
- DolphinSortFilterProxyModel* proxyModel,
- Mode mode = IconsView,
- bool showHiddenFiles = false);
+ DolphinModel* dolphinModel,
+ DolphinSortFilterProxyModel* proxyModel);
virtual ~DolphinView();
* 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;
/**
*/
bool supportsCategorizedSorting() const;
- /**
- * 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()
/**
* Returns the file item for the given model index \a index.
*/
- KFileItem* fileItem(const QModelIndex index) const;
-
- /**
- * 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);
+ KFileItem fileItem(const QModelIndex& index) const;
/**
- * Returns the x-position of the view content.
- * The content of the view might be larger than the visible area
+ * Sets the upper left position of the view content
+ * to (x,y). The content of the view might be larger than the visible area
* and hence a scrolling must be done.
*/
- int contentsX() const;
+ void setContentsPosition(int x, int y);
- /**
- * 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 the upper left position of the view content. */
+ QPoint contentsPosition() const;
/** Increases the size of the current set view mode. */
void zoomIn();
Qt::SortOrder sortOrder() const;
/** Sets the additional information which should be shown for the items. */
- void setAdditionalInfo(KFileItemDelegate::AdditionalInformation info);
+ void setAdditionalInfo(KFileItemDelegate::InformationList info);
/** Returns the additional information which should be shown for the items. */
- KFileItemDelegate::AdditionalInformation additionalInfo() const;
+ KFileItemDelegate::InformationList additionalInfo() const;
/** Reloads the current directory. */
void reload();
/**
- * Refreshs the view to get synchronized with the (updated) Dolphin settings.
+ * Refreshes the view to get synchronized with the (updated) Dolphin settings.
* This method only needs to get invoked if the view settings for the Icons View,
* Details View or Columns View have been changed.
*/
void refresh();
+ /**
+ * Changes the directory of the view to \a url. If \a rootUrl is empty, the view
+ * properties from \a url are used for adjusting the view mode and the other properties.
+ * If \a rootUrl is not empty, the view properties from the root URL are considered
+ * instead. Specifying a root URL is only required if a view having a different root URL
+ * (e. g. the column view) should be restored. Usually using DolphinView::setUrl()
+ * is enough for changing the current URL.
+ */
+ 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.
+ * 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);
+
+ /**
+ * Returns the "switch to icons mode" action.
+ * This code is here to share it between the mainwindow and the part
+ */
+ static KToggleAction* iconsModeAction(KActionCollection* collection);
+
+ /**
+ * Returns the "switch to details mode" action.
+ * This code is here to share it between the mainwindow and the part
+ */
+ static KToggleAction* detailsModeAction(KActionCollection* collection);
+
+ /**
+ * Returns the "switch to columns mode" action.
+ * This code is here to share it between the mainwindow and the part
+ */
+ static KToggleAction* columnsModeAction(KActionCollection* collection);
+
+ /**
+ * Updates the state of the 'Additional Information' actions in \a collection.
+ */
+ void updateAdditionalInfoActions(KActionCollection* collection);
+
+ /**
+ * Returns the action name corresponding to the current view mode
+ */
+ QString currentViewModeActionName() const;
+
+ /**
+ * 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;
+
public slots:
/**
* Changes the directory to \a url. If the current directory is equal to
*/
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();
+
+ /**
+ * 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 on or off the displaying of additional information
+ * as specified by \a action.
+ */
+ void toggleAdditionalInfo(QAction* action);
+
signals:
/**
* Is emitted if the view has been activated by e. g. a mouse click.
/** Is emitted if URL of the view has been changed to \a url. */
void urlChanged(const KUrl& url);
+ /**
+ * Is emitted when clicking on an item
+ */
+ void itemTriggered(const KFileItem& item);
+
/**
* 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 addtional information for an item has been changed. */
- void additionalInfoChanged(KFileItemDelegate::AdditionalInformation info);
+ /** Is emitted if the additional information shown for this view has been changed. */
+ void additionalInfoChanged();
/**
* 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.
+ * If item is null, no item information request is pending.
*/
- void requestItemInfo(const KUrl& url);
+ void requestItemInfo(const KFileItem& item);
/** Is emitted if the contents has been moved to \a x, \a y. */
void contentsMoved(int x, int y);
*/
void selectionChanged(const KFileItemList& selection);
- /**
- * Is emitted whenever the filter bar has been turned show or hidden.
- */
- void showFilterBarChanged(bool shown);
-
/**
* 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(KFileItem* item, const KUrl& url);
+ 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.
+ * Is emitted if an information message with the content \a msg
+ * should be shown.
*/
- void urlsDropped(const KUrl::List& urls, const KUrl& destination);
+ void infoMessage(const QString& msg);
-protected:
- /** @see QWidget::mouseReleaseEvent */
- virtual void mouseReleaseEvent(QMouseEvent* event);
+ /**
+ * Is emitted if an error message with the content \a msg
+ * should be shown.
+ */
+ void errorMessage(const QString& msg);
-private slots:
/**
- * Marks the view as active (DolphinView:isActive() will return true)
- * and emits the 'activated' signal if it is not already active.
+ * Is emitted if an "operation completed" message with the content \a msg
+ * should be shown.
*/
- void activate();
+ void operationCompletedMessage(const QString& msg);
/**
- * If the item specified by \a index is a directory, then this
- * directory will be loaded. If the item is a file, the corresponding
- * application will get started.
+ * Is emitted after DolphinView::setUrl() has been invoked and
+ * the path \a url is currently loaded. If this signal is emitted,
+ * it is assured that the view contains already the correct root
+ * URL and property settings.
*/
- void triggerItem(const QModelIndex& index);
+ void startedPathLoading(const KUrl& url);
/**
- * Generates a preview image for each file item in \a items.
- * The current preview settings (maximum size, 'Show Preview' menu)
- * are respected.
+ * Is emitted when renaming, copying, moving, linking etc.
+ * Used for feedback in the mainwindow.
*/
- void generatePreviews(const KFileItemList& items);
+ void doingOperation(KonqFileUndoManager::CommandType type);
+protected:
+ /** @see QWidget::mouseReleaseEvent */
+ virtual void mouseReleaseEvent(QMouseEvent* event);
+
+private slots:
/**
- * Replaces the icon of the item \a item by the preview pixmap
- * \a pixmap.
+ * Marks the view as active (DolphinView:isActive() will return true)
+ * and emits the 'activated' signal if it is not already active.
*/
- void showPreview(const KFileItem& item, const QPixmap& pixmap);
+ void activate();
/**
- * Restores the x- and y-position of the contents if the
- * current view is part of the history.
+ * 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 restoreContentsPos();
+ void triggerItem(const KFileItem& index);
void emitSelectionChangedSignal();
void openContextMenu(const QPoint& pos);
/**
- * Drops the URLs \a urls to the index \a index. \a source
- * indicates the widget where the dragging has been started from.
+ * Drops the URLs \a 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,
- const QModelIndex& index,
- QWidget* source);
+ const KUrl& destPath,
+ const KFileItem& destItem);
/**
- * Drops the URLs \a urls at the
- * destination \a destination.
+ * Handles the dropping of URLs to the given destination.
+ * @see DolphinDropController
*/
void dropUrls(const KUrl::List& urls,
const KUrl& destination);
*/
void updateSortOrder(Qt::SortOrder order);
+ /**
+ * 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);
+
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
+ * 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.
+ */
+ KUrl viewPropertiesUrl() const;
+
+ /**
+ * Applies the view properties which are defined by the current URL
+ * m_url to the DolphinView properties.
+ */
+ void applyViewProperties(const KUrl& url);
/**
* Creates a new view representing the given view mode (DolphinView::mode()).
*/
void createView();
- /**
- * Selects all items by using the selection flags \a flags. This is a helper
- * method for the slots DolphinView::selectAll() and DolphinView::invertSelection().
- */
- void selectAll(QItemSelectionModel::SelectionFlags flags);
+ void deleteView();
/**
* Returns a pointer to the currently used item view, which is either
*/
QAbstractItemView* itemView() const;
- /**
- * Returns true if the index is valid and represents
- * the column KDirModel::Name.
- */
- bool isValidNameIndex(const QModelIndex& index) const;
-
/**
* Returns true, if the item \a item has been cut into
* the clipboard.
*/
bool isCutItem(const KFileItem& item) const;
- /** Applies an item effect to all cut items. */
- void applyCutItemEffect();
-
/**
* Returns true, if the ColumnView is activated. As the column view
* requires some special handling for iterating through directories,
}
private:
- /**
- * Remembers the original pixmap for an item before
- * the cut effect is applied.
- */
- struct CutItem
- {
- KUrl url;
- QPixmap pixmap;
- };
-
bool m_active;
- bool m_blockContentsMovedSignal;
- bool m_initializeColumnView;
+ bool m_showPreview;
+ bool m_loadingDirectory;
+ bool m_storedCategorizedSorting;
Mode m_mode;
DolphinMainWindow* m_mainWindow;
DolphinDetailsView* m_detailsView;
DolphinColumnView* m_columnView;
KFileItemDelegate* m_fileItemDelegate;
+ QItemSelectionModel* m_selectionModel;
- KDirModel* m_dirModel;
+ DolphinModel* m_dolphinModel;
KDirLister* m_dirLister;
DolphinSortFilterProxyModel* m_proxyModel;
- QList<CutItem> m_cutItemsCache;
+ IconManager* m_iconManager;
+
+ KUrl m_rootUrl;
};
+/// Allow using DolphinView::Mode in QVariant
+Q_DECLARE_METATYPE(DolphinView::Mode)
+
#endif // DOLPHINVIEW_H
projects / dolphin.git / blobdiff