1 /***************************************************************************
2 * Copyright (C) 2006-2009 by Peter Penz <peter.penz19@gmail.com> *
3 * Copyright (C) 2006 by Gregor Kališnik <gregor@podnapisi.net> *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
19 ***************************************************************************/
24 #include <config-nepomuk.h>
26 #include "libdolphin_export.h"
28 #include <kparts/part.h>
30 #include <KFileItemDelegate>
31 #include <kio/fileundomanager.h>
36 #include <QLinkedList>
40 typedef KIO::FileUndoManager::CommandType CommandType
;
42 class DolphinItemListView
;
44 class KActionCollection
;
46 class KItemListContainer
;
50 class VersionControlObserver
;
52 class QGraphicsSceneDragDropEvent
;
56 * @short Represents a view for the directory content.
58 * View modes for icons, compact and details are supported. It's
66 class LIBDOLPHINPRIVATE_EXPORT DolphinView
: public QWidget
72 * Defines the view mode for a directory. The
73 * view mode is automatically updated if the directory itself
74 * defines a view mode (see class ViewProperties for details).
79 * The items are shown as icons with a name-label below.
84 * The icon, the name and the size of the items are
85 * shown per default as a table.
90 * The items are shown as icons with the name-label aligned
97 * @param url Specifies the content which should be shown.
98 * @param parent Parent widget of the view.
100 DolphinView(const KUrl
& url
, QWidget
* parent
);
102 virtual ~DolphinView();
105 * Returns the current active URL, where all actions are applied.
106 * The URL navigator is synchronized with this URL.
111 * If \a active is true, the view will marked as active. The active
112 * view is defined as view where all actions are applied to.
114 void setActive(bool active
);
115 bool isActive() const;
118 * Changes the view mode for the current directory to \a mode.
119 * If the view properties should be remembered for each directory
120 * (GeneralSettings::globalViewProps() returns false), then the
121 * changed view mode will be stored automatically.
123 void setMode(Mode mode
);
127 * Turns on the file preview for the all files of the current directory,
128 * if \a show is true.
129 * If the view properties should be remembered for each directory
130 * (GeneralSettings::globalViewProps() returns false), then the
131 * preview setting will be stored automatically.
133 void setPreviewsShown(bool show
);
134 bool previewsShown() const;
137 * Shows all hidden files of the current directory,
138 * if \a show is true.
139 * If the view properties should be remembered for each directory
140 * (GeneralSettings::globalViewProps() returns false), then the
141 * show hidden file setting will be stored automatically.
143 void setHiddenFilesShown(bool show
);
144 bool hiddenFilesShown() const;
147 * Turns on sorting by groups if \a enable is true.
149 void setGroupedSorting(bool grouped
);
150 bool groupedSorting() const;
153 * Returns the items of the view.
155 KFileItemList
items() const;
158 * @return The number of items. itemsCount() is faster in comparison
159 * to items().count().
161 int itemsCount() const;
164 * Returns the selected items. The list is empty if no item has been
167 KFileItemList
selectedItems() const;
170 * Returns the number of selected items (this is faster than
171 * invoking selectedItems().count()).
173 int selectedItemsCount() const;
176 * Marks the items indicated by \p urls to get selected after the
177 * directory DolphinView::url() has been loaded. Note that nothing
178 * gets selected if no loading of a directory has been triggered
179 * by DolphinView::setUrl() or DolphinView::reload().
181 void markUrlsAsSelected(const QList
<KUrl
>& urls
);
184 * Marks the item indicated by \p url to be scrolled to and as the
185 * current item after directory DolphinView::url() has been loaded.
187 void markUrlAsCurrent(const KUrl
& url
);
190 * All items that match to the pattern \a pattern will get selected
191 * if \a enabled is true and deselected if \a enabled is false.
193 void selectItems(const QRegExp
& pattern
, bool enabled
);
196 * Sets the zoom level to \a level. It is assured that the used
197 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
198 * ZoomLevelInfo::maximumLevel().
200 void setZoomLevel(int level
);
201 int zoomLevel() const;
203 void setSortRole(const QByteArray
& role
);
204 QByteArray
sortRole() const;
206 void setSortOrder(Qt::SortOrder order
);
207 Qt::SortOrder
sortOrder() const;
209 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
210 void setSortFoldersFirst(bool foldersFirst
);
211 bool sortFoldersFirst() const;
213 /** Sets the additional information which should be shown for the items. */
214 void setVisibleRoles(const QList
<QByteArray
>& roles
);
216 /** Returns the additional information which should be shown for the items. */
217 QList
<QByteArray
> visibleRoles() const;
223 * Refreshes the view to get synchronized with the settings (e.g. icons size,
229 * Saves the current settings (e.g. icons size, font, ..).
231 void writeSettings();
234 * Filters the currently shown items by \a nameFilter. All items
235 * which contain the given filter string will be shown.
237 void setNameFilter(const QString
& nameFilter
);
238 QString
nameFilter() const;
241 * Filters the currently shown items by \a filters. All items
242 * whose content-type matches those given by the list of filters
245 void setMimeTypeFilters(const QStringList
& filters
);
246 QStringList
mimeTypeFilters() const;
249 * Returns a textual representation of the state of the current
250 * folder or selected items, suitable for use in the status bar.
252 QString
statusBarText() const;
255 * Returns the version control actions that are provided for the items \p items.
256 * Usually the actions are presented in the context menu.
258 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
261 * Returns the state of the paste action:
262 * first is whether the action should be enabled
263 * second is the text for the action
265 QPair
<bool, QString
> pasteInfo() const;
268 * If \a tabsForFiles is true, the signal tabRequested() will also
269 * emitted also for files. Per default tabs for files is disabled
270 * and hence the signal tabRequested() will only be emitted for
273 void setTabsForFilesEnabled(bool tabsForFiles
);
274 bool isTabsForFilesEnabled() const;
277 * Returns true if the current view allows folders to be expanded,
278 * i.e. presents a hierarchical view to the user.
280 bool itemsExpandable() const;
283 * Restores the view state (current item, contents position, details view expansion state)
285 void restoreState(QDataStream
& stream
);
288 * Saves the view state (current item, contents position, details view expansion state)
290 void saveState(QDataStream
& stream
);
293 * Returns the root item which represents the current URL.
295 KFileItem
rootItem() const;
298 * Sets a context that is used for remembering the view-properties.
299 * Per default the context is empty and the path of the currently set URL
300 * is used for remembering the view-properties. Setting a custom context
301 * makes sense if specific types of URLs (e.g. search-URLs) should
302 * share common view-properties.
304 void setViewPropertiesContext(const QString
& context
);
305 QString
viewPropertiesContext() const;
309 * Changes the directory to \a url. If the current directory is equal to
310 * \a url, nothing will be done (use DolphinView::reload() instead).
312 void setUrl(const KUrl
& url
);
316 * @see DolphinView::selectedItems()
321 * Inverts the current selection: selected items get unselected,
322 * unselected items get selected.
323 * @see DolphinView::selectedItems()
325 void invertSelection();
327 void clearSelection();
330 * Triggers the renaming of the currently selected items, where
331 * the user must input a new name for the items.
333 void renameSelectedItems();
336 * Moves all selected items to the trash.
338 void trashSelectedItems();
341 * Deletes all selected items.
343 void deleteSelectedItems();
346 * Copies all selected items to the clipboard and marks
349 void cutSelectedItems();
351 /** Copies all selected items to the clipboard. */
352 void copySelectedItems();
354 /** Pastes the clipboard data to this view. */
358 * Pastes the clipboard data into the currently selected
359 * folder. If the current selection is not exactly one folder, no
360 * paste operation is done.
362 void pasteIntoFolder();
364 /** Activates the view if the item list container gets focus. */
365 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
369 * Is emitted if the view has been activated by e. g. a mouse click.
374 * Is emitted if the URL of the view will be changed to \a url.
375 * After the URL has been changed the signal urlChanged() will
378 void urlAboutToBeChanged(const KUrl
& url
);
380 /** Is emitted if the URL of the view has been changed to \a url. */
381 void urlChanged(const KUrl
& url
);
384 * Is emitted when clicking on an item with the left mouse button.
386 void itemActivated(const KFileItem
& item
);
389 * Is emitted when multiple items have been activated by e. g.
390 * context menu open with.
392 void itemsActivated(const KFileItemList
& items
);
395 * Is emitted if items have been added or deleted.
397 void itemCountChanged();
400 * Is emitted if a new tab should be opened for the URL \a url.
402 void tabRequested(const KUrl
& url
);
405 * Is emitted if the view mode (IconsView, DetailsView,
406 * PreviewsView) has been changed.
408 void modeChanged(DolphinView::Mode current
, DolphinView::Mode previous
);
410 /** Is emitted if the 'show preview' property has been changed. */
411 void previewsShownChanged(bool shown
);
413 /** Is emitted if the 'show hidden files' property has been changed. */
414 void hiddenFilesShownChanged(bool shown
);
416 /** Is emitted if the 'grouped sorting' property has been changed. */
417 void groupedSortingChanged(bool groupedSorting
);
419 /** Is emitted if the sorting by name, size or date has been changed. */
420 void sortRoleChanged(const QByteArray
& role
);
422 /** Is emitted if the sort order (ascending or descending) has been changed. */
423 void sortOrderChanged(Qt::SortOrder order
);
426 * Is emitted if the sorting of files and folders (separate with folders
427 * first or mixed) has been changed.
429 void sortFoldersFirstChanged(bool foldersFirst
);
431 /** Is emitted if the additional information shown for this view has been changed. */
432 void visibleRolesChanged(const QList
<QByteArray
>& current
,
433 const QList
<QByteArray
>& previous
);
435 /** Is emitted if the zoom level has been changed by zooming in or out. */
436 void zoomLevelChanged(int current
, int previous
);
439 * Is emitted if information of an item is requested to be shown e. g. in the panel.
440 * If item is null, no item information request is pending.
442 void requestItemInfo(const KFileItem
& item
);
445 * Is emitted whenever the selection has been changed.
447 void selectionChanged(const KFileItemList
& selection
);
450 * Is emitted if a context menu is requested for the item \a item,
451 * which is part of \a url. If the item is null, the context menu
452 * for the URL should be shown and the custom actions \a customActions
455 void requestContextMenu(const QPoint
& pos
,
456 const KFileItem
& item
,
458 const QList
<QAction
*>& customActions
);
461 * Is emitted if an information message with the content \a msg
464 void infoMessage(const QString
& msg
);
467 * Is emitted if an error message with the content \a msg
470 void errorMessage(const QString
& msg
);
473 * Is emitted if an "operation completed" message with the content \a msg
476 void operationCompletedMessage(const QString
& msg
);
479 * Is emitted after DolphinView::setUrl() has been invoked and
480 * the current directory is loaded. If this signal is emitted,
481 * it is assured that the view contains already the correct root
482 * URL and property settings.
484 void directoryLoadingStarted();
487 * Is emitted after the directory triggered by DolphinView::setUrl()
490 void directoryLoadingCompleted();
493 * Is emitted after the directory loading triggered by DolphinView::setUrl()
496 void directoryLoadingCanceled();
499 * Is emitted after DolphinView::setUrl() has been invoked and provides
500 * the information how much percent of the current directory have been loaded.
502 void directoryLoadingProgress(int percent
);
505 * Is emitted if the sorting is done asynchronously and provides the
506 * progress information of the sorting.
508 void directorySortingProgress(int percent
);
511 * Emitted when the file-item-model emits redirection.
512 * Testcase: fish://localhost
514 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
517 * Is emitted when the URL set by DolphinView::setUrl() represents a file.
518 * In this case no signal errorMessage() will be emitted.
520 void urlIsFileError(const KUrl
& url
);
523 * Is emitted when the write state of the folder has been changed. The application
524 * should disable all actions like "Create New..." that depend on the write
527 void writeStateChanged(bool isFolderWritable
);
530 * Is emitted if the URL should be changed to the previous URL of the
531 * history (e.g. because the "back"-mousebutton has been pressed).
533 void goBackRequested();
536 * Is emitted if the URL should be changed to the next URL of the
537 * history (e.g. because the "next"-mousebutton has been pressed).
539 void goForwardRequested();
542 /** Changes the zoom level if Control is pressed during a wheel event. */
543 virtual void wheelEvent(QWheelEvent
* event
);
546 virtual void hideEvent(QHideEvent
* event
);
547 virtual bool event(QEvent
* event
);
551 * Marks the view as active (DolphinView:isActive() will return true)
552 * and emits the 'activated' signal if it is not already active.
556 void slotItemActivated(int index
);
557 void slotItemsActivated(const QSet
<int>& indexes
);
558 void slotItemMiddleClicked(int index
);
559 void slotItemContextMenuRequested(int index
, const QPointF
& pos
);
560 void slotViewContextMenuRequested(const QPointF
& pos
);
561 void slotHeaderContextMenuRequested(const QPointF
& pos
);
562 void slotHeaderColumnWidthChanged(const QByteArray
& role
, qreal current
, qreal previous
);
563 void slotItemHovered(int index
);
564 void slotItemUnhovered(int index
);
565 void slotItemDropEvent(int index
, QGraphicsSceneDragDropEvent
* event
);
566 void slotModelChanged(KItemModelBase
* current
, KItemModelBase
* previous
);
567 void slotMouseButtonPressed(int itemIndex
, Qt::MouseButtons buttons
);
570 * Emits the signal \a selectionChanged() with a small delay. This is
571 * because getting all file items for the selection can be an expensive
572 * operation. Fast selection changes are collected in this case and
573 * the signal is emitted only after no selection change has been done
574 * within a small delay.
576 void slotSelectionChanged(const QSet
<int>& current
, const QSet
<int>& previous
);
579 * Is called by emitDelayedSelectionChangedSignal() and emits the
580 * signal \a selectionChanged() with all selected file items as parameter.
582 void emitSelectionChangedSignal();
585 * Updates the view properties of the current URL to the
586 * sorting given by \a role.
588 void updateSortRole(const QByteArray
& role
);
591 * Updates the view properties of the current URL to the
592 * sort order given by \a order.
594 void updateSortOrder(Qt::SortOrder order
);
597 * Updates the view properties of the current URL to the
598 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
600 void updateSortFoldersFirst(bool foldersFirst
);
603 * Updates the status bar to show hover information for the
604 * item \a item. If currently other items are selected,
605 * no hover information is shown.
606 * @see DolphinView::clearHoverInformation()
608 void showHoverInformation(const KFileItem
& item
);
611 * Clears the hover information shown in the status bar.
612 * @see DolphinView::showHoverInformation().
614 void clearHoverInformation();
617 * Indicates in the status bar that the delete operation
618 * of the job \a job has been finished.
620 void slotDeleteFileFinished(KJob
* job
);
623 * Invoked when the file item model has started the loading
624 * of the directory specified by DolphinView::url().
626 void slotDirectoryLoadingStarted();
629 * Invoked when the file item model indicates that the loading of a directory has
630 * been completed. Assures that pasted items and renamed items get seleced.
632 void slotDirectoryLoadingCompleted();
635 * Is invoked when items of KFileItemModel have been changed.
637 void slotItemsChanged();
640 * Is invoked when the sort order has been changed by the user by clicking
641 * on a header item. The view properties of the directory will get updated.
643 void slotSortOrderChangedByHeader(Qt::SortOrder current
, Qt::SortOrder previous
);
646 * Is invoked when the sort role has been changed by the user by clicking
647 * on a header item. The view properties of the directory will get updated.
649 void slotSortRoleChangedByHeader(const QByteArray
& current
, const QByteArray
& previous
);
652 * Is invoked when the visible roles have been changed by the user by dragging
653 * a header item. The view properties of the directory will get updated.
655 void slotVisibleRolesChangedByHeader(const QList
<QByteArray
>& current
,
656 const QList
<QByteArray
>& previous
);
658 void slotRoleEditingFinished(int index
, const QByteArray
& role
, const QVariant
& value
);
661 * Observes the item with the URL \a url. As soon as the directory
662 * model indicates that the item is available, the item will
663 * get selected and it is assured that the item stays visible.
665 void observeCreatedItem(const KUrl
& url
);
668 * Called when a redirection happens.
669 * Testcase: fish://localhost
671 void slotDirectoryRedirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
674 * Applies the state that has been restored by restoreViewState()
677 void updateViewState();
682 * Calculates the number of currently shown files into
683 * \a fileCount and the number of folders into \a folderCount.
684 * The size of all files is written into \a totalFileSize.
685 * It is recommend using this method instead of asking the
686 * directory lister or the model directly, as it takes
687 * filtering and hierarchical previews into account.
689 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
692 void loadDirectory(const KUrl
& url
, bool reload
= false);
695 * Applies the view properties which are defined by the current URL
696 * to the DolphinView properties.
698 void applyViewProperties();
701 * Applies the m_mode property to the corresponding
702 * itemlayout-property of the KItemListView.
704 void applyModeToView();
707 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
708 * Pastes the clipboard data into the URL \a url.
710 void pasteToUrl(const KUrl
& url
);
713 * Returns a list of URLs for all selected items. The list is
714 * simplified, so that when the URLs are part of different tree
715 * levels, only the parent is returned.
717 KUrl::List
simplifiedSelectedUrls() const;
720 * Returns the MIME data for all selected items.
722 QMimeData
* selectionMimeData() const;
725 * Is invoked after a paste operation or a drag & drop
726 * operation and URLs from \a mimeData as selected.
727 * This allows to select all newly pasted
728 * items in restoreViewState().
730 void markPastedUrlsAsSelected(const QMimeData
* mimeData
);
733 * Updates m_isFolderWritable dependent on whether the folder represented by
734 * the current URL is writable. If the state has changed, the signal
735 * writeableStateChanged() will be emitted.
737 void updateWritableState();
740 * @return The current URL if no viewproperties-context is given (see
741 * DolphinView::viewPropertiesContext(), otherwise the context
744 KUrl
viewPropertiesUrl() const;
749 bool m_assureVisibleCurrentIndex
;
750 bool m_isFolderWritable
;
751 bool m_dragging
; // True if a dragging is done. Required to be able to decide whether a
752 // tooltip may be shown when hovering an item.
755 QString m_viewPropertiesContext
;
757 QList
<QByteArray
> m_visibleRoles
;
759 QVBoxLayout
* m_topLayout
;
761 KFileItemModel
* m_model
;
762 DolphinItemListView
* m_view
;
763 KItemListContainer
* m_container
;
765 ToolTipManager
* m_toolTipManager
;
767 QTimer
* m_selectionChangedTimer
;
769 KUrl m_currentItemUrl
; // Used for making the view to remember the current URL after F5
770 bool m_scrollToCurrentItem
; // Used for marking we need to scroll to current item or not
771 QPoint m_restoredContentsPosition
;
773 QList
<KUrl
> m_selectedUrls
; // Used for making the view to remember selections after F5
774 bool m_clearSelectionBeforeSelectingNewItems
;
776 VersionControlObserver
* m_versionControlObserver
;
779 friend class TestBase
;
780 friend class DolphinDetailsViewTest
;
781 friend class DolphinPart
; // Accesses m_model
784 /// Allow using DolphinView::Mode in QVariant
785 Q_DECLARE_METATYPE(DolphinView::Mode
)
787 #endif // DOLPHINVIEW_H