gcu::Document Class Reference

#include <gcu/document.h>

Inheritance diagram for gcu::Document:

gcu::Object gcu::DialogOwner gcp::Document gcu::GLDocument gcu::Chem3dDoc gcu::CrystalDoc

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

string m_Title
 Dirty


Detailed Description

This class is the base document class.

Definition at line 45 of file gcu/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.

Reimplemented in gcp::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 70 of file gcu/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 78 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 85 of file gcu/document.h.

void gcu::Document::SetTitle ( string &  title  )  [inline]

Parameters:
title the new document title.

Definition at line 90 of file gcu/document.h.

References m_Title.

void gcu::Document::SetTitle ( char const *  title  )  [inline]

Parameters:
title the new document title.

Definition at line 94 of file gcu/document.h.

References m_Title.

string& gcu::Document::GetTitle (  )  [inline]

Returns:
the current document title.

Reimplemented in gcu::Chem3dDoc, and gcp::Document.

Definition at line 98 of file gcu/document.h.

References m_Title.


Member Data Documentation

string gcu::Document::m_Title [protected]

The document title.

Definition at line 120 of file gcu/document.h.

Referenced by GetTitle(), and SetTitle().


The documentation for this class was generated from the following file:
Generated on Sun Sep 16 14:21:56 2007 for The Gnome Chemistry Utils by  doxygen 1.5.3