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/job.h>
  33
  34 #include <QBoxLayout>
  35 #include <QKeyEvent>
  36 #include <QLinkedList>
  37 #include <QListView>
  38 #include <QWidget>
  39
  40 class DolphinController;
  41 class KDirLister;
  42 class KFileItemDelegate;
  43 class KUrl;
  44 class DolphinModel;
  45 class DolphinColumnView;
  46 class DolphinDetailsView;
  47 class DolphinIconsView;
  48 class DolphinMainWindow;
  49 class DolphinSortFilterProxyModel;
  50 class QModelIndex;
  51 class ViewProperties;
  52
  53 /**
  54  * @short Represents a view for the directory content.
  55  *
  56  * View modes for icons, details and columns are supported. It's
  57  * possible to adjust:
  58  * - sort order
  59  * - sort type
  60  * - show hidden files
  61  * - show previews
  62  *
  63  * @see DolphinIconsView
  64  * @see DolphinDetailsView
  65  * @see DolphinColumnView
  66  */
  67 class LIBDOLPHINPRIVATE_EXPORT DolphinView : public QWidget
  68 {
  69     Q_OBJECT
  70
  71 public:
  72     /**
  73         * Defines the view mode for a directory. The view mode
  74         * can be defined when constructing a DolphinView. The
  75         * view mode is automatically updated if the directory itself
  76         * defines a view mode (see class ViewProperties for details).
  77         */
  78     enum Mode
  79     {
  80         /**
  81          * The directory items are shown as icons including an
  82          * icon name. */
  83         IconsView = 0,
  84
  85         /**
  86          * The icon, the name and at least the size of the directory
  87          * items are shown in a table. It is possible to add columns
  88          * for date, group and permissions.
  89          */
  90         DetailsView = 1,
  91
  92         /**
  93          * Each folder is shown in a separate column.
  94          */
  95         ColumnView = 2,
  96         MaxModeEnum = ColumnView
  97     };
  98
  99     /** Defines the sort order for the items of a directory. */
 100     enum Sorting
 101     {
 102         SortByName = 0,
 103         SortBySize,
 104         SortByDate,
 105         SortByPermissions,
 106         SortByOwner,
 107         SortByGroup,
 108         SortByType,
 109         SortByRating,
 110         SortByTags,
 111         MaxSortEnum = SortByTags
 112     };
 113
 114     /**
 115      * @param parent          Parent widget of the view.
 116      * @param url             Specifies the content which should be shown.
 117      * @param dirLister       Used directory lister. The lister is not owned
 118      *                        by the view and won't get deleted.
 119      * @param dolphinModel    Used directory model. The model is not owned
 120      *                        by the view and won't get deleted.
 121      * @param proxyModel      Used proxy model which specifies the sorting. The
 122      *                        model is not owned by the view and won't get
 123      *                        deleted.
 124      */
 125     DolphinView(QWidget* parent,
 126                 const KUrl& url,
 127                 KDirLister* dirLister,
 128                 DolphinModel* dolphinModel,
 129                 DolphinSortFilterProxyModel* proxyModel);
 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     const KUrl& url() const;
 138
 139     /**
 140      * Returns the root URL of the view, which is defined as the first
 141      * visible path of DolphinView::url(). Usually the root URL is
 142      * equal to DolphinView::url(), but in the case of the column view
 143      * when 2 columns are shown, the root URL might be:
 144      * /home/peter/Documents
 145      * and DolphinView::url() might return
 146      * /home/peter/Documents/Music/
 147      */
 148     KUrl rootUrl() const;
 149
 150     /**
 151      * If \a active is true, the view will marked as active. The active
 152      * view is defined as view where all actions are applied to.
 153      */
 154     void setActive(bool active);
 155     bool isActive() const;
 156
 157     /**
 158      * Changes the view mode for the current directory to \a mode.
 159      * If the view properties should be remembered for each directory
 160      * (GeneralSettings::globalViewProps() returns false), then the
 161      * changed view mode will be be stored automatically.
 162      */
 163     void setMode(Mode mode);
 164     Mode mode() const;
 165
 166     /**
 167      * Turns on the file preview for the all files of the current directory,
 168      * if \a show is true.
 169      * If the view properties should be remembered for each directory
 170      * (GeneralSettings::globalViewProps() returns false), then the
 171      * preview setting will be be stored automatically.
 172      */
 173     void setShowPreview(bool show);
 174     bool showPreview() const;
 175
 176     /**
 177      * Shows all hidden files of the current directory,
 178      * if \a show is true.
 179      * If the view properties should be remembered for each directory
 180      * (GeneralSettings::globalViewProps() returns false), then the
 181      * show hidden file setting will be be stored automatically.
 182      */
 183     void setShowHiddenFiles(bool show);
 184     bool showHiddenFiles() const;
 185
 186     /**
 187      * Summarizes all sorted items by their category \a categorized
 188      * is true.
 189      * If the view properties should be remembered for each directory
 190      * (GeneralSettings::globalViewProps() returns false), then the
 191      * categorized sorting setting will be be stored automatically.
 192      */
 193     void setCategorizedSorting(bool categorized);
 194     bool categorizedSorting() const;
 195
 196     /**
 197      * Returns true, if the categorized sorting is supported by the current
 198      * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
 199      * supports categorizations. To check whether the categorized
 200      * sorting is set, use DolphinView::categorizedSorting().
 201      */
 202     bool supportsCategorizedSorting() const;
 203
 204     /**
 205      * Selects all items.
 206      * @see DolphinView::selectedItems()
 207      */
 208     void selectAll();
 209
 210     /**
 211      * Inverts the current selection: selected items get unselected,
 212      * unselected items get selected.
 213      * @see DolphinView::selectedItems()
 214      */
 215     void invertSelection();
 216
 217     /** Returns true, if at least one item is selected. */
 218     bool hasSelection() const;
 219
 220     void clearSelection();
 221
 222     /**
 223      * Returns the selected items. The list is empty if no item has been
 224      * selected.
 225      * @see DolphinView::selectedUrls()
 226      */
 227     KFileItemList selectedItems() const;
 228
 229     /**
 230      * Returns a list of URLs for all selected items. An empty list
 231      * is returned, if no item is selected.
 232      * @see DolphinView::selectedItems()
 233      */
 234     KUrl::List selectedUrls() const;
 235
 236     /**
 237      * Returns the file item for the given model index \a index.
 238      */
 239     KFileItem fileItem(const QModelIndex& index) const;
 240
 241     /**
 242      * Sets the upper left position of the view content
 243      * to (x,y). The content of the view might be larger than the visible area
 244      * and hence a scrolling must be done.
 245      */
 246     void setContentsPosition(int x, int y);
 247
 248     /** Returns the upper left position of the view content. */
 249     QPoint contentsPosition() const;
 250
 251     /** Increases the size of the current set view mode. */
 252     void zoomIn();
 253
 254     /** Decreases the size of the current set view mode. */
 255     void zoomOut();
 256
 257     /**
 258      * Returns true, if zooming in is possible. If false is returned,
 259      * the minimal zoom size is possible.
 260      */
 261     bool isZoomInPossible() const;
 262
 263     /**
 264      * Returns true, if zooming out is possible. If false is returned,
 265      * the maximum zoom size is possible.
 266      */
 267     bool isZoomOutPossible() const;
 268
 269     /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
 270     void setSorting(Sorting sorting);
 271
 272     /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
 273     Sorting sorting() const;
 274
 275     /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
 276     void setSortOrder(Qt::SortOrder order);
 277
 278     /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
 279     Qt::SortOrder sortOrder() const;
 280
 281     /** Sets the additional information which should be shown for the items. */
 282     void setAdditionalInfo(KFileItemDelegate::InformationList info);
 283
 284     /** Returns the additional information which should be shown for the items. */
 285     KFileItemDelegate::InformationList additionalInfo() const;
 286
 287     /** Reloads the current directory. */
 288     void reload();
 289
 290     /**
 291      * Refreshes the view to get synchronized with the (updated) Dolphin settings.
 292      * This method only needs to get invoked if the view settings for the Icons View,
 293      * Details View or Columns View have been changed.
 294      */
 295     void refresh();
 296
 297     /**
 298      * Changes the directory of the view to \a url. If \a rootUrl is empty, the view
 299      * properties from \a url are used for adjusting the view mode and the other properties.
 300      * If \a rootUrl is not empty, the view properties from the root URL are considered
 301      * instead. Specifying a root URL is only required if a view having a different root URL
 302      * (e. g. the column view) should be restored. Usually using DolphinView::setUrl()
 303      * is enough for changing the current URL.
 304      */
 305     void updateView(const KUrl& url, const KUrl& rootUrl);
 306
 307     /**
 308      * Filters the currently shown items by \a nameFilter. All items
 309      * which contain the given filter string will be shown.
 310      */
 311     void setNameFilter(const QString& nameFilter);
 312
 313     /**
 314      * Calculates the number of currently shown files into
 315      * \a fileCount and the number of folders into \a folderCount.
 316      * It is recommend using this method instead of asking the
 317      * directory lister or the model directly, as it takes
 318      * filtering and hierarchical previews into account.
 319      */
 320     void calculateItemCount(int& fileCount, int& folderCount);
 321
 322 public slots:
 323     /**
 324      * Changes the directory to \a url. If the current directory is equal to
 325      * \a url, nothing will be done (use DolphinView::reload() instead).
 326      */
 327     void setUrl(const KUrl& url);
 328
 329     /**
 330      * Request of a selection change. The view will do its best to accommodate
 331      * the request, but it is not guaranteed that all items in \a selection
 332      * will actually get selected. The view will e.g. not select items which
 333      * are not in the currently displayed folder.
 334      */
 335     void changeSelection(const KFileItemList& selection);
 336
 337
 338 signals:
 339     /**
 340      * Is emitted if the view has been activated by e. g. a mouse click.
 341      */
 342     void activated();
 343
 344     /** Is emitted if URL of the view has been changed to \a url. */
 345     void urlChanged(const KUrl& url);
 346
 347     /**
 348      * Is emitted when clicking on an item
 349      */
 350     void itemTriggered(const KFileItem& item);
 351
 352     /**
 353      * Is emitted if the view mode (IconsView, DetailsView,
 354      * PreviewsView) has been changed.
 355      */
 356     void modeChanged();
 357
 358     /** Is emitted if the 'show preview' property has been changed. */
 359     void showPreviewChanged();
 360
 361     /** Is emitted if the 'show hidden files' property has been changed. */
 362     void showHiddenFilesChanged();
 363
 364     /** Is emitted if the 'categorized sorting' property has been changed. */
 365     void categorizedSortingChanged();
 366
 367     /** Is emitted if the sorting by name, size or date has been changed. */
 368     void sortingChanged(DolphinView::Sorting sorting);
 369
 370     /** Is emitted if the sort order (ascending or descending) has been changed. */
 371     void sortOrderChanged(Qt::SortOrder order);
 372
 373     /** Is emitted if the additional information for an item has been changed. */
 374     void additionalInfoChanged(KFileItemDelegate::InformationList info);
 375
 376     /**
 377      * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
 378      * If item is null, no item information request is pending.
 379      */
 380     void requestItemInfo(const KFileItem& item);
 381
 382     /** Is emitted if the contents has been moved to \a x, \a y. */
 383     void contentsMoved(int x, int y);
 384
 385     /**
 386      * Is emitted whenever the selection has been changed.
 387      */
 388     void selectionChanged(const KFileItemList& selection);
 389
 390     /**
 391      * Is emitted if a context menu is requested for the item \a item,
 392      * which is part of \a url. If the item is 0, the context menu
 393      * for the URL should be shown.
 394      */
 395     void requestContextMenu(const KFileItem& item, const KUrl& url);
 396
 397     /**
 398      * Is emitted if the URLs \a are dropped to the destination URL
 399      * \a destination. No operation is done within the DolphinView, the
 400      * receiver of the signal has to take care about the corresponding
 401      * operation.
 402      */
 403     void urlsDropped(const KUrl::List& urls, const KUrl& destination);
 404
 405     /**
 406      * Is emitted if an information message with the content \a msg
 407      * should be shown.
 408      */
 409     void infoMessage(const QString& msg);
 410
 411     /**
 412      * Is emitted if an error message with the content \a msg
 413      * should be shown.
 414      */
 415     void errorMessage(const QString& msg);
 416
 417     /**
 418      * Is emitted after DolphinView::setUrl() has been invoked and
 419      * the path \a url is currently loaded. If this signal is emitted,
 420      * it is assured that the view contains already the correct root
 421      * URL and property settings.
 422      */
 423     void startedPathLoading(const KUrl& url);
 424
 425 protected:
 426     /** @see QWidget::mouseReleaseEvent */
 427     virtual void mouseReleaseEvent(QMouseEvent* event);
 428
 429 private slots:
 430     /**
 431      * Marks the view as active (DolphinView:isActive() will return true)
 432      * and emits the 'activated' signal if it is not already active.
 433      */
 434     void activate();
 435
 436     /**
 437      * If the item \a item is a directory, then this
 438      * directory will be loaded. If the  item is a file, the corresponding
 439      * application will get started.
 440      */
 441     void triggerItem(const KFileItem& index);
 442
 443     /**
 444      * Generates a preview image for each file item in \a items.
 445      * The current preview settings (maximum size, 'Show Preview' menu)
 446      * are respected.
 447      */
 448     void generatePreviews(const KFileItemList& items);
 449
 450     /**
 451      * Replaces the icon of the item \a item by the preview pixmap
 452      * \a pixmap.
 453      */
 454     void showPreview(const KFileItem& item, const QPixmap& pixmap);
 455
 456     void emitSelectionChangedSignal();
 457
 458     /**
 459      * Opens the context menu on position \a pos. The position
 460      * is used to check whether the context menu is related to an
 461      * item or to the viewport.
 462      */
 463     void openContextMenu(const QPoint& pos);
 464
 465     /**
 466      * Drops the URLs \a urls to the destination path \a destPath. If
 467      * the URLs are dropped above an item inside the destination path,
 468      * the item is indicated by \a destIndex. \a source
 469      * indicates the widget where the dragging has been started from.
 470      */
 471     void dropUrls(const KUrl::List& urls,
 472                   const KUrl& destPath,
 473                   const QModelIndex& destIndex,
 474                   QWidget* source);
 475
 476     /**
 477      * Drops the URLs \a urls at the
 478      * destination \a destination.
 479      */
 480     void dropUrls(const KUrl::List& urls,
 481                   const KUrl& destination);
 482     /**
 483      * Updates the view properties of the current URL to the
 484      * sorting given by \a sorting.
 485      */
 486     void updateSorting(DolphinView::Sorting sorting);
 487
 488     /**
 489      * Updates the view properties of the current URL to the
 490      * sort order given by \a order.
 491      */
 492     void updateSortOrder(Qt::SortOrder order);
 493
 494     /**
 495      * Emits the signal contentsMoved with the current coordinates
 496      * of the viewport as parameters.
 497      */
 498     void emitContentsMoved();
 499
 500     /** Applies an item effect to all cut items of the clipboard. */
 501     void updateCutItems();
 502
 503     /**
 504      * Updates the status bar to show hover information for the
 505      * item \a item. If currently other items are selected,
 506      * no hover information is shown.
 507      * @see DolphinView::clearHoverInformation()
 508      */
 509     void showHoverInformation(const KFileItem& item);
 510
 511     /**
 512      * Clears the hover information shown in the status bar.
 513      * @see DolphinView::showHoverInformation().
 514      */
 515     void clearHoverInformation();
 516
 517 private:
 518     void loadDirectory(const KUrl& url, bool reload = false);
 519
 520     /**
 521      * Returns the URL where the view properties should be stored. Usually
 522      * DolphinView::url() is returned, but in the case of a Column View the
 523      * view properties are always stored in the directory represented by the
 524      * first column. It is recommendend whenever using the ViewProperties class
 525      * to use DolphinView::viewPropertiesUrl() as URL.
 526      */
 527     KUrl viewPropertiesUrl() const;
 528
 529     /**
 530      * Applies the view properties which are defined by the current URL
 531      * m_url to the DolphinView properties.
 532      */
 533     void applyViewProperties(const KUrl& url);
 534
 535     /**
 536      * Creates a new view representing the given view mode (DolphinView::mode()).
 537      * The current view will get deleted.
 538      */
 539     void createView();
 540
 541     /**
 542      * Returns a pointer to the currently used item view, which is either
 543      * a ListView or a TreeView.
 544      */
 545     QAbstractItemView* itemView() const;
 546
 547     /**
 548      * Returns true if the index is valid and represents
 549      * the column DolphinModel::Name.
 550      */
 551     bool isValidNameIndex(const QModelIndex& index) const;
 552
 553     /**
 554      * Returns true, if the item \a item has been cut into
 555      * the clipboard.
 556      */
 557     bool isCutItem(const KFileItem& item) const;
 558
 559     /** Applies an item effect to all cut items. */
 560     void applyCutItemEffect();
 561
 562     /**
 563      * Returns true, if the ColumnView is activated. As the column view
 564      * requires some special handling for iterating through directories,
 565      * this method has been introduced for convenience.
 566      */
 567     bool isColumnViewActive() const
 568     {
 569         return m_columnView != 0;
 570     }
 571
 572 private:
 573     /**
 574      * Remembers the original pixmap for an item before
 575      * the cut effect is applied.
 576      */
 577     struct CutItem
 578     {
 579         KUrl url;
 580         QPixmap pixmap;
 581     };
 582
 583     bool m_active;
 584     bool m_loadingDirectory;
 585     bool m_storedCategorizedSorting;
 586     Mode m_mode;
 587
 588     DolphinMainWindow* m_mainWindow;
 589     QVBoxLayout* m_topLayout;
 590
 591     DolphinController* m_controller;
 592     DolphinIconsView* m_iconsView;
 593     DolphinDetailsView* m_detailsView;
 594     DolphinColumnView* m_columnView;
 595     KFileItemDelegate* m_fileItemDelegate;
 596
 597     DolphinModel* m_dolphinModel;
 598     KDirLister* m_dirLister;
 599     DolphinSortFilterProxyModel* m_proxyModel;
 600
 601     QList<CutItem> m_cutItemsCache;
 602
 603     KUrl m_rootUrl;
 604 };
 605
 606 #endif // DOLPHINVIEW_H