kalzium/libavogadro-kalzium/src/moleculetreeview.h

   1 /**********************************************************************
   2   MoleculeTreeView - Tree View of a Molecule
   3
   4   Copyright (C) 2007 Donald Ephraim Curtis <donald-curtis@uiowa.edu>
   5
   6   This file is part of the Avogadro molecular editor project.
   7   For more information, see <http://avogadro.sourceforge.net/>
   8
   9   Avogadro is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   Avogadro is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19   You should have received a copy of the GNU General Public License
  20   along with this program; if not, write to the Free Software
  21   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22   02110-1301, USA.
  23  **********************************************************************/
  24
  25 #ifndef __MOLECULETREEVIEW_H
  26 #define __MOLECULETREEVIEW_H
  27
  28 #include <avogadro/global.h>
  29 #include <avogadro/primitive.h>
  30
  31 #include <QTreeWidget>
  32 #include <QItemDelegate>
  33
  34 namespace Avogadro {
  35
  36   /**
  37    * @class MoleculeTreeView
  38    * @brief Tree based view of a Molecule.
  39    * @author Donald Ephraim Curtis <donald-curtis@uiowa.edu>
  40    *
  41    * This widget provides a list of the molecule's primitives (Atoms, Bonds, Residues)
  42    * grouped by their type.  In terms of a Model-View architecture we consider
  43    * the Molecule the model and MoleculeTreeView a view of this model.
  44    */
  45   class A_EXPORT MoleculeTreeView : public QTreeWidget
  46   {
  47     Q_OBJECT
  48
  49     public:
  50       /**
  51        * Construct a new molecule treeview.
  52        * @param parent the widget parent
  53        */
  54       MoleculeTreeView(QWidget *parent=0);
  55
  56       /** Construct a new molecule treeview. Don't stress yourself out.
  57        *
  58        * @param molecule the molecule to view
  59        * @param parent the widget parent
  60        */
  61       explicit MoleculeTreeView(Molecule *molecule, QWidget *parent=0);
  62
  63       /**
  64        * Set the molecule which is the model for the treeview.
  65        * @param molecule the molecule to view
  66        */
  67       void setMolecule(Molecule *molecule);
  68
  69     private Q_SLOTS:
  70       /**
  71        * Add the primitive to the widget.  This slot is called whenever
  72        * a new primitive is added to our molecule model.  It adds the
  73        * primitive to the list in the appropriate group.
  74        *
  75        * @param primitive pointer to a primitive to add to the view
  76        * @return the QTreeWidgetItem which was created as a result of this
  77        * primitive addition
  78        */
  79       QTreeWidgetItem* addPrimitive(Primitive *primitive);
  80
  81       /**
  82        * Update a primitive.  This slot is called whenever a primitive of our
  83        * molecule model has been changed and we need to check our view.
  84        *
  85        * @note In some cases we are passed the molecule itself meaning that more
  86        * than one thing has changed in the molecule.
  87        *
  88        * @param primitive primitive that was changed
  89        */
  90       void updatePrimitive(Primitive *primitive);
  91
  92       /** Remove a primitive.  This slot is called whenever a primitive of our
  93        * molecule model has been removed and we need to take it off our list.
  94        * Additionally we need to update other items in our view that are impacted
  95        * by this change.
  96        *
  97        * @param primitive primitive that was removed
  98        */
  99       void removePrimitive(Primitive *primitive);
 100
 101       /**
 102        * Update the entire model.  This goes though all items in the list and
 103        * updates their view.
 104        */
 105       void updateModel();
 106
 107       /**
 108        * Handles when the mouse is pressed on a certain item.
 109        *
 110        * @param item item which the mouse pressed
 111        */
 112       void handleMousePress(QTreeWidgetItem *item);
 113
 114     protected:
 115       /**
 116        * Current molecule for this view.
 117        */
 118       Molecule *m_molecule;
 119       /**
 120        * Groups of item widgets for our various primitive types.  Each group
 121        * is essentially a single QTreeWidgetItem which has as it's children
 122        * all the members of the group.
 123        */
 124       QVector<QTreeWidgetItem *> m_groups;
 125
 126       /**
 127        * A helper function to generate our item strings based off the
 128        * primitive information.
 129        *
 130        * @param primitive primitive to generate the string for
 131        * @return item string (ie. "Atom X", "Bond (x, y)")
 132        */
 133       QString primitiveToItemText(Primitive *primitive);
 134
 135       /**
 136        * Return the index in our list for the primitive.  Causes a search
 137        * on all our items O(n).
 138        *
 139        * @param primitive primitive to find
 140        * @return index of the specified primitive or -1 if not found
 141        */
 142       int primitiveToItemIndex(Primitive *primitive);
 143
 144       /**
 145        * Update a group of items.  Given a parent item it updates
 146        * all the children items.
 147        *
 148        * @param group the parent item of the group to update
 149        */
 150       void updateGroup(QTreeWidgetItem *group);
 151
 152       /**
 153        * Update a single item.
 154        *
 155        * @param item item to update
 156        */
 157       void updatePrimitiveItem(QTreeWidgetItem *item);
 158
 159       /**
 160        * Add a new group for a primitive type.
 161        *
 162        * @param type the type of the group to add
 163        * @return the parent item for the group
 164        */
 165       QTreeWidgetItem* addGroup(enum Primitive::Type type);
 166
 167       /**
 168        * Add a new group.
 169        *
 170        * @param name name of the group
 171        * @param type group type
 172        * @return the item which is the parent item for the group
 173        */
 174       QTreeWidgetItem* addGroup(const QString& name, enum Primitive::Type type);
 175
 176     private:
 177       /**
 178        * Common constructor function.
 179        */
 180       void constructor();
 181   };
 182
 183   /**
 184    * @internal Used by the MoleculeTreeView to draw items in the list.
 185    * @class MoleculeItemDelegate
 186    * @author Donald Ephraim Curtis <donald-curtis@uiowa.edu>
 187    */
 188   class MoleculeItemDelegate : public QItemDelegate
 189   {
 190     Q_OBJECT
 191     public:
 192       MoleculeItemDelegate(QTreeView *view, QWidget *parent);
 193
 194       virtual void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const;
 195       virtual QSize sizeHint(const QStyleOptionViewItem &opt, const QModelIndex &index) const;
 196
 197     private:
 198       QTreeView *m_view;
 199
 200   };
 201
 202
 203 }
 204
 205 #endif