X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/f271d952ec990817420ac618e0161ef8db36d8bf..d6488887ecf69d7f192b94de8dce34fae0b7eb76:/src/dolphinview.h diff --git a/src/dolphinview.h b/src/dolphinview.h index 5c7fb5c2c..f550fa513 100644 --- a/src/dolphinview.h +++ b/src/dolphinview.h @@ -15,75 +15,69 @@ * 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., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * ***************************************************************************/ -#ifndef _DOLPHINVIEW_H_ -#define _DOLPHINVIEW_H_ +#ifndef DOLPHINVIEW_H +#define DOLPHINVIEW_H + +#include + +#include "libdolphin_export.h" -#include -//Added by qt3to4: -#include -#include -#include -#include #include #include -#include +#include +#include #include -#include +#include +#include +#include #include +#include -class QPainter; +class KAction; +class KToggleAction; +class DolphinController; +class KDirLister; +class KFileItemDelegate; class KUrl; -class KDirModel; -class QLineEdit; -class UrlNavigator; -class QTimer; -class Q3IconViewItem; -class Q3ListViewItem; -class Q3VBoxLayout; -//class KFileView; -class Dolphin; -class DolphinDirLister; -class DolphinStatusBar; -class DolphinIconsView; +class DolphinModel; +class DolphinColumnView; class DolphinDetailsView; -class ViewProperties; -class Q3ScrollView; -class KProgress; -class ItemEffectsManager; -class FilterBar; - +class DolphinIconsView; +class DolphinMainWindow; +class DolphinSortFilterProxyModel; class QModelIndex; +class ViewProperties; /** - * @short Represents a view for the directory content - * including the navigation bar and status bar. + * @short Represents a view for the directory content. * - * View modes for icons, details and previews 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 - * - * @author Peter Penz + * @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 { /** @@ -99,173 +93,163 @@ public: DetailsView = 1, /** - * The directory items are shown as preview if possible. As - * fallback the items are shown as icons. + * Each folder is shown in a separate column. */ - PreviewsView = 2, - MaxModeEnum = PreviewsView + ColumnView = 2, + MaxModeEnum = ColumnView }; /** Defines the sort order for the items of a directory. */ enum Sorting { SortByName = 0, - SortBySize = 1, - SortByDate = 2, - MaxSortEnum = SortByDate + SortBySize, + SortByDate, + SortByPermissions, + SortByOwner, + SortByGroup, + 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 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 submitted. + * 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; - 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. + * 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/ */ - void renameSelectedItems(); + KUrl rootUrl() const; /** - * Selects all items. - * @see DolphinView::selectedItems() + * 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 selectAll(); + void setActive(bool active); + bool isActive() const; /** - * Inverts the current selection: selected items get unselected, - * unselected items get selected. - * @see DolphinView::selectedItems() + * 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. */ - void invertSelection(); + void setMode(Mode mode); + Mode mode() const; /** - * Goes back one step in the Url history. The signals - * UrlNavigator::urlChanged and UrlNavigator::historyChanged - * are submitted. + * 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 goBack(); + void setShowPreview(bool show); + bool showPreview() const; /** - * Goes forward one step in the Url history. The signals - * UrlNavigator::urlChanged and UrlNavigator::historyChanged - * are submitted. + * 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 goForward(); + void setShowHiddenFiles(bool show); + bool showHiddenFiles() const; /** - * Goes up one step of the Url path. The signals - * UrlNavigator::urlChanged and UrlNavigator::historyChanged - * are submitted. + * 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 goUp(); + void setCategorizedSorting(bool categorized); + bool categorizedSorting() const; /** - * Goes to the home Url. The signals UrlNavigator::urlChanged - * and UrlNavigator::historyChanged are submitted. + * 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 goHome(); + bool supportsCategorizedSorting() const; /** - * 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. + * Selects all items. + * @see DolphinView::selectedItems() */ - void setUrlEditable(bool editable); + void selectAll(); /** - * 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. + * Inverts the current selection: selected items get unselected, + * unselected items get selected. + * @see DolphinView::selectedItems() */ - const Q3ValueList urlHistory(int& index) const; + void invertSelection(); - /** - * 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. 0 is returned, if no item - * is selected. + * Returns the selected items. The list is empty if no item has been + * selected. * @see DolphinView::selectedUrls() */ - const KFileItemList* selectedItems() const; + KFileItemList selectedItems() const; /** - * Returns a list of Urls for all selected items. An empty list + * 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. + * Returns the file item for the given model index \a index. */ - void openContextMenu(KFileItem* fileInfo, const QPoint& pos); + 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; - - /** - * 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(); @@ -297,165 +281,426 @@ public: /** 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 additional information which should be shown for the items. */ + KFileItemDelegate::InformationList additionalInfo() const; + + /** Reloads the current directory. */ + void reload(); + + /** + * 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); + + /** + * Creates the rename action. + * This code is here to share it between the mainwindow and the part + */ + static KAction* createRenameAction(KActionCollection* collection); /** - * 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. + * Creates the "move to trash" action. + * This code is here to share it between the mainwindow and the part */ - void updateStatusBar(); + static KAction* createMoveToTrashAction(KActionCollection* collection); - /** Returns the UrlNavigator of the view for read access. */ - const UrlNavigator* urlNavigator() const { return m_urlNavigator; } + /** + * Creates the delete action. + * This code is here to share it between the mainwindow and the part + */ + static KAction* createDeleteAction(KActionCollection* collection); /** - * 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. + * Returns the action name corresponding to the current view mode */ - void requestItemInfo(const KUrl& url); + QString currentViewModeActionName() const; /** - * Checks if the filter bar is visible. - * - * @return @c true Filter bar is visible. - * @return @c false Filter bar is not visible. + * Returns the state of the paste action: + * first is whether the action should be enabled + * second is the text for the action */ - bool isFilterBarVisible(); + QPair pasteInfo() const; public slots: - void reload(); - void slotUrlListDropped(QDropEvent* event, - const KUrl::List& urls, - const KUrl& url); + /** + * Changes the directory to \a url. If the current directory is equal to + * \a url, nothing will be done (use DolphinView::reload() instead). + */ + void setUrl(const KUrl& url); /** - * Slot that popups the filter bar like FireFox popups his Search bar. + * 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 slotShowFilterBar(bool show); + 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(); signals: - /** Is emitted if Url of the view has been changed to \a url. */ - void signalUrlChanged(const KUrl& url); + /** + * 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. */ - void signalModeChanged(); + void modeChanged(); + + /** Is emitted if the 'show preview' property has been changed. */ + void showPreviewChanged(); /** Is emitted if the 'show hidden files' property has been changed. */ - void signalShowHiddenFilesChanged(); + 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 signalSortingChanged(DolphinView::Sorting sorting); + void sortingChanged(DolphinView::Sorting sorting); /** Is emitted if the sort order (ascending or descending) has been changed. */ - void signalSortOrderChanged(Qt::SortOrder order); + void sortOrderChanged(Qt::SortOrder order); + + /** Is emitted if the additional information for an item has been changed. */ + void additionalInfoChanged(const KFileItemDelegate::InformationList& info); /** * 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 signalRequestItemInfo(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 Dolphin::mainWin().activeView()->selectedItems() or by - * Dolphin::mainWin().activeView()->selectedUrls(). + * Is emitted whenever the selection has been changed. + */ + 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. + */ + void urlsDropped(const KUrl::List& urls, const KUrl& destination); + + /** + * Is emitted if an information message with the content \a msg + * should be shown. + */ + void infoMessage(const QString& msg); + + /** + * Is emitted if an error message with the content \a msg + * should be shown. + */ + 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, + * it is assured that the view contains already the correct root + * URL and property settings. */ - void signalSelectionChanged(); + void startedPathLoading(const KUrl& url); /** - * Is emitted whenever the directory view is redirected by an ioslave + * Is emitted when renaming, copying, moving, linking etc. + * Used for feedback in the mainwindow. */ - void redirection(const KUrl& oldUrl, const KUrl& newUrl); + void doingOperation(KonqFileUndoManager::CommandType type); protected: /** @see QWidget::mouseReleaseEvent */ virtual void mouseReleaseEvent(QMouseEvent* event); private slots: - void slotUrlChanged(const KUrl& kurl); - void triggerIconsViewItem(Q3IconViewItem *item); - void triggerItem(const QModelIndex& index); - void updateUrl(); + /** + * Marks the view as active (DolphinView:isActive() will return true) + * and emits the 'activated' signal if it is not already active. + */ + void activate(); - void slotPercent(int percent); - void slotClear(); - void slotDeleteItem(KFileItem* item); - void slotCompleted(); - void slotInfoMessage(const QString& msg); - void slotErrorMessage(const QString& msg); + /** + * 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 KFileItem& index); - void slotGrabActivation(); + /** + * Generates a preview image for each file item in \a items. + * The current preview settings (maximum size, 'Show Preview' menu) + * are respected. + */ + void generatePreviews(const KFileItemList& items); /** - * 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. + * Replaces the icon of the item \a item by the preview pixmap + * \a pixmap. */ - void slotContentsMoving(int x, int y); + void showPreview(const KFileItem& item, const QPixmap& pixmap); + + void emitSelectionChangedSignal(); /** - * Filters the currently shown items by \a nameFilter. All items - * which contain the given filter string will be shown. + * Opens the context menu on position \a pos. The position + * is used to check whether the context menu is related to an + * item or to the viewport. + */ + void openContextMenu(const QPoint& pos); + + /** + * 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 KUrl& destPath, + const KFileItem& destItem); + + /** + * 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 updateSorting(DolphinView::Sorting sorting); + + /** + * Updates the view properties of the current URL to the + * sort order given by \a order. + */ + void updateSortOrder(Qt::SortOrder order); + + /** + * Updates the view properties of the current URL to the + * additional informations 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 \a item. If currently other items are selected, + * no hover information is shown. + * @see DolphinView::clearHoverInformation() */ - void slotChangeNameFilter(const QString& nameFilter); + 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 slotDeleteFileFinished(KJob* job); private: - //KFileView* fileView() const; - Q3ScrollView* scrollView() const; - ItemEffectsManager* itemEffectsManager() const; - 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); /** - * Returns the string representation for the index \a index - * for renaming \itemCount items. + * Creates a new view representing the given view mode (DolphinView::mode()). + * The current view will get deleted. */ - QString renameIndexPresentation(int index, int itemCount) const; + void createView(); + + void deleteView(); + + /** + * Returns a pointer to the currently used item view, which is either + * a ListView or a TreeView. + */ + QAbstractItemView* itemView() const; /** - * Applies the current view mode m_mode to the - * view implementation. + * Returns true, if the item \a item has been cut into + * the clipboard. */ - void applyModeToView(); + bool isCutItem(const KFileItem& item) const; + + /** Applies an item effect to all cut items. */ + void applyCutItemEffect(); - bool m_refreshing; - bool m_showProgress; + /** + * 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: + /** + * Remembers the original pixmap for an item before + * the cut effect is applied. + */ + struct CutItem + { + KUrl url; + QPixmap pixmap; + }; + + bool m_active; + bool m_showPreview; + bool m_loadingDirectory; + bool m_storedCategorizedSorting; Mode m_mode; - Q3VBoxLayout* m_topLayout; - UrlNavigator* m_urlNavigator; + DolphinMainWindow* m_mainWindow; + QVBoxLayout* m_topLayout; + + DolphinController* m_controller; DolphinIconsView* m_iconsView; - DolphinStatusBar* m_statusBar; + DolphinDetailsView* m_detailsView; + DolphinColumnView* m_columnView; + KFileItemDelegate* m_fileItemDelegate; - int m_iconSize; - int m_folderCount; - int m_fileCount; + DolphinModel* m_dolphinModel; + KDirLister* m_dirLister; + DolphinSortFilterProxyModel* m_proxyModel; - DolphinDirLister* m_dirLister; + QList m_cutItemsCache; - FilterBar *m_filterBar; + KUrl m_rootUrl; }; -#endif // _DOLPHINVIEW_H_ +/// Allow using DolphinView::Mode in QVariant +Q_DECLARE_METATYPE(DolphinView::Mode) + +#endif // DOLPHINVIEW_H