gcu/document.h

Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 /* 
00004  * Gnome Chemistry Utils
00005  * gcu/document.h 
00006  *
00007  * Copyright (C) 2004-2010 Jean Bréfort <jean.brefort@normalesup.org>
00008  *
00009  * This program is free software; you can redistribute it and/or 
00010  * modify it under the terms of the GNU General Public License as 
00011  * published by the Free Software Foundation; either version 2 of the
00012  * License, or (at your option) any later version.
00013  *
00014  * This program is distributed in the hope that it will be useful,
00015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017  * GNU General Public License for more details.
00018  *
00019  * You should have received a copy of the GNU General Public License
00020  * along with this program; if not, write to the Free Software
00021  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
00022  * USA
00023  */
00024 
00025 
00026 #ifndef GCU_DOCUMENT_H
00027 #define GCU_DOCUMENT_H
00028 
00029 #include <gcu/object.h>
00030 #include <gcu/dialog-owner.h>
00031 #include <gcu/macros.h>
00032 #include <gcu/loader-error.h>
00033 #include <string>
00034 #include <set>
00035 
00037 namespace gcu
00038 {
00039 
00040 class Application;
00041 class Dialog;
00042 class Molecule;
00043 class Residue;
00044 
00045 class PendingTarget
00046 {
00047 public:
00048         Object *parent;
00049         Object *owner;
00050         Object **target;
00051 };
00052 
00056 class Document: public Object, virtual public DialogOwner
00057 {
00058 friend class Object;
00059 friend class Dialog;
00060 public:
00066         Document (Application *App = NULL);
00070         virtual ~Document ();
00071 
00072 public:
00073 
00081         std::string& GetTranslatedId (const char* id) {return m_TranslationTable[id];}
00082 
00089         void EraseTranslationId (const char* Id) {m_TranslationTable.erase (Id);}
00090 
00096         void EmptyTranslationTable() {m_TranslationTable.clear();}
00097 
00101         virtual void SetTitle (std::string& title) {m_Title = title;}
00105         virtual void SetTitle (char const *title) {m_Title = title;}
00109         std::string &GetTitle () {return m_Title;}
00110 
00117         void NotifyDirty (Object* pObject) {m_DirtyObjects.insert (pObject);}
00122         virtual void Save () const {;}
00133         virtual Residue *CreateResidue (char const *name, char const *symbol, Molecule *molecule);
00143         virtual Residue const *GetResidue (char const *symbol, bool *ambiguous = NULL);
00149         virtual GtkWindow *GetGtkWindow () {return NULL;}
00150 
00163         bool SetTarget (char const *id, Object **target, Object *parent, Object *owner = NULL) throw (std::runtime_error);
00164 
00169         virtual bool Loaded () throw (LoaderError);
00173         std::string Name ();
00174 
00175 private:
00176 
00186         gchar* GetNewId (gchar* id, bool Cache = true);
00187 
00188 private:
00189         std::map <std::string, std::string> m_TranslationTable;//used when Ids translations are necessary (on pasting...)
00190         std::map <std::string, std::list <PendingTarget> > m_PendingTable;//used to set pointers to objects when loading does not occur in the ideal order
00191 
00192 protected:
00196         std::string m_Title;
00197 
00201         std::set<Object*> m_DirtyObjects;
00202 
00210 GCU_PROT_PROP (Application *, App)
00217 GCU_PROT_PROP (bool, Empty);
00229 GCU_PROP (double, Scale);
00230 };
00231 
00232 
00233 }
00234 #endif  //GCU_DOCUMENT_H

Generated on Fri Sep 24 15:58:41 2010 for The Gnome Chemistry Utils by  doxygen 1.5.9