***************************************************************************/
-#ifndef _DOLPHINVIEW_H_
-#define _DOLPHINVIEW_H_
+#ifndef DOLPHINVIEW_H
+#define DOLPHINVIEW_H
+
+#include <config-nepomuk.h>
+
+#include "libdolphin_export.h"
#include <kparts/part.h>
#include <kfileitem.h>
-#include <kfileiconview.h>
+#include <kfileitemdelegate.h>
+#include <konq_fileundomanager.h>
#include <kio/job.h>
-#include <urlnavigator.h>
-
-#include <QDropEvent>
+#include <QBoxLayout>
+#include <QKeyEvent>
#include <QLinkedList>
#include <QListView>
-#include <QMouseEvent>
-#include <QVBoxLayout>
#include <QWidget>
+class QActionGroup;
class DolphinController;
-class FilterBar;
-class KUrl;
-class KDirModel;
-class UrlNavigator;
+class DolphinColumnView;
class DolphinDetailsView;
-class DolphinDirLister;
class DolphinIconsView;
class DolphinMainWindow;
+class DolphinModel;
class DolphinSortFilterProxyModel;
-class DolphinStatusBar;
+class IconManager;
+class KAction;
+class KActionCollection;
+class KDirLister;
+class KFileItemDelegate;
+class KUrl;
+class KToggleAction;
class QModelIndex;
-class QPainter;
-class QTimer;
class ViewProperties;
/**
- * @short Represents a view for the directory content
- * including the navigation bar, filter bar and status bar.
+ * @short Represents a view for the directory content.
*
- * View modes for icons and details are supported. Currently
- * Dolphin allows to have up to two views inside the main window.
+ * View modes for icons, details and columns are supported. It's
+ * possible to adjust:
+ * - sort order
+ * - sort type
+ * - show hidden files
+ * - show previews
*
* @see DolphinIconsView
* @see DolphinDetailsView
- * @see UrlNavigator
- * @see DolphinStatusBar
+ * @see DolphinColumnView
*/
-class DolphinView : public QWidget
+class LIBDOLPHINPRIVATE_EXPORT 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).
- */
+ /**
+ * 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
{
/**
* for date, group and permissions.
*/
DetailsView = 1,
- MaxModeEnum = DetailsView
+
+ /**
+ * Each folder is shown in a separate column.
+ */
+ ColumnView = 2,
+ MaxModeEnum = ColumnView
};
/** Defines the sort order for the items of a directory. */
SortByPermissions,
SortByOwner,
SortByGroup,
- MaxSortEnum = SortByGroup
+ SortByType,
+ SortByRating,
+ SortByTags,
+ MaxSortEnum = SortByTags
};
- DolphinView(DolphinMainWindow* mainwindow,
- QWidget *parent,
+ /**
+ * @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,
- Mode mode = IconsView,
- bool showHiddenFiles = false);
+ KDirLister* dirLister,
+ DolphinModel* dolphinModel,
+ DolphinSortFilterProxyModel* proxyModel);
virtual ~DolphinView();
/**
- * Sets the current active URL.
- * The signals UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
- * are emitted.
+ * Returns the current active URL, where all actions are applied.
+ * The URL navigator is synchronized with this URL.
*/
- void setUrl(const KUrl& url);
-
- /** Returns the current active URL. */
const KUrl& url() const;
/**
- * Returns true if the view is active and hence all actions are
- * applied to this view.
+ * Returns the root URL of the view, which is defined as the first
+ * visible path of DolphinView::url(). Usually the root URL is
+ * equal to DolphinView::url(), but in the case of the column view
+ * when 2 columns are shown, the root URL might be:
+ * /home/peter/Documents
+ * and DolphinView::url() might return
+ * /home/peter/Documents/Music/
+ */
+ KUrl rootUrl() const;
+
+ /**
+ * If \a active is true, the view will marked as active. The active
+ * view is defined as view where all actions are applied to.
*/
+ void setActive(bool active);
bool isActive() const;
/**
* 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;
+ /** See setCategorizedSorting */
+ bool categorizedSorting() const;
+
/**
- * Triggers the renaming of the currently selected items, where
- * the user must input a new name for the items.
+ * Returns true, if the categorized sorting is supported by the current
+ * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
+ * supports categorizations. To check whether the categorized
+ * sorting is set, use DolphinView::categorizedSorting().
*/
- void renameSelectedItems();
+ bool supportsCategorizedSorting() const;
/**
* Selects all items.
*/
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);
-
- /**
- * 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 QLinkedList<UrlNavigator::HistoryElem> urlHistory(int& index) const;
-
- /**
- * Returns true, if at least one item is selected.
- */
+ /** 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.
/**
* 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);
-
- /** 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;
+ KFileItem fileItem(const QModelIndex& index) const;
/**
- * Returns the y-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 contentsY() const;
+ void setContentsPosition(int x, int y);
- /**
- * Returns true, if the URL shown by the navigation bar is editable.
- * @see UrlNavigator
- */
- bool isUrlEditable() const;
+ /** Returns the upper left position of the view content. */
+ QPoint contentsPosition() const;
/** Increases the size of the current set view mode. */
void zoomIn();
/** 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();
+ /** Sets the additional information which should be shown for the items. */
+ void setAdditionalInfo(KFileItemDelegate::InformationList info);
- /** Returns the UrlNavigator of the view for read access. */
- const UrlNavigator* urlNavigator() const { return m_urlNavigator; }
+ /** Returns the additional information which should be shown for the items. */
+ KFileItemDelegate::InformationList additionalInfo() const;
+
+ /** Reloads the current directory. */
+ void reload();
/**
- * Triggers to request user information for the item given
- * by the URL \a url. The signal requestItemInfo is emitted,
- * which provides a way for widgets to get an indication to update
- * the item information.
+ * 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 emitRequestItemInfo(const KUrl& url);
+ void refresh();
- /** Returns true, if the filter bar is visible. */
- bool isFilterBarVisible() const;
+ /**
+ * 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);
/**
- * Return the DolphinMainWindow this View belongs to. It is guranteed
- * that we have one.
+ * Filters the currently shown items by \a nameFilter. All items
+ * which contain the given filter string will be shown.
*/
- DolphinMainWindow* mainWindow() const ;
+ void setNameFilter(const QString& nameFilter);
- /** Reloads the current directory. */
- void reload();
+ /**
+ * 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:
/**
- * Popups the filter bar above the status bar if \a show is true.
+ * Changes the directory to \a url. If the current directory is equal to
+ * \a url, nothing will be done (use DolphinView::reload() instead).
*/
- void showFilterBar(bool show);
+ void setUrl(const KUrl& url);
+
+ /**
+ * 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
+ * will actually get selected. The view will e.g. not select items which
+ * are not in the currently displayed folder.
+ */
+ 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();
/**
- * 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.
+ * Copies all selected items to the clipboard and marks
+ * the items as cutted.
*/
- void updateStatusBar();
+ void cutSelectedItems();
+
+ /** Copies all selected items to the clipboard. */
+ void copySelectedItems();
+
+ /** Pastes the clipboard data to this view. */
+ void paste();
/**
- * Requests the main window to set this view as active view, which
- * means that all actions are applied to this view.
+ * 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 requestActivation();
+ 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.
+ */
+ void activated();
+
/** 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 'show hidden files' property has been changed. */
void showHiddenFilesChanged();
+ /** Is emitted if the 'categorized sorting' property has been changed. */
+ void categorizedSortingChanged();
+
/** Is emitted if the sorting by name, size or date has been changed. */
void sortingChanged(DolphinView::Sorting sorting);
/** Is emitted if the sort order (ascending or descending) has been changed. */
void sortOrderChanged(Qt::SortOrder order);
+ /** 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);
/**
- * Is emitted whenever the selection has been changed. The current selection can
- * be retrieved by mainWindow()->activeView()->selectedItems() or by
- * mainWindow()->activeView()->selectedUrls().
+ * Is emitted whenever the selection has been changed.
*/
- void selectionChanged();
+ void selectionChanged(const KFileItemList& selection);
/**
- * Is emitted whenever the filter bar has been turned show or hidden.
+ * 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 showFilterBarChanged(bool shown);
+ void requestContextMenu(const KFileItem& item, const KUrl& url);
-protected:
- /** @see QWidget::mouseReleaseEvent */
- virtual void mouseReleaseEvent(QMouseEvent* event);
+ /**
+ * Is emitted if an information message with the content \a msg
+ * should be shown.
+ */
+ void infoMessage(const QString& msg);
-private slots:
- void loadDirectory(const KUrl& kurl);
- void triggerItem(const QModelIndex& index);
- void updateProgress(int percent);
+ /**
+ * Is emitted if an error message with the content \a msg
+ * should be shown.
+ */
+ void errorMessage(const QString& msg);
/**
- * Updates the number of items (= number of directories + number of files)
- * and shows this information in the statusbar.
+ * Is emitted if an "operation completed" message with the content \a msg
+ * should be shown.
*/
- void updateItemCount();
+ void operationCompletedMessage(const QString& msg);
/**
- * Restores the x- and y-position of the contents if the
- * current view is part of the history.
+ * 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 restoreContentsPos();
+ void startedPathLoading(const KUrl& url);
- /** Shows the information \a msg inside the statusbar. */
- void showInfoMessage(const QString& msg);
+ /**
+ * Is emitted when renaming, copying, moving, linking etc.
+ * Used for feedback in the mainwindow.
+ */
+ void doingOperation(KonqFileUndoManager::CommandType type);
- /** Shows the error message \a msg inside the statusbar. */
- void showErrorMessage(const QString& msg);
+protected:
+ /** @see QWidget::mouseReleaseEvent */
+ virtual void mouseReleaseEvent(QMouseEvent* event);
- void emitSelectionChangedSignal();
- void closeFilterBar();
+private slots:
+ /**
+ * Marks the view as active (DolphinView:isActive() will return true)
+ * and emits the 'activated' signal if it is not already active.
+ */
+ void activate();
/**
- * Filters the currently shown items by \a nameFilter. All items
- * which contain the given filter string will be shown.
+ * 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 changeNameFilter(const QString& nameFilter);
+ void triggerItem(const KFileItem& index);
+
+ void emitSelectionChangedSignal();
/**
* Opens the context menu on position \a pos. The position
void openContextMenu(const QPoint& pos);
/**
- * Drops the URLs \a urls at the position \a pos.
- * The position is used to check whether the dropping
- * is done above an item or above the viewport.
+ * 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 QPoint& pos);
+ 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();
/**
- * Updates the activation state of the view by checking whether
- * the currently active view is this view.
+ * Updates the status bar to show hover information for the
+ * item \a item. If currently other items are selected,
+ * no hover information is shown.
+ * @see DolphinView::clearHoverInformation()
+ */
+ void showHoverInformation(const KFileItem& item);
+
+ /**
+ * Clears the hover information shown in the status bar.
+ * @see DolphinView::showHoverInformation().
+ */
+ void clearHoverInformation();
+
+ /**
+ * Indicates in the status bar that the delete operation
+ * of the job \a job has been finished.
*/
- void updateActivationState();
+ void slotDeleteFileFinished(KJob* job);
private:
- void startDirLister(const KUrl& url, bool reload = false);
+ void loadDirectory(const KUrl& url, bool reload = false);
/**
- * Returns the default text of the status bar, if no item is
- * selected.
+ * 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.
*/
- QString defaultStatusBarText() const;
+ KUrl viewPropertiesUrl() const;
/**
- * Returns the text for the status bar, if at least one item
- * is selected.
+ * Applies the view properties which are defined by the current URL
+ * m_url to the DolphinView properties.
*/
- QString selectionStatusBarText() const;
+ void applyViewProperties(const KUrl& url);
/**
- * Creates a new view representing the given view mode (DolphinView::viewMode()).
+ * Creates a new view representing the given view mode (DolphinView::mode()).
* The current view will get deleted.
*/
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 item \a item has been cut into
+ * the clipboard.
+ */
+ bool isCutItem(const KFileItem& item) 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;
+ }
+
private:
- bool m_showProgress;
+ bool m_active;
+ bool m_showPreview;
+ bool m_loadingDirectory;
+ bool m_storedCategorizedSorting;
Mode m_mode;
- int m_iconSize;
- int m_folderCount;
- int m_fileCount;
-
DolphinMainWindow* m_mainWindow;
QVBoxLayout* m_topLayout;
- UrlNavigator* m_urlNavigator;
DolphinController* m_controller;
DolphinIconsView* m_iconsView;
DolphinDetailsView* m_detailsView;
+ DolphinColumnView* m_columnView;
+ KFileItemDelegate* m_fileItemDelegate;
+ QItemSelectionModel* m_selectionModel;
- FilterBar* m_filterBar;
- DolphinStatusBar* m_statusBar;
-
- KDirModel* m_dirModel;
- DolphinDirLister* m_dirLister;
+ DolphinModel* m_dolphinModel;
+ KDirLister* m_dirLister;
DolphinSortFilterProxyModel* m_proxyModel;
+
+ IconManager* m_iconManager;
+
+ KUrl m_rootUrl;
};
-#endif // _DOLPHINVIEW_H_
+/// Allow using DolphinView::Mode in QVariant
+Q_DECLARE_METATYPE(DolphinView::Mode)
+
+#endif // DOLPHINVIEW_H
projects / dolphin.git / blobdiff