]> cloud.milkyroute.net Git - dolphin.git/blob - src/dolphinview.h
After renaming an item the view should be scrolled in a way to still have a fully...
[dolphin.git] / src / dolphinview.h
1 /***************************************************************************
2 * Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at> *
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
22 #ifndef DOLPHINVIEW_H
23 #define DOLPHINVIEW_H
24
25 #include <config-nepomuk.h>
26
27 #include "libdolphin_export.h"
28
29 #include <kparts/part.h>
30 #include <kfileitem.h>
31 #include <kfileitemdelegate.h>
32 #include <kio/fileundomanager.h>
33 #include <kio/job.h>
34
35 #include <QBoxLayout>
36 #include <QKeyEvent>
37 #include <QLinkedList>
38 #include <QListView>
39 #include <QWidget>
40
41 class DolphinController;
42 class DolphinColumnView;
43 class DolphinDetailsView;
44 class DolphinFileItemDelegate;
45 class DolphinIconsView;
46 class DolphinMainWindow;
47 class DolphinModel;
48 class DolphinSortFilterProxyModel;
49 class KFilePreviewGenerator;
50 class KAction;
51 class KActionCollection;
52 class KDirLister;
53 class KUrl;
54 class KToggleAction;
55 class ToolTipManager;
56 class QModelIndex;
57 class ViewProperties;
58
59 /**
60 * @short Represents a view for the directory content.
61 *
62 * View modes for icons, details and columns are supported. It's
63 * possible to adjust:
64 * - sort order
65 * - sort type
66 * - show hidden files
67 * - show previews
68 *
69 * @see DolphinIconsView
70 * @see DolphinDetailsView
71 * @see DolphinColumnView
72 */
73 class LIBDOLPHINPRIVATE_EXPORT DolphinView : public QWidget
74 {
75 Q_OBJECT
76
77 public:
78 /**
79 * Defines the view mode for a directory. The view mode
80 * can be defined when constructing a DolphinView. The
81 * view mode is automatically updated if the directory itself
82 * defines a view mode (see class ViewProperties for details).
83 */
84 enum Mode
85 {
86 /**
87 * The directory items are shown as icons including an
88 * icon name.
89 */
90 IconsView = 0,
91
92 /**
93 * The icon, the name and at least the size of the directory
94 * items are shown in a table. It is possible to add columns
95 * for date, group and permissions.
96 */
97 DetailsView = 1,
98
99 /**
100 * Each folder is shown in a separate column.
101 */
102 ColumnView = 2,
103 MaxModeEnum = ColumnView
104 };
105
106 /** Defines the sort order for the items of a directory. */
107 enum Sorting
108 {
109 SortByName = 0,
110 SortBySize,
111 SortByDate,
112 SortByPermissions,
113 SortByOwner,
114 SortByGroup,
115 SortByType,
116 SortByRating,
117 SortByTags,
118 MaxSortEnum = SortByTags
119 };
120
121 /**
122 * @param parent Parent widget of the view.
123 * @param url Specifies the content which should be shown.
124 * @param dirLister Used directory lister. The lister is not owned
125 * by the view and won't get deleted.
126 * @param dolphinModel Used directory model. The model is not owned
127 * by the view and won't get deleted.
128 * @param proxyModel Used proxy model which specifies the sorting. The
129 * model is not owned by the view and won't get
130 * deleted.
131 */
132 DolphinView(QWidget* parent,
133 const KUrl& url,
134 KDirLister* dirLister,
135 DolphinModel* dolphinModel,
136 DolphinSortFilterProxyModel* proxyModel);
137
138 virtual ~DolphinView();
139
140 /**
141 * Returns the current active URL, where all actions are applied.
142 * The URL navigator is synchronized with this URL.
143 */
144 const KUrl& url() const;
145
146 /**
147 * Returns the root URL of the view, which is defined as the first
148 * visible path of DolphinView::url(). Usually the root URL is
149 * equal to DolphinView::url(), but in the case of the column view
150 * when 2 columns are shown, the root URL might be:
151 * /home/peter/Documents
152 * and DolphinView::url() might return
153 * /home/peter/Documents/Music/
154 */
155 KUrl rootUrl() const;
156
157 /**
158 * If \a active is true, the view will marked as active. The active
159 * view is defined as view where all actions are applied to.
160 */
161 void setActive(bool active);
162 bool isActive() const;
163
164 /**
165 * Changes the view mode for the current directory to \a mode.
166 * If the view properties should be remembered for each directory
167 * (GeneralSettings::globalViewProps() returns false), then the
168 * changed view mode will be stored automatically.
169 */
170 void setMode(Mode mode);
171 Mode mode() const;
172
173 /** See setShowPreview */
174 bool showPreview() const;
175
176 /** See setShowHiddenFiles */
177 bool showHiddenFiles() const;
178
179 /** See setCategorizedSorting */
180 bool categorizedSorting() const;
181
182 /**
183 * Returns true, if the categorized sorting is supported by the current
184 * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
185 * supports categorizations. To check whether the categorized
186 * sorting is set, use DolphinView::categorizedSorting().
187 */
188 bool supportsCategorizedSorting() const;
189
190 /**
191 * Selects all items.
192 * @see DolphinView::selectedItems()
193 */
194 void selectAll();
195
196 /**
197 * Inverts the current selection: selected items get unselected,
198 * unselected items get selected.
199 * @see DolphinView::selectedItems()
200 */
201 void invertSelection();
202
203 /** Returns true, if at least one item is selected. */
204 bool hasSelection() const;
205
206 void clearSelection();
207
208 /**
209 * Returns the selected items. The list is empty if no item has been
210 * selected.
211 * @see DolphinView::selectedUrls()
212 */
213 KFileItemList selectedItems() const;
214
215 /**
216 * Returns a list of URLs for all selected items. An empty list
217 * is returned, if no item is selected.
218 * @see DolphinView::selectedItems()
219 */
220 KUrl::List selectedUrls() const;
221
222 /**
223 * Returns the number of selected items (this is faster than
224 * invoking selectedItems().count()).
225 */
226 int selectedItemsCount() const;
227
228 /**
229 * Sets the upper left position of the view content
230 * to (x,y). The content of the view might be larger than the visible area
231 * and hence a scrolling must be done.
232 */
233 void setContentsPosition(int x, int y);
234
235 /** Returns the upper left position of the view content. */
236 QPoint contentsPosition() const;
237
238 /**
239 * Sets the zoom level to \a level. It is assured that the used
240 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
241 * ZoomLevelInfo::maximumLevel().
242 */
243 void setZoomLevel(int level);
244 int zoomLevel() const;
245
246 /**
247 * Returns true, if zooming in is possible. If false is returned,
248 * the maximum zooming level has been reached.
249 */
250 bool isZoomInPossible() const;
251
252 /**
253 * Returns true, if zooming out is possible. If false is returned,
254 * the minimum zooming level has been reached.
255 */
256 bool isZoomOutPossible() const;
257
258 /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
259 void setSorting(Sorting sorting);
260
261 /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
262 Sorting sorting() const;
263
264 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
265 void setSortOrder(Qt::SortOrder order);
266
267 /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
268 Qt::SortOrder sortOrder() const;
269
270 /** Sets the additional information which should be shown for the items. */
271 void setAdditionalInfo(KFileItemDelegate::InformationList info);
272
273 /** Returns the additional information which should be shown for the items. */
274 KFileItemDelegate::InformationList additionalInfo() const;
275
276 /** Reloads the current directory. */
277 void reload();
278
279 /**
280 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
281 * This method only needs to get invoked if the view settings for the Icons View,
282 * Details View or Columns View have been changed.
283 */
284 void refresh();
285
286 /**
287 * Changes the directory of the view to \a url. If \a rootUrl is empty, the view
288 * properties from \a url are used for adjusting the view mode and the other properties.
289 * If \a rootUrl is not empty, the view properties from the root URL are considered
290 * instead. Specifying a root URL is only required if a view having a different root URL
291 * (e. g. the column view) should be restored. Usually using DolphinView::setUrl()
292 * is enough for changing the current URL.
293 */
294 void updateView(const KUrl& url, const KUrl& rootUrl);
295
296 /**
297 * Filters the currently shown items by \a nameFilter. All items
298 * which contain the given filter string will be shown.
299 */
300 void setNameFilter(const QString& nameFilter);
301
302 /**
303 * Calculates the number of currently shown files into
304 * \a fileCount and the number of folders into \a folderCount.
305 * The size of all files is written into \a totalFileSize.
306 * It is recommend using this method instead of asking the
307 * directory lister or the model directly, as it takes
308 * filtering and hierarchical previews into account.
309 */
310 void calculateItemCount(int& fileCount, int& folderCount, KIO::filesize_t& totalFileSize) const;
311
312 /**
313 * Returns a textual representation of the state of the current
314 * folder or selected items, suitable for use in the status bar.
315 */
316 QString statusBarText() const;
317
318 /**
319 * Updates the state of the 'Additional Information' actions in \a collection.
320 */
321 void updateAdditionalInfoActions(KActionCollection* collection);
322
323 /**
324 * Returns the state of the paste action:
325 * first is whether the action should be enabled
326 * second is the text for the action
327 */
328 QPair<bool, QString> pasteInfo() const;
329
330 /**
331 * If \a tabsForFiles is true, the signal tabRequested() will also
332 * emitted also for files. Per default tabs for files is disabled
333 * and hence the signal tabRequested() will only be emitted for
334 * directories.
335 */
336 void setTabsForFilesEnabled(bool tabsForFiles);
337 bool isTabsForFilesEnabled() const;
338
339 /**
340 * Returns true if the current view allows folders to be expanded,
341 * i.e. presents a hierarchical view to the user.
342 */
343 bool itemsExpandable() 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 * Request of a selection change. The view will do its best to accommodate
354 * the request, but it is not guaranteed that all items in \a selection
355 * will actually get selected. The view will e.g. not select items which
356 * are not in the currently displayed folder.
357 */
358 void changeSelection(const KFileItemList& selection);
359
360 /**
361 * Triggers the renaming of the currently selected items, where
362 * the user must input a new name for the items.
363 */
364 void renameSelectedItems();
365
366 /**
367 * Moves all selected items to the trash.
368 */
369 void trashSelectedItems();
370
371 /**
372 * Deletes all selected items.
373 */
374 void deleteSelectedItems();
375
376 /**
377 * Copies all selected items to the clipboard and marks
378 * the items as cutted.
379 */
380 void cutSelectedItems();
381
382 /** Copies all selected items to the clipboard. */
383 void copySelectedItems();
384
385 /** Pastes the clipboard data to this view. */
386 void paste();
387
388 /**
389 * Pastes the clipboard data into the currently selected
390 * folder. If the current selection is not exactly one folder, no
391 * paste operation is done.
392 */
393 void pasteIntoFolder();
394
395 /**
396 * Turns on the file preview for the all files of the current directory,
397 * if \a show is true.
398 * If the view properties should be remembered for each directory
399 * (GeneralSettings::globalViewProps() returns false), then the
400 * preview setting will be stored automatically.
401 */
402 void setShowPreview(bool show);
403
404 /**
405 * Shows all hidden files of the current directory,
406 * if \a show is true.
407 * If the view properties should be remembered for each directory
408 * (GeneralSettings::globalViewProps() returns false), then the
409 * show hidden file setting will be stored automatically.
410 */
411 void setShowHiddenFiles(bool show);
412
413 /**
414 * Summarizes all sorted items by their category \a categorized
415 * is true.
416 * If the view properties should be remembered for each directory
417 * (GeneralSettings::globalViewProps() returns false), then the
418 * categorized sorting setting will be stored automatically.
419 */
420 void setCategorizedSorting(bool categorized);
421
422 /** Switches between an ascending and descending sorting order. */
423 void toggleSortOrder();
424
425 /**
426 * Switches on or off the displaying of additional information
427 * as specified by \a action.
428 */
429 void toggleAdditionalInfo(QAction* action);
430
431 signals:
432 /**
433 * Is emitted if the view has been activated by e. g. a mouse click.
434 */
435 void activated();
436
437 /** Is emitted if URL of the view has been changed to \a url. */
438 void urlChanged(const KUrl& url);
439
440 /**
441 * Is emitted if the view requests a changing of the current
442 * URL to \a url (see DolphinController::triggerUrlChangeRequest()).
443 */
444 void requestUrlChange(const KUrl& url);
445
446 /**
447 * Is emitted when clicking on an item with the left mouse button.
448 */
449 void itemTriggered(const KFileItem& item);
450
451 /**
452 * Is emitted if a new tab should be opened for the URL \a url.
453 */
454 void tabRequested(const KUrl& url);
455
456 /**
457 * Is emitted if the view mode (IconsView, DetailsView,
458 * PreviewsView) has been changed.
459 */
460 void modeChanged();
461
462 /** Is emitted if the 'show preview' property has been changed. */
463 void showPreviewChanged();
464
465 /** Is emitted if the 'show hidden files' property has been changed. */
466 void showHiddenFilesChanged();
467
468 /** Is emitted if the 'categorized sorting' property has been changed. */
469 void categorizedSortingChanged();
470
471 /** Is emitted if the sorting by name, size or date has been changed. */
472 void sortingChanged(DolphinView::Sorting sorting);
473
474 /** Is emitted if the sort order (ascending or descending) has been changed. */
475 void sortOrderChanged(Qt::SortOrder order);
476
477 /** Is emitted if the additional information shown for this view has been changed. */
478 void additionalInfoChanged();
479
480 /** Is emitted if the zoom level has been changed by zooming in or out. */
481 void zoomLevelChanged(int level);
482
483 /**
484 * Is emitted if information of an item is requested to be shown e. g. in the panel.
485 * If item is null, no item information request is pending.
486 */
487 void requestItemInfo(const KFileItem& item);
488
489 /** Is emitted if the contents has been moved to \a x, \a y. */
490 void contentsMoved(int x, int y);
491
492 /**
493 * Is emitted whenever the selection has been changed.
494 */
495 void selectionChanged(const KFileItemList& selection);
496
497 /**
498 * Is emitted if a context menu is requested for the item \a item,
499 * which is part of \a url. If the item is null, the context menu
500 * for the URL should be shown and the custom actions \a customActions
501 * will be added.
502 */
503 void requestContextMenu(const KFileItem& item,
504 const KUrl& url,
505 const QList<QAction*>& customActions);
506
507 /**
508 * Is emitted if an information message with the content \a msg
509 * should be shown.
510 */
511 void infoMessage(const QString& msg);
512
513 /**
514 * Is emitted if an error message with the content \a msg
515 * should be shown.
516 */
517 void errorMessage(const QString& msg);
518
519 /**
520 * Is emitted if an "operation completed" message with the content \a msg
521 * should be shown.
522 */
523 void operationCompletedMessage(const QString& msg);
524
525 /**
526 * Is emitted after DolphinView::setUrl() has been invoked and
527 * the path \a url is currently loaded. If this signal is emitted,
528 * it is assured that the view contains already the correct root
529 * URL and property settings.
530 */
531 void startedPathLoading(const KUrl& url);
532
533 /**
534 * Emitted when KDirLister emits redirection.
535 * Testcase: fish://localhost
536 */
537 void redirection(const KUrl& oldUrl, const KUrl& newUrl);
538
539 protected:
540 /** @see QWidget::mouseReleaseEvent */
541 virtual void mouseReleaseEvent(QMouseEvent* event);
542 virtual void wheelEvent(QWheelEvent* event);
543 virtual bool eventFilter(QObject* watched, QEvent* event);
544
545 private slots:
546 /**
547 * Marks the view as active (DolphinView:isActive() will return true)
548 * and emits the 'activated' signal if it is not already active.
549 */
550 void activate();
551
552 /**
553 * If the item \a item is a directory, then this
554 * directory will be loaded. If the item is a file, the corresponding
555 * application will get started.
556 */
557 void triggerItem(const KFileItem& index);
558
559 void emitSelectionChangedSignal();
560
561 /**
562 * Opens the context menu on position \a pos. The position
563 * is used to check whether the context menu is related to an
564 * item or to the viewport.
565 */
566 void openContextMenu(const QPoint& pos, const QList<QAction*>& customActions);
567
568 /**
569 * Drops dragged URLs to the destination path \a destPath. If
570 * the URLs are dropped above an item inside the destination path,
571 * the item is indicated by \a destItem.
572 */
573 void dropUrls(const KFileItem& destItem,
574 const KUrl& destPath,
575 QDropEvent* event);
576
577 /**
578 * Updates the view properties of the current URL to the
579 * sorting given by \a sorting.
580 */
581 void updateSorting(DolphinView::Sorting sorting);
582
583 /**
584 * Updates the view properties of the current URL to the
585 * sort order given by \a order.
586 */
587 void updateSortOrder(Qt::SortOrder order);
588
589 /**
590 * Updates the view properties of the current URL to the
591 * additional information given by \a info.
592 */
593 void updateAdditionalInfo(const KFileItemDelegate::InformationList& info);
594
595 /**
596 * Emits the signal contentsMoved with the current coordinates
597 * of the viewport as parameters.
598 */
599 void emitContentsMoved();
600
601 /**
602 * Updates the status bar to show hover information for the
603 * item \a item. If currently other items are selected,
604 * no hover information is shown.
605 * @see DolphinView::clearHoverInformation()
606 */
607 void showHoverInformation(const KFileItem& item);
608
609 /**
610 * Clears the hover information shown in the status bar.
611 * @see DolphinView::showHoverInformation().
612 */
613 void clearHoverInformation();
614
615 /**
616 * Indicates in the status bar that the delete operation
617 * of the job \a job has been finished.
618 */
619 void slotDeleteFileFinished(KJob* job);
620
621 /**
622 * Is emitted if the controller requests a changing of the current
623 * URL to \a url
624 */
625 void slotRequestUrlChange(const KUrl& url);
626
627 /**
628 * Restores the current item (= item that has the keyboard focus)
629 * to m_currentItemUrl.
630 */
631 void restoreCurrentItem();
632
633 /**
634 * Is invoked when the KDirLister indicates refreshed items.
635 */
636 void slotRefreshItems();
637
638 /**
639 * If \a view can be positively identified as not being the source for the
640 * current drag operation, deleteLater() it immediately. Else stores
641 * it for later deletion.
642 */
643 void deleteWhenNotDragSource(QAbstractItemView* view);
644
645 private:
646 void loadDirectory(const KUrl& url, bool reload = false);
647
648 /**
649 * Returns the URL where the view properties should be stored. Usually
650 * DolphinView::url() is returned, but in the case of a Column View the
651 * view properties are always stored in the directory represented by the
652 * first column. It is recommendend whenever using the ViewProperties class
653 * to use DolphinView::viewPropertiesUrl() as URL.
654 */
655 KUrl viewPropertiesUrl() const;
656
657 /**
658 * Applies the view properties which are defined by the current URL
659 * m_url to the DolphinView properties.
660 */
661 void applyViewProperties(const KUrl& url);
662
663 /**
664 * Creates a new view representing the given view mode (DolphinView::mode()).
665 * The current view will get deleted.
666 */
667 void createView();
668
669 void deleteView();
670
671 /**
672 * Returns a pointer to the currently used item view, which is either
673 * a ListView or a TreeView.
674 */
675 QAbstractItemView* itemView() const;
676
677 /**
678 * Returns true, if the item \a item has been cut into
679 * the clipboard.
680 */
681 bool isCutItem(const KFileItem& item) const;
682
683 /**
684 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
685 * Pastes the clipboard data into the URL \a url.
686 */
687 void pasteToUrl(const KUrl& url);
688
689 /**
690 * Checks whether the current item view has the same zoom level
691 * as \a oldZoomLevel. If this is not the case, the zoom level
692 * of the controller is updated and a zoomLevelChanged() signal
693 * is emitted.
694 */
695 void updateZoomLevel(int oldZoomLevel);
696
697 /**
698 * Returns a list of URLs for all selected items. The list is
699 * simplified, so that when the URLs are part of different tree
700 * levels, only the parent is returned.
701 */
702 KUrl::List simplifiedSelectedUrls() const;
703
704 /**
705 * Returns true, if the ColumnView is activated. As the column view
706 * requires some special handling for iterating through directories,
707 * this method has been introduced for convenience.
708 */
709 bool isColumnViewActive() const;
710
711 /**
712 * Returns the MIME data for all selected items.
713 */
714 QMimeData* selectionMimeData() const;
715
716 private:
717 bool m_active : 1;
718 bool m_showPreview : 1;
719 bool m_loadingDirectory : 1;
720 bool m_storedCategorizedSorting : 1;
721 bool m_tabsForFiles : 1;
722 bool m_isContextMenuOpen : 1; // TODO: workaround for Qt-issue 207192
723 bool m_ignoreViewProperties : 1;
724 bool m_assureVisibleCurrentIndex : 1;
725
726 Mode m_mode;
727
728 DolphinMainWindow* m_mainWindow;
729 QVBoxLayout* m_topLayout;
730
731 DolphinController* m_controller;
732 DolphinIconsView* m_iconsView;
733 DolphinDetailsView* m_detailsView;
734 DolphinColumnView* m_columnView;
735 DolphinFileItemDelegate* m_fileItemDelegate;
736 QItemSelectionModel* m_selectionModel;
737
738 DolphinModel* m_dolphinModel;
739 KDirLister* m_dirLister;
740 DolphinSortFilterProxyModel* m_proxyModel;
741
742 KFilePreviewGenerator* m_previewGenerator;
743 ToolTipManager* m_toolTipManager;
744
745 KUrl m_rootUrl;
746 KUrl m_currentItemUrl;
747
748 QAbstractItemView* m_expandedDragSource;
749 };
750
751 inline bool DolphinView::isColumnViewActive() const
752 {
753 return m_columnView != 0;
754 }
755
756 /// Allow using DolphinView::Mode in QVariant
757 Q_DECLARE_METATYPE(DolphinView::Mode)
758
759 #endif // DOLPHINVIEW_H