KDE 4.0 API Reference kalzium
Avogadro::MoleculeTreeView Class Reference
#include <moleculetreeview.h>
Detailed Description
Tree based view of a Molecule.This widget provides a list of the molecule's primitives (Atoms, Bonds, Residues) grouped by their type. In terms of a Model-View architecture we consider the Molecule the model and MoleculeTreeView a view of this model.
Definition at line 45 of file src/moleculetreeview.h.
Public Member Functions | |
| MoleculeTreeView (QWidget *parent=0) | |
| MoleculeTreeView (Molecule *molecule, QWidget *parent=0) | |
| void | setMolecule (Molecule *molecule) |
Protected Member Functions | |
| QString | primitiveToItemText (Primitive *primitive) |
| int | primitiveToItemIndex (Primitive *primitive) |
| void | updateGroup (QTreeWidgetItem *group) |
| void | updatePrimitiveItem (QTreeWidgetItem *item) |
| QTreeWidgetItem * | addGroup (enum Primitive::Type type) |
| QTreeWidgetItem * | addGroup (const QString &name, enum Primitive::Type type) |
Protected Attributes | |
| Molecule * | m_molecule |
| QVector< QTreeWidgetItem * > | m_groups |
Constructor & Destructor Documentation
| Avogadro::MoleculeTreeView::MoleculeTreeView | ( | QWidget * | parent = 0 |
) |
Construct a new molecule treeview.
- Parameters:
-
parent the widget parent
Definition at line 34 of file moleculetreeview.cpp.
| Avogadro::MoleculeTreeView::MoleculeTreeView | ( | Molecule * | molecule, | |
| QWidget * | parent = 0 | |||
| ) | [explicit] |
Construct a new molecule treeview.
Don't stress yourself out.
- Parameters:
-
molecule the molecule to view parent the widget parent
Definition at line 39 of file moleculetreeview.cpp.
Member Function Documentation
| void Avogadro::MoleculeTreeView::setMolecule | ( | Molecule * | molecule | ) |
Set the molecule which is the model for the treeview.
- Parameters:
-
molecule the molecule to view
Definition at line 76 of file moleculetreeview.cpp.
A helper function to generate our item strings based off the primitive information.
- Parameters:
-
primitive primitive to generate the string for
- Returns:
- item string (ie. "Atom X", "Bond (x, y)")
Definition at line 231 of file moleculetreeview.cpp.
| int Avogadro::MoleculeTreeView::primitiveToItemIndex | ( | Primitive * | primitive | ) | [protected] |
Return the index in our list for the primitive.
Causes a search on all our items O(n).
- Parameters:
-
primitive primitive to find
- Returns:
- index of the specified primitive or -1 if not found
Definition at line 275 of file moleculetreeview.cpp.
| void Avogadro::MoleculeTreeView::updateGroup | ( | QTreeWidgetItem * | group | ) | [protected] |
Update a group of items.
Given a parent item it updates all the children items.
- Parameters:
-
group the parent item of the group to update
Definition at line 208 of file moleculetreeview.cpp.
| void Avogadro::MoleculeTreeView::updatePrimitiveItem | ( | QTreeWidgetItem * | item | ) | [protected] |
Update a single item.
- Parameters:
-
item item to update
Definition at line 219 of file moleculetreeview.cpp.
| QTreeWidgetItem* Avogadro::MoleculeTreeView::addGroup | ( | enum Primitive::Type | type | ) | [protected] |
Add a new group for a primitive type.
- Parameters:
-
type the type of the group to add
- Returns:
- the parent item for the group
| QTreeWidgetItem * Avogadro::MoleculeTreeView::addGroup | ( | const QString & | name, | |
| enum Primitive::Type | type | |||
| ) | [protected] |
Add a new group.
- Parameters:
-
name name of the group type group type
- Returns:
- the item which is the parent item for the group
Definition at line 127 of file moleculetreeview.cpp.
Member Data Documentation
Molecule* Avogadro::MoleculeTreeView::m_molecule [protected] |
QVector<QTreeWidgetItem *> Avogadro::MoleculeTreeView::m_groups [protected] |
Groups of item widgets for our various primitive types.
Each group is essentially a single QTreeWidgetItem which has as it's children all the members of the group.
Definition at line 124 of file src/moleculetreeview.h.
The documentation for this class was generated from the following files:
