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 DolphinDirLister
;
43 class DolphinItemListContainer
;
45 class KActionCollection
;
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 * Returns the selected items. The list is empty if no item has been
161 KFileItemList
selectedItems() const;
164 * Returns the number of selected items (this is faster than
165 * invoking selectedItems().count()).
167 int selectedItemsCount() const;
170 * Marks the items indicated by \p urls to get selected after the
171 * directory DolphinView::url() has been loaded. Note that nothing
172 * gets selected if no loading of a directory has been triggered
173 * by DolphinView::setUrl() or DolphinView::reload().
175 void markUrlsAsSelected(const QList
<KUrl
>& urls
);
178 * Marks the item indicated by \p url as the current item after the
179 * directory DolphinView::url() has been loaded.
181 void markUrlAsCurrent(const KUrl
& url
);
184 * All items that match to the pattern \a pattern will get selected
185 * if \a enabled is true and deselected if \a enabled is false.
187 void setItemSelectionEnabled(const QRegExp
& pattern
, bool enabled
);
190 * Sets the zoom level to \a level. It is assured that the used
191 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
192 * ZoomLevelInfo::maximumLevel().
194 void setZoomLevel(int level
);
195 int zoomLevel() const;
198 * Returns true, if zooming in is possible. If false is returned,
199 * the maximum zooming level has been reached.
201 bool isZoomInPossible() const;
204 * Returns true, if zooming out is possible. If false is returned,
205 * the minimum zooming level has been reached.
207 bool isZoomOutPossible() const;
209 void setSortRole(const QByteArray
& role
);
210 QByteArray
sortRole() const;
212 void setSortOrder(Qt::SortOrder order
);
213 Qt::SortOrder
sortOrder() const;
215 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
216 void setSortFoldersFirst(bool foldersFirst
);
217 bool sortFoldersFirst() const;
219 /** Sets the additional information which should be shown for the items. */
220 void setVisibleRoles(const QList
<QByteArray
>& roles
);
222 /** Returns the additional information which should be shown for the items. */
223 QList
<QByteArray
> visibleRoles() const;
225 /** Reloads the current directory. */
231 * Refreshes the view to get synchronized with the settings (e.g. icons size,
237 * Saves the current settings (e.g. icons size, font, ..).
239 void writeSettings();
242 * Filters the currently shown items by \a nameFilter. All items
243 * which contain the given filter string will be shown.
245 void setNameFilter(const QString
& nameFilter
);
246 QString
nameFilter() const;
249 * Calculates the number of currently shown files into
250 * \a fileCount and the number of folders into \a folderCount.
251 * The size of all files is written into \a totalFileSize.
252 * It is recommend using this method instead of asking the
253 * directory lister or the model directly, as it takes
254 * filtering and hierarchical previews into account.
256 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
259 * Returns a textual representation of the state of the current
260 * folder or selected items, suitable for use in the status bar.
262 QString
statusBarText() const;
265 * Returns the version control actions that are provided for the items \p items.
266 * Usually the actions are presented in the context menu.
268 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
271 * Returns the state of the paste action:
272 * first is whether the action should be enabled
273 * second is the text for the action
275 QPair
<bool, QString
> pasteInfo() const;
278 * If \a tabsForFiles is true, the signal tabRequested() will also
279 * emitted also for files. Per default tabs for files is disabled
280 * and hence the signal tabRequested() will only be emitted for
283 void setTabsForFilesEnabled(bool tabsForFiles
);
284 bool isTabsForFilesEnabled() const;
287 * Returns true if the current view allows folders to be expanded,
288 * i.e. presents a hierarchical view to the user.
290 bool itemsExpandable() const;
293 * Restores the view state (current item, contents position, details view expansion state)
295 void restoreState(QDataStream
& stream
);
298 * Saves the view state (current item, contents position, details view expansion state)
300 void saveState(QDataStream
& stream
);
302 /** Returns true, if at least one item is selected. */
303 bool hasSelection() const;
306 * Returns the root item which represents the current URL.
308 KFileItem
rootItem() const;
312 * Changes the directory to \a url. If the current directory is equal to
313 * \a url, nothing will be done (use DolphinView::reload() instead).
315 void setUrl(const KUrl
& url
);
319 * @see DolphinView::selectedItems()
324 * Inverts the current selection: selected items get unselected,
325 * unselected items get selected.
326 * @see DolphinView::selectedItems()
328 void invertSelection();
330 void clearSelection();
333 * Triggers the renaming of the currently selected items, where
334 * the user must input a new name for the items.
336 void renameSelectedItems();
339 * Moves all selected items to the trash.
341 void trashSelectedItems();
344 * Deletes all selected items.
346 void deleteSelectedItems();
349 * Copies all selected items to the clipboard and marks
352 void cutSelectedItems();
354 /** Copies all selected items to the clipboard. */
355 void copySelectedItems();
357 /** Pastes the clipboard data to this view. */
361 * Pastes the clipboard data into the currently selected
362 * folder. If the current selection is not exactly one folder, no
363 * paste operation is done.
365 void pasteIntoFolder();
367 /** Activates the view if the item list container gets focus. */
368 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
372 * Is emitted if the view has been activated by e. g. a mouse click.
377 * Is emitted if the URL of the view will be changed to \a url.
378 * After the URL has been changed the signal urlChanged() will
381 void urlAboutToBeChanged(const KUrl
& url
);
383 /** Is emitted if the URL of the view has been changed to \a url. */
384 void urlChanged(const KUrl
& url
);
387 * Is emitted when clicking on an item with the left mouse button.
389 void itemActivated(const KFileItem
& item
);
392 * Is emitted if items have been added or deleted.
394 void itemCountChanged();
397 * Is emitted if a new tab should be opened for the URL \a url.
399 void tabRequested(const KUrl
& url
);
402 * Is emitted if the view mode (IconsView, DetailsView,
403 * PreviewsView) has been changed.
405 void modeChanged(DolphinView::Mode current
, DolphinView::Mode previous
);
407 /** Is emitted if the 'show preview' property has been changed. */
408 void previewsShownChanged(bool shown
);
410 /** Is emitted if the 'show hidden files' property has been changed. */
411 void hiddenFilesShownChanged(bool shown
);
413 /** Is emitted if the 'grouped sorting' property has been changed. */
414 void groupedSortingChanged(bool groupedSorting
);
416 /** Is emitted if the sorting by name, size or date has been changed. */
417 void sortRoleChanged(const QByteArray
& role
);
419 /** Is emitted if the sort order (ascending or descending) has been changed. */
420 void sortOrderChanged(Qt::SortOrder order
);
423 * Is emitted if the sorting of files and folders (separate with folders
424 * first or mixed) has been changed.
426 void sortFoldersFirstChanged(bool foldersFirst
);
428 /** Is emitted if the additional information shown for this view has been changed. */
429 void visibleRolesChanged(const QList
<QByteArray
>& current
,
430 const QList
<QByteArray
>& previous
);
432 /** Is emitted if the zoom level has been changed by zooming in or out. */
433 void zoomLevelChanged(int current
, int previous
);
436 * Is emitted if information of an item is requested to be shown e. g. in the panel.
437 * If item is null, no item information request is pending.
439 void requestItemInfo(const KFileItem
& item
);
442 * Is emitted whenever the selection has been changed.
444 void selectionChanged(const KFileItemList
& selection
);
447 * Is emitted if a context menu is requested for the item \a item,
448 * which is part of \a url. If the item is null, the context menu
449 * for the URL should be shown and the custom actions \a customActions
452 void requestContextMenu(const QPoint
& pos
,
453 const KFileItem
& item
,
455 const QList
<QAction
*>& customActions
);
458 * Is emitted if an information message with the content \a msg
461 void infoMessage(const QString
& msg
);
464 * Is emitted if an error message with the content \a msg
467 void errorMessage(const QString
& msg
);
470 * Is emitted if an "operation completed" message with the content \a msg
473 void operationCompletedMessage(const QString
& msg
);
476 * Is emitted after DolphinView::setUrl() has been invoked and
477 * the path \a url is currently loaded. If this signal is emitted,
478 * it is assured that the view contains already the correct root
479 * URL and property settings.
481 void startedPathLoading(const KUrl
& url
);
484 * Is emitted after the path triggered by DolphinView::setUrl()
487 void finishedPathLoading(const KUrl
& url
);
490 * Is emitted after DolphinView::setUrl() has been invoked and provides
491 * the information how much percent of the current path have been loaded.
493 void pathLoadingProgress(int percent
);
496 * Is emitted if the DolphinView::setUrl() is invoked but the URL is not
499 void urlIsFileError(const KUrl
& file
);
502 * Emitted when KDirLister emits redirection.
503 * Testcase: fish://localhost
505 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
508 * Is emitted when the write state of the folder has been changed. The application
509 * should disable all actions like "Create New..." that depend on the write
512 void writeStateChanged(bool isFolderWritable
);
515 * Is emitted if the URL should be changed to the previous URL of the
516 * history (e.g. because the "back"-mousebutton has been pressed).
518 void goBackRequested();
521 * Is emitted if the URL should be changed to the next URL of the
522 * history (e.g. because the "next"-mousebutton has been pressed).
524 void goForwardRequested();
527 /** Changes the zoom level if Control is pressed during a wheel event. */
528 virtual void wheelEvent(QWheelEvent
* event
);
531 virtual void hideEvent(QHideEvent
* event
);
535 * Marks the view as active (DolphinView:isActive() will return true)
536 * and emits the 'activated' signal if it is not already active.
540 void slotItemActivated(int index
);
541 void slotItemsActivated(const QSet
<int>& indexes
);
542 void slotItemMiddleClicked(int index
);
543 void slotItemContextMenuRequested(int index
, const QPointF
& pos
);
544 void slotViewContextMenuRequested(const QPointF
& pos
);
545 void slotHeaderContextMenuRequested(const QPointF
& pos
);
546 void slotItemHovered(int index
);
547 void slotItemUnhovered(int index
);
548 void slotItemDropEvent(int index
, QGraphicsSceneDragDropEvent
* event
);
549 void slotModelChanged(KItemModelBase
* current
, KItemModelBase
* previous
);
550 void slotMouseButtonPressed(int itemIndex
, Qt::MouseButtons buttons
);
553 * Emits the signal \a selectionChanged() with a small delay. This is
554 * because getting all file items for the selection can be an expensive
555 * operation. Fast selection changes are collected in this case and
556 * the signal is emitted only after no selection change has been done
557 * within a small delay.
559 void slotSelectionChanged(const QSet
<int>& current
, const QSet
<int>& previous
);
562 * Is called by emitDelayedSelectionChangedSignal() and emits the
563 * signal \a selectionChanged() with all selected file items as parameter.
565 void emitSelectionChangedSignal();
568 * Updates the view properties of the current URL to the
569 * sorting given by \a role.
571 void updateSortRole(const QByteArray
& role
);
574 * Updates the view properties of the current URL to the
575 * sort order given by \a order.
577 void updateSortOrder(Qt::SortOrder order
);
580 * Updates the view properties of the current URL to the
581 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
583 void updateSortFoldersFirst(bool foldersFirst
);
586 * Updates the status bar to show hover information for the
587 * item \a item. If currently other items are selected,
588 * no hover information is shown.
589 * @see DolphinView::clearHoverInformation()
591 void showHoverInformation(const KFileItem
& item
);
594 * Clears the hover information shown in the status bar.
595 * @see DolphinView::showHoverInformation().
597 void clearHoverInformation();
600 * Indicates in the status bar that the delete operation
601 * of the job \a job has been finished.
603 void slotDeleteFileFinished(KJob
* job
);
606 * Invoked when the directory lister has been started the
609 void slotDirListerStarted(const KUrl
& url
);
612 * Invoked when the file item model indicates that the directory lister has completed the loading
613 * of items, and that expanded folders have been restored (if the view mode is 'Details', and the
614 * view state is restored after navigating back or forward in history). Assures that pasted items
615 * and renamed items get seleced.
617 void slotLoadingCompleted();
620 * Is invoked when the KDirLister indicates refreshed items.
622 void slotRefreshItems();
625 * Is invoked when the sort order has been changed by the user by clicking
626 * on a header item. The view properties of the directory will get updated.
628 void slotSortOrderChangedByHeader(Qt::SortOrder current
, Qt::SortOrder previous
);
631 * Is invoked when the sort role has been changed by the user by clicking
632 * on a header item. The view properties of the directory will get updated.
634 void slotSortRoleChangedByHeader(const QByteArray
& current
, const QByteArray
& previous
);
637 * Is invoked when the visible roles have been changed by the user by dragging
638 * a header item. The view properties of the directory will get updated.
640 void slotVisibleRolesChangedByHeader(const QList
<QByteArray
>& current
,
641 const QList
<QByteArray
>& previous
);
644 * Observes the item with the URL \a url. As soon as the directory
645 * model indicates that the item is available, the item will
646 * get selected and it is assured that the item stays visible.
648 * @see selectAndScrollToCreatedItem()
650 void observeCreatedItem(const KUrl
& url
);
653 * Selects and scrolls to the item that got observed
654 * by observeCreatedItem().
656 void selectAndScrollToCreatedItem();
659 * Called when a redirection happens.
660 * Testcase: fish://localhost
662 void slotRedirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
665 * Applies the state that has been restored by restoreViewState()
668 void updateViewState();
672 //void slotUrlChangeRequested(const KUrl& url);
675 KFileItemModel
* fileItemModel() const;
677 void loadDirectory(const KUrl
& url
, bool reload
= false);
680 * Applies the view properties which are defined by the current URL
681 * to the DolphinView properties.
683 void applyViewProperties();
686 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
687 * Pastes the clipboard data into the URL \a url.
689 void pasteToUrl(const KUrl
& url
);
692 * Returns a list of URLs for all selected items. The list is
693 * simplified, so that when the URLs are part of different tree
694 * levels, only the parent is returned.
696 KUrl::List
simplifiedSelectedUrls() const;
699 * Returns the MIME data for all selected items.
701 QMimeData
* selectionMimeData() const;
704 * Is invoked after a paste operation or a drag & drop
705 * operation and URLs from \a mimeData as selected.
706 * This allows to select all newly pasted
707 * items in restoreViewState().
709 void markPastedUrlsAsSelected(const QMimeData
* mimeData
);
712 * Updates m_isFolderWritable dependent on whether the folder represented by
713 * the current URL is writable. If the state has changed, the signal
714 * writeableStateChanged() will be emitted.
716 void updateWritableState();
719 * Returns the text for the filesize by converting it to the best fitting
722 static QString
fileSizeText(KIO::filesize_t fileSize
);
727 bool m_assureVisibleCurrentIndex
;
728 bool m_isFolderWritable
;
729 bool m_dragging
; // True if a dragging is done. Required to be able to decide whether a
730 // tooltip may be shown when hovering an item.
734 QList
<QByteArray
> m_visibleRoles
;
736 QVBoxLayout
* m_topLayout
;
738 DolphinDirLister
* m_dirLister
;
739 DolphinItemListContainer
* m_container
;
741 ToolTipManager
* m_toolTipManager
;
743 QTimer
* m_selectionChangedTimer
;
745 KUrl m_currentItemUrl
; // Used for making the view to remember the current URL after F5
746 QPoint m_restoredContentsPosition
;
747 KUrl m_createdItemUrl
; // URL for a new item that got created by the "Create New..." menu
749 QList
<KUrl
> m_selectedUrls
; // Used for making the view to remember selections after F5
751 VersionControlObserver
* m_versionControlObserver
;
754 friend class TestBase
;
755 friend class DolphinDetailsViewTest
;
758 /// Allow using DolphinView::Mode in QVariant
759 Q_DECLARE_METATYPE(DolphinView::Mode
)
761 #endif // DOLPHINVIEW_H