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 <kparts/part.h>
  26 #include <kfileitem.h>
  27 #include <kfileitemdelegate.h>
  28 #include <kfileiconview.h>
  29 #include <kio/job.h>
  30
  31 #include <urlnavigator.h>
  32
  33 #include <QDropEvent>
  34 #include <QLinkedList>
  35 #include <QListView>
  36 #include <QMouseEvent>
  37 #include <QVBoxLayout>
  38 #include <QWidget>
  39
  40 class DolphinController;
  41 class FilterBar;
  42 class KFileItemDelegate;
  43 class KUrl;
  44 class KDirModel;
  45 class UrlNavigator;
  46 class DolphinDetailsView;
  47 class DolphinDirLister;
  48 class DolphinIconsView;
  49 class DolphinMainWindow;
  50 class DolphinSortFilterProxyModel;
  51 class DolphinStatusBar;
  52 class QModelIndex;
  53 class QPainter;
  54 class QTimer;
  55 class ViewProperties;
  56
  57 /**
  58  * @short Represents a view for the directory content
  59  *        including the navigation bar, filter bar and status bar.
  60  *
  61  * View modes for icons and details are supported. Currently
  62  * Dolphin allows to have up to two views inside the main window.
  63  *
  64  * @see DolphinIconsView
  65  * @see DolphinDetailsView
  66  * @see UrlNavigator
  67  * @see DolphinStatusBar
  68  */
  69 class DolphinView : public QWidget
  70 {
  71     Q_OBJECT
  72
  73 public:
  74         /**
  75      * Defines the view mode for a directory. The view mode
  76      * can be defined when constructing a DolphinView. The
  77      * view mode is automatically updated if the directory itself
  78      * defines a view mode (see class ViewProperties for details).
  79      */
  80     enum Mode
  81     {
  82         /**
  83          * The directory items are shown as icons including an
  84          * icon name. */
  85         IconsView = 0,
  86
  87         /**
  88          * The icon, the name and at least the size of the directory
  89          * items are shown in a table. It is possible to add columns
  90          * for date, group and permissions.
  91          */
  92         DetailsView = 1,
  93         MaxModeEnum = DetailsView
  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         MaxSortEnum = SortByGroup
 106     };
 107
 108     DolphinView(DolphinMainWindow* mainwindow,
 109                 QWidget *parent,
 110                 const KUrl& url,
 111                 Mode mode = IconsView,
 112                 bool showHiddenFiles = false);
 113
 114     virtual ~DolphinView();
 115
 116     /**
 117      * Sets the current active URL.
 118      * The signals UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
 119      * are emitted.
 120      */
 121     void setUrl(const KUrl& url);
 122
 123     /** Returns the current active URL. */
 124     const KUrl& url() const;
 125
 126     /**
 127      * Returns true if the view is active and hence all actions are
 128      * applied to this view.
 129      */
 130     bool isActive() const;
 131
 132     /**
 133      * Changes the view mode for the current directory to \a mode.
 134      * If the view properties should be remembered for each directory
 135      * (GeneralSettings::globalViewProps() returns false), then the
 136      * changed view mode will be be stored automatically.
 137      */
 138     void setMode(Mode mode);
 139     Mode mode() const;
 140
 141     /**
 142      * Turns on the file preview for the all files of the current directory,
 143      * if \a show is true.
 144      * If the view properties should be remembered for each directory
 145      * (GeneralSettings::globalViewProps() returns false), then the
 146      * preview setting will be be stored automatically.
 147      */
 148     void setShowPreview(bool show);
 149     bool showPreview() const;
 150
 151     /**
 152      * Shows all hidden files of the current directory,
 153      * if \a show is true.
 154      * If the view properties should be remembered for each directory
 155      * (GeneralSettings::globalViewProps() returns false), then the
 156      * show hidden file setting will be be stored automatically.
 157      */
 158     void setShowHiddenFiles(bool show);
 159     bool showHiddenFiles() const;
 160
 161     /**
 162      * Triggers the renaming of the currently selected items, where
 163      * the user must input a new name for the items.
 164      */
 165     void renameSelectedItems();
 166
 167     /**
 168      * Selects all items.
 169      * @see DolphinView::selectedItems()
 170      */
 171     void selectAll();
 172
 173     /**
 174      * Inverts the current selection: selected items get unselected,
 175      * unselected items get selected.
 176      * @see DolphinView::selectedItems()
 177      */
 178     void invertSelection();
 179
 180     /**
 181      * Goes back one step in the URL history. The signals
 182      * UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
 183      * are submitted.
 184      */
 185     void goBack();
 186
 187     /**
 188      * Goes forward one step in the Url history. The signals
 189      * UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
 190      * are submitted.
 191      */
 192     void goForward();
 193
 194     /**
 195      * Goes up one step of the Url path. The signals
 196      * UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
 197      * are submitted.
 198      */
 199     void goUp();
 200
 201     /**
 202      * Goes to the home URL. The signals UrlNavigator::urlChanged()
 203      * and UrlNavigator::historyChanged() are submitted.
 204      */
 205     void goHome();
 206
 207     /**
 208      * Sets the URL of the navigation bar to an editable state
 209      * if \a editable is true. If \a editable is false, each part of
 210      * the location is presented by a button for a fast navigation.
 211      */
 212     void setUrlEditable(bool editable);
 213
 214     /**
 215      * Returns the complete URL history. The index 0 indicates the oldest
 216      * history element.
 217      * @param index     Output parameter which indicates the current
 218      *                  index of the location.
 219      */
 220     const QList<UrlNavigator::HistoryElem> urlHistory(int& index) const;
 221
 222     /** Returns true, if at least one item is selected. */
 223     bool hasSelection() const;
 224
 225     void clearSelection();
 226
 227     /**
 228      * Returns the selected items. The list is empty if no item has been
 229      * selected.
 230      * @see DolphinView::selectedUrls()
 231      */
 232     KFileItemList selectedItems() const;
 233
 234     /**
 235      * Returns a list of URLs for all selected items. An empty list
 236      * is returned, if no item is selected.
 237      * @see DolphinView::selectedItems()
 238      */
 239     KUrl::List selectedUrls() const;
 240
 241     /**
 242      * Returns the file item for the given model index \a index.
 243      */
 244     KFileItem* fileItem(const QModelIndex index) const;
 245
 246     /**
 247      * Renames the filename of the source URL by the new file name.
 248      * If the new file name already exists, a dialog is opened which
 249      * asks the user to enter a new name.
 250      */
 251     void rename(const KUrl& source, const QString& newName);
 252
 253     DolphinStatusBar* statusBar() const;
 254
 255     /**
 256      * Returns the x-position of the view content.
 257      * The content of the view might be larger than the visible area
 258      * and hence a scrolling must be done.
 259      */
 260     int contentsX() const;
 261
 262     /**
 263      * Returns the y-position of the view content.
 264      * The content of the view might be larger than the visible area
 265      * and hence a scrolling must be done.
 266      */
 267     int contentsY() const;
 268
 269     /**
 270      * Returns true, if the URL shown by the navigation bar is editable.
 271      * @see UrlNavigator
 272      */
 273     bool isUrlEditable() const;
 274
 275     /** Increases the size of the current set view mode. */
 276     void zoomIn();
 277
 278     /** Decreases the size of the current set view mode. */
 279     void zoomOut();
 280
 281     /**
 282      * Returns true, if zooming in is possible. If false is returned,
 283      * the minimal zoom size is possible.
 284      */
 285     bool isZoomInPossible() const;
 286
 287     /**
 288      * Returns true, if zooming out is possible. If false is returned,
 289      * the maximum zoom size is possible.
 290      */
 291     bool isZoomOutPossible() const;
 292
 293     /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
 294     void setSorting(Sorting sorting);
 295
 296     /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
 297     Sorting sorting() const;
 298
 299     /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
 300     void setSortOrder(Qt::SortOrder order);
 301
 302     /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
 303     Qt::SortOrder sortOrder() const;
 304
 305     /** Sets the additional information which should be shown for the items. */
 306     void setAdditionalInfo(KFileItemDelegate::AdditionalInformation info);
 307
 308     /** Returns the additional information which should be shown for the items. */
 309     KFileItemDelegate::AdditionalInformation additionalInfo() const;
 310
 311     /** Refreshs the view settings by reading out the stored settings. */
 312     void refreshSettings();
 313
 314     /** Returns the UrlNavigator of the view for read access. */
 315     const UrlNavigator* urlNavigator() const { return m_urlNavigator; }
 316
 317     /**
 318      * Triggers to request user information for the item given
 319      * by the URL \a url. The signal requestItemInfo is emitted,
 320      * which provides a way for widgets to get an indication to update
 321      * the item information.
 322      */
 323     void emitRequestItemInfo(const KUrl& url);
 324
 325     /** Returns true, if the filter bar is visible. */
 326     bool isFilterBarVisible() const;
 327
 328     /**
 329      * Return the DolphinMainWindow this View belongs to. It is guranteed
 330      * that we have one.
 331      */
 332     DolphinMainWindow* mainWindow() const ;
 333
 334     /** Reloads the current directory. */
 335     void reload();
 336
 337 public slots:
 338     /**
 339      * Popups the filter bar above the status bar if \a show is true.
 340      */
 341     void showFilterBar(bool show);
 342
 343     /**
 344      * Updates the number of items (= number of files + number of
 345      * directories) in the statusbar. If files are selected, the number
 346      * of selected files and the sum of the filesize is shown.
 347      */
 348     void updateStatusBar();
 349
 350     /**
 351      * Requests the main window to set this view as active view, which
 352      * means that all actions are applied to this view.
 353      */
 354     void requestActivation();
 355
 356     /**
 357      * Request of a selection change. The view will do its best to accomodate
 358      * the request, but it is not guaranteed that all items in \a selection
 359      * will actually get selected. The view will e.g. not select items which
 360      * are not in the currently displayed folder.
 361      */
 362     void changeSelection(const KFileItemList& selection);
 363
 364 signals:
 365     /** Is emitted if URL of the view has been changed to \a url. */
 366     void urlChanged(const KUrl& url);
 367
 368     /**
 369      * Is emitted if the view mode (IconsView, DetailsView,
 370      * PreviewsView) has been changed.
 371      */
 372     void modeChanged();
 373
 374     /** Is emitted if the 'show preview' property has been changed. */
 375     void showPreviewChanged();
 376
 377     /** Is emitted if the 'show hidden files' property has been changed. */
 378     void showHiddenFilesChanged();
 379
 380     /** Is emitted if the sorting by name, size or date has been changed. */
 381     void sortingChanged(DolphinView::Sorting sorting);
 382
 383     /** Is emitted if the sort order (ascending or descending) has been changed. */
 384     void sortOrderChanged(Qt::SortOrder order);
 385
 386     /** Is emitted if the addtional information for an item has been changed. */
 387     void additionalInfoChanged(KFileItemDelegate::AdditionalInformation info);
 388
 389     /**
 390      * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
 391      * It the URL is empty, no item information request is pending.
 392      */
 393     void requestItemInfo(const KUrl& url);
 394
 395     /** Is emitted if the contents has been moved to \a x, \a y. */
 396     void contentsMoved(int x, int y);
 397
 398     /**
 399      * Is emitted whenever the selection has been changed.
 400      */
 401     void selectionChanged(const KFileItemList& selection);
 402
 403     /**
 404      * Is emitted whenever the filter bar has been turned show or hidden.
 405      */
 406     void showFilterBarChanged(bool shown);
 407
 408 protected:
 409     /** @see QWidget::mouseReleaseEvent */
 410     virtual void mouseReleaseEvent(QMouseEvent* event);
 411
 412 private slots:
 413     void loadDirectory(const KUrl& kurl);
 414     void triggerItem(const QModelIndex& index);
 415     void updateProgress(int percent);
 416
 417     /**
 418      * Updates the number of items (= number of directories + number of files)
 419      * and shows this information in the statusbar.
 420      */
 421     void updateItemCount();
 422
 423     /**
 424      * Generates a preview image for each file item in \a items.
 425      * The current preview settings (maximum size, 'Show Preview' menu)
 426      * are respected.
 427      */
 428     void generatePreviews(const KFileItemList& items);
 429
 430     /**
 431      * Replaces the icon of the item \a item by the preview pixmap
 432      * \a pixmap.
 433      */
 434     void showPreview(const KFileItem* item, const QPixmap& pixmap);
 435
 436     /**
 437      * Restores the x- and y-position of the contents if the
 438      * current view is part of the history.
 439      */
 440     void restoreContentsPos();
 441
 442     /** Shows the information \a msg inside the statusbar. */
 443     void showInfoMessage(const QString& msg);
 444
 445     /** Shows the error message \a msg inside the statusbar. */
 446     void showErrorMessage(const QString& msg);
 447
 448     void emitSelectionChangedSignal();
 449     void closeFilterBar();
 450
 451     /**
 452      * Filters the currently shown items by \a nameFilter. All items
 453      * which contain the given filter string will be shown.
 454      */
 455     void changeNameFilter(const QString& nameFilter);
 456
 457     /**
 458      * Opens the context menu on position \a pos. The position
 459      * is used to check whether the context menu is related to an
 460      * item or to the viewport.
 461      */
 462     void openContextMenu(const QPoint& pos);
 463
 464     /**
 465      * Drops the URLs \a urls to the index \a index. \a source
 466      * indicates the widget where the dragging has been started from.
 467      */
 468     void dropUrls(const KUrl::List& urls,
 469                   const QModelIndex& index,
 470                   QWidget* source);
 471
 472     /**
 473      * Drops the URLs \a urls at the
 474      * destination \a destination.
 475      */
 476     void dropUrls(const KUrl::List& urls,
 477                   const KUrl& destination);
 478     /**
 479      * Updates the view properties of the current URL to the
 480      * sorting given by \a sorting.
 481      */
 482     void updateSorting(DolphinView::Sorting sorting);
 483
 484     /**
 485      * Updates the view properties of the current URL to the
 486      * sort order given by \a order.
 487      */
 488     void updateSortOrder(Qt::SortOrder order);
 489
 490     /**
 491      * Emits the signal contentsMoved with the current coordinates
 492      * of the viewport as parameters.
 493      */
 494     void emitContentsMoved();
 495
 496     /**
 497      * Updates the activation state of the view by checking whether
 498      * the currently active view is this view.
 499      */
 500     void updateActivationState();
 501
 502     /** Applies an item effect to all cut items of the clipboard. */
 503     void updateCutItems();
 504
 505 private:
 506     void startDirLister(const KUrl& url, bool reload = false);
 507
 508     /**
 509      * Returns the default text of the status bar, if no item is
 510      * selected.
 511      */
 512     QString defaultStatusBarText() const;
 513
 514     /**
 515      * Returns the text for the status bar, if at least one item
 516      * is selected.
 517      */
 518     QString selectionStatusBarText() const;
 519
 520     /**
 521      * Creates a new view representing the given view mode (DolphinView::mode()).
 522      * The current view will get deleted.
 523      */
 524     void createView();
 525
 526     /**
 527      * Selects all items by using the selection flags \a flags. This is a helper
 528      * method for the slots DolphinView::selectAll() and DolphinView::invertSelection().
 529      */
 530     void selectAll(QItemSelectionModel::SelectionFlags flags);
 531
 532     /**
 533      * Returns a pointer to the currently used item view, which is either
 534      * a ListView or a TreeView.
 535      */
 536     QAbstractItemView* itemView() const;
 537
 538     /**
 539      * Returns true if the index is valid and represents
 540      * the column KDirModel::Name.
 541      */
 542     bool isValidNameIndex(const QModelIndex& index) const;
 543
 544     /**
 545      * Returns true, if the item \a item has been cut into
 546      * the clipboard.
 547      */
 548     bool isCutItem(const KFileItem& item) const;
 549
 550     /** Applies an item effect to all cut items. */
 551     void applyCutItemEffect();
 552
 553 private:
 554     /**
 555      * Remembers the original pixmap for an item before
 556      * the cut effect is applied.
 557      */
 558     struct CutItem {
 559         KUrl url;
 560         QPixmap pixmap;
 561     };
 562
 563     bool m_showProgress;
 564     bool m_blockContentsMovedSignal;
 565     Mode m_mode;
 566
 567     int m_iconSize;
 568     int m_folderCount;
 569     int m_fileCount;
 570
 571     DolphinMainWindow* m_mainWindow;
 572     QVBoxLayout* m_topLayout;
 573     UrlNavigator* m_urlNavigator;
 574
 575     DolphinController* m_controller;
 576     DolphinIconsView* m_iconsView;
 577     DolphinDetailsView* m_detailsView;
 578     KFileItemDelegate* m_fileItemDelegate;
 579
 580     FilterBar* m_filterBar;
 581     DolphinStatusBar* m_statusBar;
 582
 583     KDirModel* m_dirModel;
 584     DolphinDirLister* m_dirLister;
 585     DolphinSortFilterProxyModel* m_proxyModel;
 586
 587     QList<CutItem> m_cutItemsCache;
 588 };
 589
 590 #endif // _DOLPHINVIEW_H_