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;
308 * Checks if the given \a item can be opened as folder (e.g. archives).
309 * This function will also adjust the \a url (e.g. change the protocol).
310 * @return a valid and adjusted url if the item can be opened as folder,
311 * otherwise return an empty url.
313 static KUrl
openItemAsFolderUrl(const KFileItem
& item
, const bool browseThroughArchives
= true);
317 * Changes the directory to \a url. If the current directory is equal to
318 * \a url, nothing will be done (use DolphinView::reload() instead).
320 void setUrl(const KUrl
& url
);
324 * @see DolphinView::selectedItems()
329 * Inverts the current selection: selected items get unselected,
330 * unselected items get selected.
331 * @see DolphinView::selectedItems()
333 void invertSelection();
335 void clearSelection();
338 * Triggers the renaming of the currently selected items, where
339 * the user must input a new name for the items.
341 void renameSelectedItems();
344 * Moves all selected items to the trash.
346 void trashSelectedItems();
349 * Deletes all selected items.
351 void deleteSelectedItems();
354 * Copies all selected items to the clipboard and marks
357 void cutSelectedItems();
359 /** Copies all selected items to the clipboard. */
360 void copySelectedItems();
362 /** Pastes the clipboard data to this view. */
366 * Pastes the clipboard data into the currently selected
367 * folder. If the current selection is not exactly one folder, no
368 * paste operation is done.
370 void pasteIntoFolder();
372 /** Activates the view if the item list container gets focus. */
373 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
377 * Is emitted if the view has been activated by e. g. a mouse click.
382 * Is emitted if the URL of the view will be changed to \a url.
383 * After the URL has been changed the signal urlChanged() will
386 void urlAboutToBeChanged(const KUrl
& url
);
388 /** Is emitted if the URL of the view has been changed to \a url. */
389 void urlChanged(const KUrl
& url
);
392 * Is emitted when clicking on an item with the left mouse button.
394 void itemActivated(const KFileItem
& item
);
397 * Is emitted when multiple items have been activated by e. g.
398 * context menu open with.
400 void itemsActivated(const KFileItemList
& items
);
403 * Is emitted if items have been added or deleted.
405 void itemCountChanged();
408 * Is emitted if a new tab should be opened for the URL \a url.
410 void tabRequested(const KUrl
& url
);
413 * Is emitted if the view mode (IconsView, DetailsView,
414 * PreviewsView) has been changed.
416 void modeChanged(DolphinView::Mode current
, DolphinView::Mode previous
);
418 /** Is emitted if the 'show preview' property has been changed. */
419 void previewsShownChanged(bool shown
);
421 /** Is emitted if the 'show hidden files' property has been changed. */
422 void hiddenFilesShownChanged(bool shown
);
424 /** Is emitted if the 'grouped sorting' property has been changed. */
425 void groupedSortingChanged(bool groupedSorting
);
427 /** Is emitted if the sorting by name, size or date has been changed. */
428 void sortRoleChanged(const QByteArray
& role
);
430 /** Is emitted if the sort order (ascending or descending) has been changed. */
431 void sortOrderChanged(Qt::SortOrder order
);
434 * Is emitted if the sorting of files and folders (separate with folders
435 * first or mixed) has been changed.
437 void sortFoldersFirstChanged(bool foldersFirst
);
439 /** Is emitted if the additional information shown for this view has been changed. */
440 void visibleRolesChanged(const QList
<QByteArray
>& current
,
441 const QList
<QByteArray
>& previous
);
443 /** Is emitted if the zoom level has been changed by zooming in or out. */
444 void zoomLevelChanged(int current
, int previous
);
447 * Is emitted if information of an item is requested to be shown e. g. in the panel.
448 * If item is null, no item information request is pending.
450 void requestItemInfo(const KFileItem
& item
);
453 * Is emitted whenever the selection has been changed.
455 void selectionChanged(const KFileItemList
& selection
);
458 * Is emitted if a context menu is requested for the item \a item,
459 * which is part of \a url. If the item is null, the context menu
460 * for the URL should be shown and the custom actions \a customActions
463 void requestContextMenu(const QPoint
& pos
,
464 const KFileItem
& item
,
466 const QList
<QAction
*>& customActions
);
469 * Is emitted if an information message with the content \a msg
472 void infoMessage(const QString
& msg
);
475 * Is emitted if an error message with the content \a msg
478 void errorMessage(const QString
& msg
);
481 * Is emitted if an "operation completed" message with the content \a msg
484 void operationCompletedMessage(const QString
& msg
);
487 * Is emitted after DolphinView::setUrl() has been invoked and
488 * the current directory is loaded. If this signal is emitted,
489 * it is assured that the view contains already the correct root
490 * URL and property settings.
492 void directoryLoadingStarted();
495 * Is emitted after the directory triggered by DolphinView::setUrl()
498 void directoryLoadingCompleted();
501 * Is emitted after the directory loading triggered by DolphinView::setUrl()
504 void directoryLoadingCanceled();
507 * Is emitted after DolphinView::setUrl() has been invoked and provides
508 * the information how much percent of the current directory have been loaded.
510 void directoryLoadingProgress(int percent
);
513 * Is emitted if the sorting is done asynchronously and provides the
514 * progress information of the sorting.
516 void directorySortingProgress(int percent
);
519 * Emitted when the file-item-model emits redirection.
520 * Testcase: fish://localhost
522 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
525 * Is emitted when the URL set by DolphinView::setUrl() represents a file.
526 * In this case no signal errorMessage() will be emitted.
528 void urlIsFileError(const KUrl
& url
);
531 * Is emitted when the write state of the folder has been changed. The application
532 * should disable all actions like "Create New..." that depend on the write
535 void writeStateChanged(bool isFolderWritable
);
538 * Is emitted if the URL should be changed to the previous URL of the
539 * history (e.g. because the "back"-mousebutton has been pressed).
541 void goBackRequested();
544 * Is emitted if the URL should be changed to the next URL of the
545 * history (e.g. because the "next"-mousebutton has been pressed).
547 void goForwardRequested();
550 /** Changes the zoom level if Control is pressed during a wheel event. */
551 virtual void wheelEvent(QWheelEvent
* event
);
554 virtual void hideEvent(QHideEvent
* event
);
555 virtual bool event(QEvent
* event
);
559 * Marks the view as active (DolphinView:isActive() will return true)
560 * and emits the 'activated' signal if it is not already active.
564 void slotItemActivated(int index
);
565 void slotItemsActivated(const QSet
<int>& indexes
);
566 void slotItemMiddleClicked(int index
);
567 void slotItemContextMenuRequested(int index
, const QPointF
& pos
);
568 void slotViewContextMenuRequested(const QPointF
& pos
);
569 void slotHeaderContextMenuRequested(const QPointF
& pos
);
570 void slotHeaderColumnWidthChanged(const QByteArray
& role
, qreal current
, qreal previous
);
571 void slotItemHovered(int index
);
572 void slotItemUnhovered(int index
);
573 void slotItemDropEvent(int index
, QGraphicsSceneDragDropEvent
* event
);
574 void slotModelChanged(KItemModelBase
* current
, KItemModelBase
* previous
);
575 void slotMouseButtonPressed(int itemIndex
, Qt::MouseButtons buttons
);
578 * Is called when new items get pasted or dropped.
580 void slotAboutToCreate(const KUrl::List
& urls
);
583 * Emits the signal \a selectionChanged() with a small delay. This is
584 * because getting all file items for the selection can be an expensive
585 * operation. Fast selection changes are collected in this case and
586 * the signal is emitted only after no selection change has been done
587 * within a small delay.
589 void slotSelectionChanged(const QSet
<int>& current
, const QSet
<int>& previous
);
592 * Is called by emitDelayedSelectionChangedSignal() and emits the
593 * signal \a selectionChanged() with all selected file items as parameter.
595 void emitSelectionChangedSignal();
598 * Updates the view properties of the current URL to the
599 * sorting given by \a role.
601 void updateSortRole(const QByteArray
& role
);
604 * Updates the view properties of the current URL to the
605 * sort order given by \a order.
607 void updateSortOrder(Qt::SortOrder order
);
610 * Updates the view properties of the current URL to the
611 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
613 void updateSortFoldersFirst(bool foldersFirst
);
616 * Updates the status bar to show hover information for the
617 * item \a item. If currently other items are selected,
618 * no hover information is shown.
619 * @see DolphinView::clearHoverInformation()
621 void showHoverInformation(const KFileItem
& item
);
624 * Clears the hover information shown in the status bar.
625 * @see DolphinView::showHoverInformation().
627 void clearHoverInformation();
630 * Indicates in the status bar that the delete operation
631 * of the job \a job has been finished.
633 void slotDeleteFileFinished(KJob
* job
);
635 void slotRenamingFailed(const KUrl
& oldUrl
, const KUrl
& newUrl
);
638 * Invoked when the file item model has started the loading
639 * of the directory specified by DolphinView::url().
641 void slotDirectoryLoadingStarted();
644 * Invoked when the file item model indicates that the loading of a directory has
645 * been completed. Assures that pasted items and renamed items get seleced.
647 void slotDirectoryLoadingCompleted();
650 * Is invoked when items of KFileItemModel have been changed.
652 void slotItemsChanged();
655 * Is invoked when the sort order has been changed by the user by clicking
656 * on a header item. The view properties of the directory will get updated.
658 void slotSortOrderChangedByHeader(Qt::SortOrder current
, Qt::SortOrder previous
);
661 * Is invoked when the sort role has been changed by the user by clicking
662 * on a header item. The view properties of the directory will get updated.
664 void slotSortRoleChangedByHeader(const QByteArray
& current
, const QByteArray
& previous
);
667 * Is invoked when the visible roles have been changed by the user by dragging
668 * a header item. The view properties of the directory will get updated.
670 void slotVisibleRolesChangedByHeader(const QList
<QByteArray
>& current
,
671 const QList
<QByteArray
>& previous
);
673 void slotRoleEditingCanceled();
674 void slotRoleEditingFinished(int index
, const QByteArray
& role
, const QVariant
& value
);
677 * Observes the item with the URL \a url. As soon as the directory
678 * model indicates that the item is available, the item will
679 * get selected and it is assured that the item stays visible.
681 void observeCreatedItem(const KUrl
& url
);
684 * Called when a redirection happens.
685 * Testcase: fish://localhost
687 void slotDirectoryRedirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
690 * Applies the state that has been restored by restoreViewState()
693 void updateViewState();
698 * Calculates the number of currently shown files into
699 * \a fileCount and the number of folders into \a folderCount.
700 * The size of all files is written into \a totalFileSize.
701 * It is recommend using this method instead of asking the
702 * directory lister or the model directly, as it takes
703 * filtering and hierarchical previews into account.
705 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
708 void loadDirectory(const KUrl
& url
, bool reload
= false);
711 * Applies the view properties which are defined by the current URL
712 * to the DolphinView properties.
714 void applyViewProperties();
717 * Applies the m_mode property to the corresponding
718 * itemlayout-property of the KItemListView.
720 void applyModeToView();
723 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
724 * Pastes the clipboard data into the URL \a url.
726 void pasteToUrl(const KUrl
& url
);
729 * Returns a list of URLs for all selected items. The list is
730 * simplified, so that when the URLs are part of different tree
731 * levels, only the parent is returned.
733 KUrl::List
simplifiedSelectedUrls() const;
736 * Returns the MIME data for all selected items.
738 QMimeData
* selectionMimeData() const;
741 * Updates m_isFolderWritable dependent on whether the folder represented by
742 * the current URL is writable. If the state has changed, the signal
743 * writeableStateChanged() will be emitted.
745 void updateWritableState();
748 * @return The current URL if no viewproperties-context is given (see
749 * DolphinView::viewPropertiesContext(), otherwise the context
752 KUrl
viewPropertiesUrl() const;
757 bool m_assureVisibleCurrentIndex
;
758 bool m_isFolderWritable
;
759 bool m_dragging
; // True if a dragging is done. Required to be able to decide whether a
760 // tooltip may be shown when hovering an item.
763 QString m_viewPropertiesContext
;
765 QList
<QByteArray
> m_visibleRoles
;
767 QVBoxLayout
* m_topLayout
;
769 KFileItemModel
* m_model
;
770 DolphinItemListView
* m_view
;
771 KItemListContainer
* m_container
;
773 ToolTipManager
* m_toolTipManager
;
775 QTimer
* m_selectionChangedTimer
;
777 KUrl m_currentItemUrl
; // Used for making the view to remember the current URL after F5
778 bool m_scrollToCurrentItem
; // Used for marking we need to scroll to current item or not
779 QPoint m_restoredContentsPosition
;
781 QList
<KUrl
> m_selectedUrls
; // Used for making the view to remember selections after F5
782 bool m_clearSelectionBeforeSelectingNewItems
;
783 bool m_markFirstNewlySelectedItemAsCurrent
;
785 VersionControlObserver
* m_versionControlObserver
;
788 friend class TestBase
;
789 friend class DolphinDetailsViewTest
;
790 friend class DolphinPart
; // Accesses m_model
793 /// Allow using DolphinView::Mode in QVariant
794 Q_DECLARE_METATYPE(DolphinView::Mode
)
796 #endif // DOLPHINVIEW_H