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-baloo.h>
26 #include "libdolphin_export.h"
28 #include <kparts/part.h>
30 #include <KFileItemDelegate>
31 #include <kio/fileundomanager.h>
37 #include <QLinkedList>
40 typedef KIO::FileUndoManager::CommandType CommandType
;
42 class DolphinItemListView
;
44 class KItemListContainer
;
49 class VersionControlObserver
;
51 class QGraphicsSceneDragDropEvent
;
55 * @short Represents a view for the directory content.
57 * View modes for icons, compact and details are supported. It's
65 class LIBDOLPHINPRIVATE_EXPORT DolphinView
: public QWidget
71 * Defines the view mode for a directory. The
72 * view mode is automatically updated if the directory itself
73 * defines a view mode (see class ViewProperties for details).
78 * The items are shown as icons with a name-label below.
83 * The icon, the name and the size of the items are
84 * shown per default as a table.
89 * The items are shown as icons with the name-label aligned
96 * @param url Specifies the content which should be shown.
97 * @param parent Parent widget of the view.
99 DolphinView(const KUrl
& url
, QWidget
* parent
);
101 virtual ~DolphinView();
104 * Returns the current active URL, where all actions are applied.
105 * The URL navigator is synchronized with this URL.
110 * If \a active is true, the view will marked as active. The active
111 * view is defined as view where all actions are applied to.
113 void setActive(bool active
);
114 bool isActive() const;
117 * Changes the view mode for the current directory to \a mode.
118 * If the view properties should be remembered for each directory
119 * (GeneralSettings::globalViewProps() returns false), then the
120 * changed view mode will be stored automatically.
122 void setMode(Mode mode
);
126 * Turns on the file preview for the all files of the current directory,
127 * if \a show is true.
128 * If the view properties should be remembered for each directory
129 * (GeneralSettings::globalViewProps() returns false), then the
130 * preview setting will be stored automatically.
132 void setPreviewsShown(bool show
);
133 bool previewsShown() const;
136 * Shows all hidden files of the current directory,
137 * if \a show is true.
138 * If the view properties should be remembered for each directory
139 * (GeneralSettings::globalViewProps() returns false), then the
140 * show hidden file setting will be stored automatically.
142 void setHiddenFilesShown(bool show
);
143 bool hiddenFilesShown() const;
146 * Turns on sorting by groups if \a enable is true.
148 void setGroupedSorting(bool grouped
);
149 bool groupedSorting() const;
152 * Returns the items of the view.
154 KFileItemList
items() const;
157 * @return The number of items. itemsCount() is faster in comparison
158 * to items().count().
160 int itemsCount() const;
163 * Returns the selected items. The list is empty if no item has been
166 KFileItemList
selectedItems() const;
169 * Returns the number of selected items (this is faster than
170 * invoking selectedItems().count()).
172 int selectedItemsCount() const;
175 * Marks the items indicated by \p urls to get selected after the
176 * directory DolphinView::url() has been loaded. Note that nothing
177 * gets selected if no loading of a directory has been triggered
178 * by DolphinView::setUrl() or DolphinView::reload().
180 void markUrlsAsSelected(const QList
<KUrl
>& urls
);
183 * Marks the item indicated by \p url to be scrolled to and as the
184 * current item after directory DolphinView::url() has been loaded.
186 void markUrlAsCurrent(const KUrl
& url
);
189 * All items that match to the pattern \a pattern will get selected
190 * if \a enabled is true and deselected if \a enabled is false.
192 void selectItems(const QRegExp
& pattern
, bool enabled
);
195 * Sets the zoom level to \a level. It is assured that the used
196 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
197 * ZoomLevelInfo::maximumLevel().
199 void setZoomLevel(int level
);
200 int zoomLevel() const;
202 void setSortRole(const QByteArray
& role
);
203 QByteArray
sortRole() const;
205 void setSortOrder(Qt::SortOrder order
);
206 Qt::SortOrder
sortOrder() const;
208 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
209 void setSortFoldersFirst(bool foldersFirst
);
210 bool sortFoldersFirst() const;
212 /** Sets the additional information which should be shown for the items. */
213 void setVisibleRoles(const QList
<QByteArray
>& roles
);
215 /** Returns the additional information which should be shown for the items. */
216 QList
<QByteArray
> visibleRoles() const;
221 * Refreshes the view to get synchronized with the settings (e.g. icons size,
227 * Saves the current settings (e.g. icons size, font, ..).
229 void writeSettings();
232 * Filters the currently shown items by \a nameFilter. All items
233 * which contain the given filter string will be shown.
235 void setNameFilter(const QString
& nameFilter
);
236 QString
nameFilter() const;
239 * Filters the currently shown items by \a filters. All items
240 * whose content-type matches those given by the list of filters
243 void setMimeTypeFilters(const QStringList
& filters
);
244 QStringList
mimeTypeFilters() const;
247 * Returns a textual representation of the state of the current
248 * folder or selected items, suitable for use in the status bar.
250 QString
statusBarText() const;
253 * Returns the version control actions that are provided for the items \p items.
254 * Usually the actions are presented in the context menu.
256 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
259 * Returns the state of the paste action:
260 * first is whether the action should be enabled
261 * second is the text for the action
263 QPair
<bool, QString
> pasteInfo() const;
266 * If \a tabsForFiles is true, the signal tabRequested() will also
267 * emitted also for files. Per default tabs for files is disabled
268 * and hence the signal tabRequested() will only be emitted for
271 void setTabsForFilesEnabled(bool tabsForFiles
);
272 bool isTabsForFilesEnabled() const;
275 * Returns true if the current view allows folders to be expanded,
276 * i.e. presents a hierarchical view to the user.
278 bool itemsExpandable() const;
281 * Restores the view state (current item, contents position, details view expansion state)
283 void restoreState(QDataStream
& stream
);
286 * Saves the view state (current item, contents position, details view expansion state)
288 void saveState(QDataStream
& stream
);
291 * Returns the root item which represents the current URL.
293 KFileItem
rootItem() const;
296 * Sets a context that is used for remembering the view-properties.
297 * Per default the context is empty and the path of the currently set URL
298 * is used for remembering the view-properties. Setting a custom context
299 * makes sense if specific types of URLs (e.g. search-URLs) should
300 * share common view-properties.
302 void setViewPropertiesContext(const QString
& context
);
303 QString
viewPropertiesContext() const;
306 * Checks if the given \a item can be opened as folder (e.g. archives).
307 * This function will also adjust the \a url (e.g. change the protocol).
308 * @return a valid and adjusted url if the item can be opened as folder,
309 * otherwise return an empty url.
311 static KUrl
openItemAsFolderUrl(const KFileItem
& item
, const bool browseThroughArchives
= true);
315 * Changes the directory to \a url. If the current directory is equal to
316 * \a url, nothing will be done (use DolphinView::reload() instead).
318 void setUrl(const KUrl
& url
);
322 * @see DolphinView::selectedItems()
327 * Inverts the current selection: selected items get unselected,
328 * unselected items get selected.
329 * @see DolphinView::selectedItems()
331 void invertSelection();
333 void clearSelection();
336 * Triggers the renaming of the currently selected items, where
337 * the user must input a new name for the items.
339 void renameSelectedItems();
342 * Moves all selected items to the trash.
344 void trashSelectedItems();
347 * Deletes all selected items.
349 void deleteSelectedItems();
352 * Copies all selected items to the clipboard and marks
355 void cutSelectedItems();
357 /** Copies all selected items to the clipboard. */
358 void copySelectedItems();
360 /** Pastes the clipboard data to this view. */
364 * Pastes the clipboard data into the currently selected
365 * folder. If the current selection is not exactly one folder, no
366 * paste operation is done.
368 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 KItemSet
& 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 KItemSet
& current
, const KItemSet
& 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 * Indicates in the status bar that the delete operation
617 * of the job \a job has been finished.
619 void slotDeleteFileFinished(KJob
* job
);
622 * Indicates in the status bar that the trash operation
623 * of the job \a job has been finished.
625 void slotTrashFileFinished(KJob
* job
);
628 * Invoked when the rename job is done, for error handling.
630 void slotRenamingResult(KJob
* job
);
633 * Invoked when the file item model has started the loading
634 * of the directory specified by DolphinView::url().
636 void slotDirectoryLoadingStarted();
639 * Invoked when the file item model indicates that the loading of a directory has
640 * been completed. Assures that pasted items and renamed items get seleced.
642 void slotDirectoryLoadingCompleted();
645 * Is invoked when items of KFileItemModel have been changed.
647 void slotItemsChanged();
650 * Is invoked when the sort order has been changed by the user by clicking
651 * on a header item. The view properties of the directory will get updated.
653 void slotSortOrderChangedByHeader(Qt::SortOrder current
, Qt::SortOrder previous
);
656 * Is invoked when the sort role has been changed by the user by clicking
657 * on a header item. The view properties of the directory will get updated.
659 void slotSortRoleChangedByHeader(const QByteArray
& current
, const QByteArray
& previous
);
662 * Is invoked when the visible roles have been changed by the user by dragging
663 * a header item. The view properties of the directory will get updated.
665 void slotVisibleRolesChangedByHeader(const QList
<QByteArray
>& current
,
666 const QList
<QByteArray
>& previous
);
668 void slotRoleEditingCanceled();
669 void slotRoleEditingFinished(int index
, const QByteArray
& role
, const QVariant
& value
);
672 * Observes the item with the URL \a url. As soon as the directory
673 * model indicates that the item is available, the item will
674 * get selected and it is assured that the item stays visible.
676 void observeCreatedItem(const KUrl
& url
);
679 * Called when a redirection happens.
680 * Testcase: fish://localhost
682 void slotDirectoryRedirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
685 * Applies the state that has been restored by restoreViewState()
688 void updateViewState();
693 * Calculates the number of currently shown files into
694 * \a fileCount and the number of folders into \a folderCount.
695 * The size of all files is written into \a totalFileSize.
696 * It is recommend using this method instead of asking the
697 * directory lister or the model directly, as it takes
698 * filtering and hierarchical previews into account.
700 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
703 void loadDirectory(const KUrl
& url
, bool reload
= false);
706 * Applies the view properties which are defined by the current URL
707 * to the DolphinView properties. The view properties are read from a
708 * .directory file either in the current directory, or in the
709 * share/apps/dolphin/view_properties/ subfolder of the user's .kde folder.
711 void applyViewProperties();
714 * Applies the given view properties to the DolphinView.
716 void applyViewProperties(const ViewProperties
& props
);
719 * Applies the m_mode property to the corresponding
720 * itemlayout-property of the KItemListView.
722 void applyModeToView();
725 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
726 * Pastes the clipboard data into the URL \a url.
728 void pasteToUrl(const KUrl
& url
);
731 * Returns a list of URLs for all selected items. The list is
732 * simplified, so that when the URLs are part of different tree
733 * levels, only the parent is returned.
735 KUrl::List
simplifiedSelectedUrls() const;
738 * Returns the MIME data for all selected items.
740 QMimeData
* selectionMimeData() const;
743 * Updates m_isFolderWritable dependent on whether the folder represented by
744 * the current URL is writable. If the state has changed, the signal
745 * writeableStateChanged() will be emitted.
747 void updateWritableState();
750 * @return The current URL if no viewproperties-context is given (see
751 * DolphinView::viewPropertiesContext(), otherwise the context
754 KUrl
viewPropertiesUrl() const;
759 bool m_assureVisibleCurrentIndex
;
760 bool m_isFolderWritable
;
761 bool m_dragging
; // True if a dragging is done. Required to be able to decide whether a
762 // tooltip may be shown when hovering an item.
765 QString m_viewPropertiesContext
;
767 QList
<QByteArray
> m_visibleRoles
;
769 QVBoxLayout
* m_topLayout
;
771 KFileItemModel
* m_model
;
772 DolphinItemListView
* m_view
;
773 KItemListContainer
* m_container
;
775 ToolTipManager
* m_toolTipManager
;
777 QTimer
* m_selectionChangedTimer
;
779 KUrl m_currentItemUrl
; // Used for making the view to remember the current URL after F5
780 bool m_scrollToCurrentItem
; // Used for marking we need to scroll to current item or not
781 QPoint m_restoredContentsPosition
;
783 QList
<KUrl
> m_selectedUrls
; // Used for making the view to remember selections after F5
784 bool m_clearSelectionBeforeSelectingNewItems
;
785 bool m_markFirstNewlySelectedItemAsCurrent
;
787 VersionControlObserver
* m_versionControlObserver
;
790 friend class TestBase
;
791 friend class DolphinDetailsViewTest
;
792 friend class DolphinPart
; // Accesses m_model
795 /// Allow using DolphinView::Mode in QVariant
796 Q_DECLARE_METATYPE(DolphinView::Mode
)
798 #endif // DOLPHINVIEW_H