The Gnome Chemistry Utils 0.13.3
|
a GChemPaint specific Residue class. More...
#include <gcp/residue.h>
Public Member Functions | |
Residue () | |
Residue (char const *name) | |
Residue (char const *name, char const *symbol, Molecule *mol, Document *doc) | |
virtual | ~Residue () |
void | Load (xmlNodePtr node, bool ro, gcu::Application *app) |
bool | operator== (gcu::Molecule const &mol) const |
void | Register () |
void | Ref () |
void | Unref () |
bool | GetReadOnly (void) const |
xmlNodePtr | GetNode (void) const |
xmlNodePtr | GetMolNode (void) const |
unsigned | GetRefs (void) const |
Static Public Member Functions | |
static void | SetPostAddCallback (void(*cb)(Residue *res)) |
a GChemPaint specific Residue class.
This class adds some GChemPaint specific features to gcu::Residue.
Definition at line 44 of file gcp/residue.h.
gcp::Residue::Residue | ( | ) |
The default constructor.
Reimplemented from gcu::Residue.
gcp::Residue::Residue | ( | char const * | name | ) |
name | the name of the new residue. |
Constructs a new residue with the given name.
name | the name of the new residue. |
symbol | the symbol of the new residue. |
mol | the molecule represented by the residue. |
doc | the document owning the residue when it does not have global scope. |
Constructs a new residue using the given arguments.
virtual gcp::Residue::~Residue | ( | ) | [virtual] |
The destructor.
Reimplemented from gcu::Residue.
gcp::Residue::GetMolNode | ( | void | ) | const [inline] |
Definition at line 122 of file gcp/residue.h.
gcp::Residue::GetNode | ( | void | ) | const [inline] |
Definition at line 118 of file gcp/residue.h.
gcp::Residue::GetReadOnly | ( | void | ) | const [inline] |
Definition at line 114 of file gcp/residue.h.
gcp::Residue::GetRefs | ( | void | ) | const [inline] |
Definition at line 127 of file gcp/residue.h.
void gcp::Residue::Load | ( | xmlNodePtr | node, |
bool | ro, | ||
gcu::Application * | app | ||
) |
node | an XML node. |
ro | whether the residue is read-only or not. |
Loads data GChemPaint specific data from node, and calls gcu::Residue::Load().
bool gcp::Residue::operator== | ( | gcu::Molecule const & | mol | ) | const |
mol | the molecule to compare to the residue. |
void gcp::Residue::Ref | ( | ) |
Increments the references number by one unit.
void gcp::Residue::Register | ( | ) |
Registers the residue in the database.
static void gcp::Residue::SetPostAddCallback | ( | void(*)(Residue *res) | cb | ) | [inline, static] |
cb | a callback to call when a new residue is registered. |
When a new residue is registered in the database, it might be necessary to execute some extra code, hence this static method. Only one callback can be registered in this version.
Definition at line 106 of file gcp/residue.h.
void gcp::Residue::Unref | ( | ) |
Decreases the references number by one unit.