gcu::Document Class Reference

#include <gcu/document.h>

Inheritance diagram for gcu::Document:

gcu::Object List of all members.

Public Member Functions

 Document ()
virtual ~Document ()
string & GetTranslatedId (const char *id)
void EraseTranslationId (const char *Id)
void EmptyTranslationTable ()

Detailed Description

This class is the base document class.

Definition at line 38 of file document.h.


Constructor & Destructor Documentation

gcu::Document::Document (  ) 

The default constructor. Creates an empty document.

virtual gcu::Document::~Document (  )  [virtual]

The destructor of Document.


Member Function Documentation

string& gcu::Document::GetTranslatedId ( const char *  id  )  [inline]

Parameters:
id,: the original id to tranlate
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. GetTranslatedId returns the translated id corresponding to the parameter id.

Definition at line 60 of file document.h.

void gcu::Document::EraseTranslationId ( const char *  Id  )  [inline]

Parameters:
Id,: the entry to remove
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 EraseTranslationTable method removes thenentry correspondig to id.

Definition at line 68 of file 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 75 of file document.h.


The documentation for this class was generated from the following file:
Generated on Sun Jan 14 15:28:03 2007 for The Gnome Chemistry Utils by  doxygen 1.5.1