src/treeviewsidebarpage.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>                  *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef TREEVIEWSIDEBARPAGE_H
  21 #define TREEVIEWSIDEBARPAGE_H
  22
  23 #include <kurl.h>
  24 #include <sidebarpage.h>
  25
  26 class KDirLister;
  27 class DolphinModel;
  28
  29 class DolphinSortFilterProxyModel;
  30 class SidebarTreeView;
  31 class QModelIndex;
  32
  33 /**
  34  * @brief Shows a tree view of the directories starting from
  35  *        the currently selected place.
  36  *
  37  * The tree view is always synchronized with the currently active view
  38  * from the main window.
  39  */
  40 class TreeViewSidebarPage : public SidebarPage
  41 {
  42     Q_OBJECT
  43
  44 public:
  45     TreeViewSidebarPage(QWidget* parent = 0);
  46     virtual ~TreeViewSidebarPage();
  47
  48     /** @see QWidget::sizeHint() */
  49     virtual QSize sizeHint() const;
  50
  51 public slots:
  52     /**
  53      * Changes the current selection inside the tree to \a url.
  54      */
  55     virtual void setUrl(const KUrl& url);
  56
  57 protected:
  58     /** @see QWidget::showEvent() */
  59     virtual void showEvent(QShowEvent* event);
  60
  61     /** @see QWidget::contextMenuEvent() */
  62     virtual void contextMenuEvent(QContextMenuEvent* event);
  63
  64 private slots:
  65     /**
  66      * Expands the tree in a way that the item with the URL m_selectedUrl
  67      * gets visible. Is called by TreeViewSidebarPage::updateSelection()
  68      * if the dir lister has been completed.
  69      */
  70     void expandSelectionParent();
  71
  72     /**
  73      * Updates the active view to the URL
  74      * which is given by the item with the index \a index.
  75      */
  76     void updateActiveView(const QModelIndex& index);
  77
  78     /**
  79      * Is emitted if the URLs \a urls have been dropped
  80      * to the index \a index. */
  81     void dropUrls(const KUrl::List& urls,
  82                   const QModelIndex& index);
  83
  84     /**
  85      * Invokes expandToLeafDir() asynchronously (the expanding
  86      * may not be done in the context of this slot).
  87      */
  88     void triggerExpanding(const QModelIndex& index);
  89
  90     /**
  91      * Expands all directories to make m_leafDir visible and
  92      * adjusts the selection.
  93      */
  94     void expandToLeafDir();
  95
  96     /**
  97      * Loads the sub tree to make m_leafDir visible. Is invoked
  98      * indirectly by loadTree() after the directory lister has
  99      * finished loading the root items.
 100      */
 101     void loadSubTree();
 102
 103     /**
 104      * Is invoked when the directory lister has started the loading
 105      * of the URL \a url and sets the internal m_dirListerCompleted
 106      * state to false.
 107      */
 108     void slotDirListerStarted(const KUrl& url);
 109
 110     /**
 111      * Is invoked when the directory lister has completed the loading
 112      * and sets the internal m_dirListerCompleted state to true.
 113      */
 114     void slotDirListerCompleted();
 115
 116 private:
 117     /**
 118      * Initializes the base URL of the tree and expands all
 119      * directories until \a url.
 120      * @param url  URL of the leaf directory that should get expanded.
 121      */
 122     void loadTree(const KUrl& url);
 123
 124 private:
 125     bool m_dirListerCompleted;
 126     KDirLister* m_dirLister;
 127     DolphinModel* m_dolphinModel;
 128     DolphinSortFilterProxyModel* m_proxyModel;
 129     SidebarTreeView* m_treeView;
 130     KUrl m_leafDir;
 131 };
 132
 133 #endif // TREEVIEWSIDEBARPAGE_H