#include <gcu/document.h>
Public Member Functions | |
Document (Application *App=NULL) | |
virtual | ~Document () |
std::string & | GetTranslatedId (const char *id) |
void | EraseTranslationId (const char *Id) |
void | EmptyTranslationTable () |
void | SetTitle (std::string &title) |
void | SetTitle (char const *title) |
std::string & | GetTitle () |
void | NotifyDirty (Object *pObject) |
virtual void | Save () const |
virtual Residue * | CreateResidue (char const *name, char const *symbol, Molecule *molecule) |
virtual Residue const * | GetResidue (char const *symbol, bool *ambiguous=NULL) |
Application * | GetApp (void) |
bool | GetEmpty (void) |
double | GetScale (void) |
Protected Attributes | |
std::string | m_Title |
std::set< Object * > | m_DirtyObjects |
Application * | m_App |
bool | m_Empty |
double | m_Scale |
Definition at line 47 of file gcu/document.h.
gcu::Document::Document | ( | Application * | App = NULL |
) |
App | the Appllcation which owns the new document. |
virtual gcu::Document::~Document | ( | ) | [virtual] |
The destructor of Document.
Reimplemented in gcp::Document.
std::string& gcu::Document::GetTranslatedId | ( | const char * | id | ) | [inline] |
id | the original id to tranlate |
Definition at line 72 of file gcu/document.h.
void gcu::Document::EraseTranslationId | ( | const char * | Id | ) | [inline] |
Id | the entry to remove |
Definition at line 80 of file gcu/document.h.
void gcu::Document::EmptyTranslationTable | ( | ) | [inline] |
When pasting, objects added to the document might have the same Id as objects already existing. In such cases, the document maintains a table to update links using Ids as identifiers. The EmptyTranslationTable method should be called after pasting to reinitialize the table to avoid errors on the next paste event.
Definition at line 87 of file gcu/document.h.
void gcu::Document::SetTitle | ( | std::string & | title | ) | [inline] |
title | the new document title. |
Definition at line 92 of file gcu/document.h.
References m_Title.
void gcu::Document::SetTitle | ( | char const * | title | ) | [inline] |
title | the new document title. |
Definition at line 96 of file gcu/document.h.
References m_Title.
std::string& gcu::Document::GetTitle | ( | ) | [inline] |
Reimplemented in gcu::Chem3dDoc.
Definition at line 100 of file gcu/document.h.
References m_Title.
void gcu::Document::NotifyDirty | ( | Object * | pObject | ) | [inline] |
pObject | an object needing some update. |
Definition at line 108 of file gcu/document.h.
References m_DirtyObjects.
virtual void gcu::Document::Save | ( | ) | const [inline, virtual] |
Saves the document. Need to be overloaded by derived class if meaningful. Default implementation doesn't do anything.
Reimplemented in gcp::Document.
Definition at line 113 of file gcu/document.h.
virtual Residue* gcu::Document::CreateResidue | ( | char const * | name, | |
char const * | symbol, | |||
Molecule * | molecule | |||
) | [virtual] |
name | the name of the new residue. | |
symbol | the symbol of the new residue. | |
molecule | a molecule with a pseudo atom which describes the structure of the residue. |
Reimplemented in gcp::Document.
virtual Residue const* gcu::Document::GetResidue | ( | char const * | symbol, | |
bool * | ambiguous = NULL | |||
) | [virtual] |
symbol | the symbol for which a Residue* is searched. | |
ambiguous | where to store the boolean telling if the symbol is ambiguous or NULL. |
Reimplemented in gcp::Document.
gcu::Document::GetApp | ( | void | ) | [inline] |
Definition at line 170 of file gcu/document.h.
gcu::Document::GetEmpty | ( | void | ) | [inline] |
Definition at line 177 of file gcu/document.h.
gcu::Document::GetScale | ( | void | ) | [inline] |
std::string gcu::Document::m_Title [protected] |
The document title.
Definition at line 156 of file gcu/document.h.
Referenced by GetTitle(), and SetTitle().
std::set<Object*> gcu::Document::m_DirtyObjects [protected] |
The set of dirty objects, see gcu::Document::NotifyDirty.
Definition at line 161 of file gcu/document.h.
Referenced by NotifyDirty().
gcu::Document::m_App [protected] |
The Application instance owning the document.
Definition at line 170 of file gcu/document.h.
gcu::Document::m_Empty [protected] |
Tells if the document is empty or not.
Definition at line 177 of file gcu/document.h.
gcu::Document::m_Scale [protected] |
The scale factor to be used in IO operations. all coordinates should be multiplied by this factor when loading and divided when saving. Default value is 1.
Definition at line 185 of file gcu/document.h.