gcu::Document Class Reference

#include <gcu/document.h>

Inheritance diagram for gcu::Document:

gcu::Object gcu::CrystalDoc gcu::GLDocument gcu::Chem3dDoc List of all members.

Public Member Functions

 Document (Application *App=NULL)
virtual ~Document ()
string & GetTranslatedId (const char *id)
void EraseTranslationId (const char *Id)
void EmptyTranslationTable ()
void SetTitle (string &title)
void SetTitle (char const *title)
string & GetTitle ()

Protected Attributes

Applicationm_App
string m_Title

Detailed Description

This class is the base document class.

Definition at line 42 of file document.h.


Constructor & Destructor Documentation

gcu::Document::Document ( Application App = NULL  ) 

Parameters:
App,: the Appllcation which owns the new document.
The default constructor. Creates an empty document.

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

The destructor of Document.


Member Function Documentation

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 81 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 74 of file document.h.

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 66 of file document.h.


The documentation for this class was generated from the following file:
Generated on Tue Aug 15 10:47:36 2006 for The Gnome Chemistry Utils by  doxygen 1.4.7