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     QList<KFileItem> 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::AdditionalInformation info);
 283
 284     /** Returns the additional information which should be shown for the items. */
 285     KFileItemDelegate::AdditionalInformation 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 public slots:
 308     /**
 309      * Changes the directory to \a url. If the current directory is equal to
 310      * \a url, nothing will be done (use DolphinView::reload() instead).
 311      */
 312     void setUrl(const KUrl& url);
 313
 314     /**
 315      * Request of a selection change. The view will do its best to accommodate
 316      * the request, but it is not guaranteed that all items in \a selection
 317      * will actually get selected. The view will e.g. not select items which
 318      * are not in the currently displayed folder.
 319      */
 320     void changeSelection(const QList<KFileItem>& selection);
 321
 322 signals:
 323     /**
 324      * Is emitted if the view has been activated by e. g. a mouse click.
 325      */
 326     void activated();
 327
 328     /** Is emitted if URL of the view has been changed to \a url. */
 329     void urlChanged(const KUrl& url);
 330
 331     /**
 332      * Is emitted when clicking on an item
 333      */
 334     void itemTriggered(const KFileItem& item);
 335
 336     /**
 337      * Is emitted if the view mode (IconsView, DetailsView,
 338      * PreviewsView) has been changed.
 339      */
 340     void modeChanged();
 341
 342     /** Is emitted if the 'show preview' property has been changed. */
 343     void showPreviewChanged();
 344
 345     /** Is emitted if the 'show hidden files' property has been changed. */
 346     void showHiddenFilesChanged();
 347
 348     /** Is emitted if the 'categorized sorting' property has been changed. */
 349     void categorizedSortingChanged();
 350
 351     /** Is emitted if the sorting by name, size or date has been changed. */
 352     void sortingChanged(DolphinView::Sorting sorting);
 353
 354     /** Is emitted if the sort order (ascending or descending) has been changed. */
 355     void sortOrderChanged(Qt::SortOrder order);
 356
 357     /** Is emitted if the additional information for an item has been changed. */
 358     void additionalInfoChanged(KFileItemDelegate::AdditionalInformation info);
 359
 360     /**
 361      * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
 362      * If item is null, no item information request is pending.
 363      */
 364     void requestItemInfo(const KFileItem& item);
 365
 366     /** Is emitted if the contents has been moved to \a x, \a y. */
 367     void contentsMoved(int x, int y);
 368
 369     /**
 370      * Is emitted whenever the selection has been changed.
 371      */
 372     void selectionChanged(const QList<KFileItem>& selection);
 373
 374     /**
 375      * Is emitted if a context menu is requested for the item \a item,
 376      * which is part of \a url. If the item is 0, the context menu
 377      * for the URL should be shown.
 378      */
 379     void requestContextMenu(const KFileItem& item, const KUrl& url);
 380
 381     /**
 382      * Is emitted if the URLs \a are dropped to the destination URL
 383      * \a destination. No operation is done within the DolphinView, the
 384      * receiver of the signal has to take care about the corresponding
 385      * operation.
 386      */
 387     void urlsDropped(const KUrl::List& urls, const KUrl& destination);
 388
 389     /**
 390      * Is emitted if an information message with the content \a msg
 391      * should be shown.
 392      */
 393     void infoMessage(const QString& msg);
 394
 395     /**
 396      * Is emitted if an error message with the content \a msg
 397      * should be shown.
 398      */
 399     void errorMessage(const QString& msg);
 400
 401     /**
 402      * Is emitted after DolphinView::setUrl() has been invoked and
 403      * the path \a url is currently loaded. If this signal is emitted,
 404      * it is assured that the view contains already the correct root
 405      * URL and property settings.
 406      */
 407     void startedPathLoading(const KUrl& url);
 408
 409 protected:
 410     /** @see QWidget::mouseReleaseEvent */
 411     virtual void mouseReleaseEvent(QMouseEvent* event);
 412
 413 private slots:
 414     /**
 415      * Marks the view as active (DolphinView:isActive() will return true)
 416      * and emits the 'activated' signal if it is not already active.
 417      */
 418     void activate();
 419
 420     /**
 421      * If the item specified by \a index is a directory, then this
 422      * directory will be loaded. If the  item is a file, the corresponding
 423      * application will get started.
 424      */
 425     void triggerItem(const QModelIndex& index);
 426
 427     /**
 428      * Generates a preview image for each file item in \a items.
 429      * The current preview settings (maximum size, 'Show Preview' menu)
 430      * are respected.
 431      */
 432     void generatePreviews(const QList<KFileItem>& items);
 433
 434     /**
 435      * Replaces the icon of the item \a item by the preview pixmap
 436      * \a pixmap.
 437      */
 438     void showPreview(const KFileItem& item, const QPixmap& pixmap);
 439
 440     void emitSelectionChangedSignal();
 441
 442     /**
 443      * Opens the context menu on position \a pos. The position
 444      * is used to check whether the context menu is related to an
 445      * item or to the viewport.
 446      */
 447     void openContextMenu(const QPoint& pos);
 448
 449     /**
 450      * Drops the URLs \a urls to the destination path \a destPath. If
 451      * the URLs are dropped above an item inside the destination path,
 452      * the item is indicated by \a destIndex. \a source
 453      * indicates the widget where the dragging has been started from.
 454      */
 455     void dropUrls(const KUrl::List& urls,
 456                   const KUrl& destPath,
 457                   const QModelIndex& destIndex,
 458                   QWidget* source);
 459
 460     /**
 461      * Drops the URLs \a urls at the
 462      * destination \a destination.
 463      */
 464     void dropUrls(const KUrl::List& urls,
 465                   const KUrl& destination);
 466     /**
 467      * Updates the view properties of the current URL to the
 468      * sorting given by \a sorting.
 469      */
 470     void updateSorting(DolphinView::Sorting sorting);
 471
 472     /**
 473      * Updates the view properties of the current URL to the
 474      * sort order given by \a order.
 475      */
 476     void updateSortOrder(Qt::SortOrder order);
 477
 478     /**
 479      * Emits the signal contentsMoved with the current coordinates
 480      * of the viewport as parameters.
 481      */
 482     void emitContentsMoved();
 483
 484     /** Applies an item effect to all cut items of the clipboard. */
 485     void updateCutItems();
 486
 487     /**
 488      * Updates the status bar to show hover information for the
 489      * item with the index \a index. If currently other items are selected,
 490      * no hover information is shown.
 491      * @see DolphinView::clearHoverInformation()
 492      */
 493     void showHoverInformation(const QModelIndex& index);
 494
 495     /**
 496      * Clears the hover information shown in the status bar.
 497      * @see DolphinView::showHoverInformation().
 498      */
 499     void clearHoverInformation();
 500
 501 private:
 502     void startDirLister(const KUrl& url, bool reload = false);
 503
 504     /**
 505      * Returns the URL where the view properties should be stored. Usually
 506      * DolphinView::url() is returned, but in the case of a Column View the
 507      * view properties are always stored in the directory represented by the
 508      * first column. It is recommendend whenever using the ViewProperties class
 509      * to use DolphinView::viewPropertiesUrl() as URL.
 510      */
 511     KUrl viewPropertiesUrl() const;
 512
 513     /**
 514      * Applies the view properties which are defined by the current URL
 515      * m_url to the DolphinView properties.
 516      */
 517     void applyViewProperties(const KUrl& url);
 518
 519     /**
 520      * Creates a new view representing the given view mode (DolphinView::mode()).
 521      * The current view will get deleted.
 522      */
 523     void createView();
 524
 525     /**
 526      * Returns a pointer to the currently used item view, which is either
 527      * a ListView or a TreeView.
 528      */
 529     QAbstractItemView* itemView() const;
 530
 531     /**
 532      * Returns true if the index is valid and represents
 533      * the column DolphinModel::Name.
 534      */
 535     bool isValidNameIndex(const QModelIndex& index) const;
 536
 537     /**
 538      * Returns true, if the item \a item has been cut into
 539      * the clipboard.
 540      */
 541     bool isCutItem(const KFileItem& item) const;
 542
 543     /** Applies an item effect to all cut items. */
 544     void applyCutItemEffect();
 545
 546     /**
 547      * Updates the color of the viewport depending from the
 548      * activation state (see DolphinView::isActive()).
 549      */
 550     void updateViewportColor();
 551
 552     /**
 553      * Returns true, if the ColumnView is activated. As the column view
 554      * requires some special handling for iterating through directories,
 555      * this method has been introduced for convenience.
 556      */
 557     bool isColumnViewActive() const
 558     {
 559         return m_columnView != 0;
 560     }
 561
 562 private:
 563     /**
 564      * Remembers the original pixmap for an item before
 565      * the cut effect is applied.
 566      */
 567     struct CutItem
 568     {
 569         KUrl url;
 570         QPixmap pixmap;
 571     };
 572
 573     bool m_active;
 574     bool m_loadingDirectory;
 575     bool m_initializeColumnView;
 576     bool m_storedCategorizedSorting;
 577     Mode m_mode;
 578
 579     DolphinMainWindow* m_mainWindow;
 580     QVBoxLayout* m_topLayout;
 581
 582     DolphinController* m_controller;
 583     DolphinIconsView* m_iconsView;
 584     DolphinDetailsView* m_detailsView;
 585     DolphinColumnView* m_columnView;
 586     KFileItemDelegate* m_fileItemDelegate;
 587
 588     DolphinModel* m_dolphinModel;
 589     KDirLister* m_dirLister;
 590     DolphinSortFilterProxyModel* m_proxyModel;
 591
 592     QList<CutItem> m_cutItemsCache;
 593
 594     KUrl m_rootUrl;
 595 };
 596
 597 #endif // DOLPHINVIEW_H