]> cloud.milkyroute.net Git - dolphin.git/blob - src/views/dolphinview.h
Selection and current item fixes
[dolphin.git] / src / views / dolphinview.h
1 /***************************************************************************
2 * Copyright (C) 2006-2009 by Peter Penz <peter.penz19@gmail.com> *
3 * Copyright (C) 2006 by Gregor Kališnik <gregor@podnapisi.net> *
4 * *
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. *
9 * *
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. *
14 * *
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 ***************************************************************************/
20
21 #ifndef DOLPHINVIEW_H
22 #define DOLPHINVIEW_H
23
24 #include <config-nepomuk.h>
25
26 #include "libdolphin_export.h"
27
28 #include <kparts/part.h>
29 #include <KFileItem>
30 #include <KFileItemDelegate>
31 #include <kio/fileundomanager.h>
32 #include <KIO/Job>
33
34 #include <QBoxLayout>
35 #include <QKeyEvent>
36 #include <QLinkedList>
37 #include <QSet>
38 #include <QWidget>
39
40 typedef KIO::FileUndoManager::CommandType CommandType;
41
42 class DolphinDirLister;
43 class DolphinItemListContainer;
44 class KAction;
45 class KActionCollection;
46 class KFileItemModel;
47 class KItemModelBase;
48 class KUrl;
49 class ToolTipManager;
50 class VersionControlObserver;
51 class ViewProperties;
52 class QGraphicsSceneDragDropEvent;
53 class QRegExp;
54
55 /**
56 * @short Represents a view for the directory content.
57 *
58 * View modes for icons, compact and details are supported. It's
59 * possible to adjust:
60 * - sort order
61 * - sort type
62 * - show hidden files
63 * - show previews
64 * - enable grouping
65 */
66 class LIBDOLPHINPRIVATE_EXPORT DolphinView : public QWidget
67 {
68 Q_OBJECT
69
70 public:
71 /**
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).
75 */
76 enum Mode
77 {
78 /**
79 * The items are shown as icons with a name-label below.
80 */
81 IconsView = 0,
82
83 /**
84 * The icon, the name and the size of the items are
85 * shown per default as a table.
86 */
87 DetailsView,
88
89 /**
90 * The items are shown as icons with the name-label aligned
91 * to the right side.
92 */
93 CompactView
94 };
95
96 /** Defines the sort order for the items of a directory. */
97 enum Sorting
98 {
99 SortByName = 0,
100 SortBySize,
101 SortByDate,
102 SortByPermissions,
103 SortByOwner,
104 SortByGroup,
105 SortByType,
106 SortByDestination,
107 SortByPath
108 };
109
110 /** Defines the additional information shown for the items of a directory. */
111 enum AdditionalInfo
112 {
113 NoInfo = 0,
114 NameInfo,
115 SizeInfo,
116 DateInfo,
117 PermissionsInfo,
118 OwnerInfo,
119 GroupInfo,
120 TypeInfo,
121 DestinationInfo,
122 PathInfo
123 };
124
125 /**
126 * @param url Specifies the content which should be shown.
127 * @param parent Parent widget of the view.
128 */
129 DolphinView(const KUrl& url, QWidget* parent);
130
131 virtual ~DolphinView();
132
133 /**
134 * Returns the current active URL, where all actions are applied.
135 * The URL navigator is synchronized with this URL.
136 */
137 KUrl url() const;
138
139 /**
140 * If \a active is true, the view will marked as active. The active
141 * view is defined as view where all actions are applied to.
142 */
143 void setActive(bool active);
144 bool isActive() const;
145
146 /**
147 * Changes the view mode for the current directory to \a mode.
148 * If the view properties should be remembered for each directory
149 * (GeneralSettings::globalViewProps() returns false), then the
150 * changed view mode will be stored automatically.
151 */
152 void setMode(Mode mode);
153 Mode mode() const;
154
155 /**
156 * Turns on the file preview for the all files of the current directory,
157 * if \a show is true.
158 * If the view properties should be remembered for each directory
159 * (GeneralSettings::globalViewProps() returns false), then the
160 * preview setting will be stored automatically.
161 */
162 void setPreviewsShown(bool show);
163 bool previewsShown() const;
164
165 /**
166 * Shows all hidden files of the current directory,
167 * if \a show is true.
168 * If the view properties should be remembered for each directory
169 * (GeneralSettings::globalViewProps() returns false), then the
170 * show hidden file setting will be stored automatically.
171 */
172 void setHiddenFilesShown(bool show);
173 bool hiddenFilesShown() const;
174
175 /**
176 * Turns on sorting by groups if \a enable is true.
177 */
178 void setGroupedSorting(bool grouped);
179 bool groupedSorting() const;
180
181 /**
182 * Returns the items of the view.
183 */
184 KFileItemList items() const;
185
186 /**
187 * Returns the selected items. The list is empty if no item has been
188 * selected.
189 */
190 KFileItemList selectedItems() const;
191
192 /**
193 * Returns the number of selected items (this is faster than
194 * invoking selectedItems().count()).
195 */
196 int selectedItemsCount() const;
197
198 /**
199 * Marks the items indicated by \p urls to get selected after the
200 * directory DolphinView::url() has been loaded. Note that nothing
201 * gets selected if no loading of a directory has been triggered
202 * by DolphinView::setUrl() or DolphinView::reload().
203 */
204 void markUrlsAsSelected(const QList<KUrl>& urls);
205
206 /**
207 * Marks the item indicated by \p url as the current item after the
208 * directory DolphinView::url() has been loaded.
209 */
210 void markUrlAsCurrent(const KUrl& url);
211
212 /**
213 * All items that match to the pattern \a pattern will get selected
214 * if \a enabled is true and deselected if \a enabled is false.
215 */
216 void setItemSelectionEnabled(const QRegExp& pattern, bool enabled);
217
218 /**
219 * Sets the zoom level to \a level. It is assured that the used
220 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
221 * ZoomLevelInfo::maximumLevel().
222 */
223 void setZoomLevel(int level);
224 int zoomLevel() const;
225
226 /**
227 * Returns true, if zooming in is possible. If false is returned,
228 * the maximum zooming level has been reached.
229 */
230 bool isZoomInPossible() const;
231
232 /**
233 * Returns true, if zooming out is possible. If false is returned,
234 * the minimum zooming level has been reached.
235 */
236 bool isZoomOutPossible() const;
237
238 /** Sets the sorting criterion (e.g., SortByName, SortBySize,...) of the items inside a directory (see DolphinView::Sorting). */
239 void setSorting(Sorting sorting);
240
241 /** Returns the sorting criterion (e.g., SortByName, SortBySize,...) of the items inside a directory (see DolphinView::Sorting). */
242 Sorting sorting() const;
243
244 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
245 void setSortOrder(Qt::SortOrder order);
246
247 /** Returns the currently used sort order (Qt::Ascending or Qt::Descending). */
248 Qt::SortOrder sortOrder() const;
249
250 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
251 void setSortFoldersFirst(bool foldersFirst);
252
253 /** Returns if files and folders are sorted separately or not. */
254 bool sortFoldersFirst() const;
255
256 /** Sets the additional information which should be shown for the items. */
257 void setAdditionalInfoList(const QList<AdditionalInfo>& info);
258
259 /** Returns the additional information which should be shown for the items. */
260 QList<AdditionalInfo> additionalInfoList() const;
261
262 /** Reloads the current directory. */
263 void reload();
264
265 void stopLoading();
266
267 /**
268 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
269 * This method only needs to get invoked if the view settings for the Icons View,
270 * Details View or Columns View have been changed.
271 */
272 void refresh();
273
274 /**
275 * Filters the currently shown items by \a nameFilter. All items
276 * which contain the given filter string will be shown.
277 */
278 void setNameFilter(const QString& nameFilter);
279 QString nameFilter() const;
280
281 /**
282 * Calculates the number of currently shown files into
283 * \a fileCount and the number of folders into \a folderCount.
284 * The size of all files is written into \a totalFileSize.
285 * It is recommend using this method instead of asking the
286 * directory lister or the model directly, as it takes
287 * filtering and hierarchical previews into account.
288 */
289 void calculateItemCount(int& fileCount, int& folderCount, KIO::filesize_t& totalFileSize) const;
290
291 /**
292 * Returns a textual representation of the state of the current
293 * folder or selected items, suitable for use in the status bar.
294 */
295 QString statusBarText() const;
296
297 /**
298 * Returns the version control actions that are provided for the items \p items.
299 * Usually the actions are presented in the context menu.
300 */
301 QList<QAction*> versionControlActions(const KFileItemList& items) const;
302
303 /**
304 * Returns the state of the paste action:
305 * first is whether the action should be enabled
306 * second is the text for the action
307 */
308 QPair<bool, QString> pasteInfo() const;
309
310 /**
311 * If \a tabsForFiles is true, the signal tabRequested() will also
312 * emitted also for files. Per default tabs for files is disabled
313 * and hence the signal tabRequested() will only be emitted for
314 * directories.
315 */
316 void setTabsForFilesEnabled(bool tabsForFiles);
317 bool isTabsForFilesEnabled() const;
318
319 /**
320 * Returns true if the current view allows folders to be expanded,
321 * i.e. presents a hierarchical view to the user.
322 */
323 bool itemsExpandable() const;
324
325 /**
326 * Restores the view state (current item, contents position, details view expansion state)
327 */
328 void restoreState(QDataStream& stream);
329
330 /**
331 * Saves the view state (current item, contents position, details view expansion state)
332 */
333 void saveState(QDataStream& stream);
334
335 /** Returns true, if at least one item is selected. */
336 bool hasSelection() const;
337
338 /**
339 * Returns the root item which represents the current URL. Note that the returned
340 * item can be null (KFileItem::isNull() will return true) in case that the directory
341 * has not been loaded.
342 */
343 KFileItem rootItem() const;
344
345 public slots:
346 /**
347 * Changes the directory to \a url. If the current directory is equal to
348 * \a url, nothing will be done (use DolphinView::reload() instead).
349 */
350 void setUrl(const KUrl& url);
351
352 /**
353 * Selects all items.
354 * @see DolphinView::selectedItems()
355 */
356 void selectAll();
357
358 /**
359 * Inverts the current selection: selected items get unselected,
360 * unselected items get selected.
361 * @see DolphinView::selectedItems()
362 */
363 void invertSelection();
364
365 void clearSelection();
366
367 /**
368 * Triggers the renaming of the currently selected items, where
369 * the user must input a new name for the items.
370 */
371 void renameSelectedItems();
372
373 /**
374 * Moves all selected items to the trash.
375 */
376 void trashSelectedItems();
377
378 /**
379 * Deletes all selected items.
380 */
381 void deleteSelectedItems();
382
383 /**
384 * Copies all selected items to the clipboard and marks
385 * the items as cut.
386 */
387 void cutSelectedItems();
388
389 /** Copies all selected items to the clipboard. */
390 void copySelectedItems();
391
392 /** Pastes the clipboard data to this view. */
393 void paste();
394
395 /**
396 * Pastes the clipboard data into the currently selected
397 * folder. If the current selection is not exactly one folder, no
398 * paste operation is done.
399 */
400 void pasteIntoFolder();
401
402 /** Activates the view if the item list container gets focus. */
403 virtual bool eventFilter(QObject* watched, QEvent* event);
404
405 signals:
406 /**
407 * Is emitted if the view has been activated by e. g. a mouse click.
408 */
409 void activated();
410
411 /**
412 * Is emitted if the URL of the view will be changed to \a url.
413 * After the URL has been changed the signal urlChanged() will
414 * be emitted.
415 */
416 void urlAboutToBeChanged(const KUrl& url);
417
418 /** Is emitted if the URL of the view has been changed to \a url. */
419 void urlChanged(const KUrl& url);
420
421 /**
422 * Is emitted when clicking on an item with the left mouse button.
423 */
424 void itemActivated(const KFileItem& item);
425
426 /**
427 * Is emitted if items have been added or deleted.
428 */
429 void itemCountChanged();
430
431 /**
432 * Is emitted if a new tab should be opened for the URL \a url.
433 */
434 void tabRequested(const KUrl& url);
435
436 /**
437 * Is emitted if the view mode (IconsView, DetailsView,
438 * PreviewsView) has been changed.
439 */
440 void modeChanged(DolphinView::Mode current, DolphinView::Mode previous);
441
442 /** Is emitted if the 'show preview' property has been changed. */
443 void previewsShownChanged(bool shown);
444
445 /** Is emitted if the 'show hidden files' property has been changed. */
446 void hiddenFilesShownChanged(bool shown);
447
448 /** Is emitted if the 'grouped sorting' property has been changed. */
449 void groupedSortingChanged(bool groupedSorting);
450
451 /** Is emitted if the sorting by name, size or date has been changed. */
452 void sortingChanged(DolphinView::Sorting sorting);
453
454 /** Is emitted if the sort order (ascending or descending) has been changed. */
455 void sortOrderChanged(Qt::SortOrder order);
456
457 /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
458 void sortFoldersFirstChanged(bool foldersFirst);
459
460 /** Is emitted if the additional information shown for this view has been changed. */
461 void additionalInfoListChanged(const QList<DolphinView::AdditionalInfo>& current,
462 const QList<DolphinView::AdditionalInfo>& previous);
463
464 /** Is emitted if the zoom level has been changed by zooming in or out. */
465 void zoomLevelChanged(int current, int previous);
466
467 /**
468 * Is emitted if information of an item is requested to be shown e. g. in the panel.
469 * If item is null, no item information request is pending.
470 */
471 void requestItemInfo(const KFileItem& item);
472
473 /**
474 * Is emitted whenever the selection has been changed.
475 */
476 void selectionChanged(const KFileItemList& selection);
477
478 /**
479 * Is emitted if a context menu is requested for the item \a item,
480 * which is part of \a url. If the item is null, the context menu
481 * for the URL should be shown and the custom actions \a customActions
482 * will be added.
483 */
484 void requestContextMenu(const QPoint& pos,
485 const KFileItem& item,
486 const KUrl& url,
487 const QList<QAction*>& customActions);
488
489 /**
490 * Is emitted if an information message with the content \a msg
491 * should be shown.
492 */
493 void infoMessage(const QString& msg);
494
495 /**
496 * Is emitted if an error message with the content \a msg
497 * should be shown.
498 */
499 void errorMessage(const QString& msg);
500
501 /**
502 * Is emitted if an "operation completed" message with the content \a msg
503 * should be shown.
504 */
505 void operationCompletedMessage(const QString& msg);
506
507 /**
508 * Is emitted after DolphinView::setUrl() has been invoked and
509 * the path \a url is currently loaded. If this signal is emitted,
510 * it is assured that the view contains already the correct root
511 * URL and property settings.
512 */
513 void startedPathLoading(const KUrl& url);
514
515 /**
516 * Is emitted after the path triggered by DolphinView::setUrl()
517 * has been loaded.
518 */
519 void finishedPathLoading(const KUrl& url);
520
521 /**
522 * Is emitted after DolphinView::setUrl() has been invoked and provides
523 * the information how much percent of the current path have been loaded.
524 */
525 void pathLoadingProgress(int percent);
526
527 /**
528 * Is emitted if the DolphinView::setUrl() is invoked but the URL is not
529 * a directory.
530 */
531 void urlIsFileError(const KUrl& file);
532
533 /**
534 * Emitted when KDirLister emits redirection.
535 * Testcase: fish://localhost
536 */
537 void redirection(const KUrl& oldUrl, const KUrl& newUrl);
538
539 /**
540 * Is emitted when the write state of the folder has been changed. The application
541 * should disable all actions like "Create New..." that depend on the write
542 * state.
543 */
544 void writeStateChanged(bool isFolderWritable);
545
546 protected:
547 /** Changes the zoom level if Control is pressed during a wheel event. */
548 virtual void wheelEvent(QWheelEvent* event);
549
550 private slots:
551 /**
552 * Marks the view as active (DolphinView:isActive() will return true)
553 * and emits the 'activated' signal if it is not already active.
554 */
555 void activate();
556
557 void slotItemActivated(int index);
558 void slotItemsActivated(const QSet<int>& indexes);
559 void slotItemMiddleClicked(int index);
560 void slotItemContextMenuRequested(int index, const QPointF& pos);
561 void slotViewContextMenuRequested(const QPointF& pos);
562 void slotHeaderContextMenuRequested(const QPointF& pos);
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
568 /**
569 * Emits the signal \a selectionChanged() with a small delay. This is
570 * because getting all file items for the selection can be an expensive
571 * operation. Fast selection changes are collected in this case and
572 * the signal is emitted only after no selection change has been done
573 * within a small delay.
574 */
575 void slotSelectionChanged(const QSet<int>& current, const QSet<int>& previous);
576
577 /**
578 * Is called by emitDelayedSelectionChangedSignal() and emits the
579 * signal \a selectionChanged() with all selected file items as parameter.
580 */
581 void emitSelectionChangedSignal();
582
583 /**
584 * Drops dragged URLs to the destination path \a destPath. If
585 * the URLs are dropped above an item inside the destination path,
586 * the item is indicated by \a destItem.
587 */
588 void dropUrls(const KFileItem& destItem,
589 const KUrl& destPath,
590 QDropEvent* event);
591
592 /**
593 * Updates the view properties of the current URL to the
594 * sorting given by \a sorting.
595 */
596 void updateSorting(DolphinView::Sorting sorting);
597
598 /**
599 * Updates the view properties of the current URL to the
600 * sort order given by \a order.
601 */
602 void updateSortOrder(Qt::SortOrder order);
603
604 /**
605 * Updates the view properties of the current URL to the
606 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
607 */
608 void updateSortFoldersFirst(bool foldersFirst);
609
610 /**
611 * Updates the status bar to show hover information for the
612 * item \a item. If currently other items are selected,
613 * no hover information is shown.
614 * @see DolphinView::clearHoverInformation()
615 */
616 void showHoverInformation(const KFileItem& item);
617
618 /**
619 * Clears the hover information shown in the status bar.
620 * @see DolphinView::showHoverInformation().
621 */
622 void clearHoverInformation();
623
624 /**
625 * Indicates in the status bar that the delete operation
626 * of the job \a job has been finished.
627 */
628 void slotDeleteFileFinished(KJob* job);
629
630 /**
631 * Invoked when the directory lister has been started the
632 * loading of \a url.
633 */
634 void slotDirListerStarted(const KUrl& url);
635
636 /**
637 * Invoked when the file item model indicates that the directory lister has completed the loading
638 * of items, and that expanded folders have been restored (if the view mode is 'Details', and the
639 * view state is restored after navigating back or forward in history). Assures that pasted items
640 * and renamed items get seleced.
641 */
642 void slotLoadingCompleted();
643
644 /**
645 * Is invoked when the KDirLister indicates refreshed items.
646 */
647 void slotRefreshItems();
648
649 /**
650 * Observes the item with the URL \a url. As soon as the directory
651 * model indicates that the item is available, the item will
652 * get selected and it is assured that the item stays visible.
653 *
654 * @see selectAndScrollToCreatedItem()
655 */
656 void observeCreatedItem(const KUrl& url);
657
658 /**
659 * Selects and scrolls to the item that got observed
660 * by observeCreatedItem().
661 */
662 void selectAndScrollToCreatedItem();
663
664 /**
665 * Called when a redirection happens.
666 * Testcase: fish://localhost
667 */
668 void slotRedirection(const KUrl& oldUrl, const KUrl& newUrl);
669
670 /**
671 * Applies the state that has been restored by restoreViewState()
672 * to the view.
673 */
674 void updateViewState();
675
676 //void slotUrlChangeRequested(const KUrl& url);
677
678 private:
679 KFileItemModel* fileItemModel() const;
680
681 void loadDirectory(const KUrl& url, bool reload = false);
682
683 /**
684 * Applies the view properties which are defined by the current URL
685 * to the DolphinView properties.
686 */
687 void applyViewProperties();
688
689 void applyAdditionalInfoListToView();
690
691 /**
692 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
693 * Pastes the clipboard data into the URL \a url.
694 */
695 void pasteToUrl(const KUrl& url);
696
697 /**
698 * Checks whether the current item view has the same zoom level
699 * as \a oldZoomLevel. If this is not the case, the zoom level
700 * of the controller is updated and a zoomLevelChanged() signal
701 * is emitted.
702 */
703 void updateZoomLevel(int oldZoomLevel);
704
705 /**
706 * Returns a list of URLs for all selected items. The list is
707 * simplified, so that when the URLs are part of different tree
708 * levels, only the parent is returned.
709 */
710 KUrl::List simplifiedSelectedUrls() const;
711
712 /**
713 * Returns the MIME data for all selected items.
714 */
715 QMimeData* selectionMimeData() const;
716
717 /**
718 * Is invoked after a paste operation or a drag & drop
719 * operation and URLs from \a mimeData as selected.
720 * This allows to select all newly pasted
721 * items in restoreViewState().
722 */
723 void markPastedUrlsAsSelected(const QMimeData* mimeData);
724
725 /**
726 * Updates m_isFolderWritable dependent on whether the folder represented by
727 * the current URL is writable. If the state has changed, the signal
728 * writeableStateChanged() will be emitted.
729 */
730 void updateWritableState();
731
732 QByteArray sortRoleForSorting(Sorting sorting) const;
733 Sorting sortingForSortRole(const QByteArray& sortRole) const;
734
735 /**
736 * Returns the text for the filesize by converting it to the best fitting
737 * unit.
738 */
739 static QString fileSizeText(KIO::filesize_t fileSize);
740
741 private:
742 bool m_active : 1;
743 bool m_tabsForFiles : 1;
744 bool m_assureVisibleCurrentIndex : 1;
745 bool m_isFolderWritable : 1;
746
747 KUrl m_url;
748 Mode m_mode;
749 QList<AdditionalInfo> m_additionalInfoList;
750
751 QVBoxLayout* m_topLayout;
752
753 DolphinDirLister* m_dirLister;
754 DolphinItemListContainer* m_container;
755
756 ToolTipManager* m_toolTipManager;
757
758 QTimer* m_selectionChangedTimer;
759
760 KUrl m_currentItemUrl; // Used for making the view to remember the current URL after F5
761 QPoint m_restoredContentsPosition;
762 KUrl m_createdItemUrl; // URL for a new item that got created by the "Create New..." menu
763
764 QList<KUrl> m_selectedUrls; // Used for making the view to remember selections after F5
765
766 VersionControlObserver* m_versionControlObserver;
767
768 // For unit tests
769 friend class TestBase;
770 friend class DolphinDetailsViewTest;
771 };
772
773 /// Allow using DolphinView::Mode in QVariant
774 Q_DECLARE_METATYPE(DolphinView::Mode)
775
776 #endif // DOLPHINVIEW_H