The Gnome Chemistry Utils 0.13.5
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-2011 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 class Window;
00045 
00046 typedef enum {
00047         ActionException,
00048         ActionDelete,
00049         ActionIgnore
00050 } Action;
00051 
00052 class PendingTarget
00053 {
00054 public:
00055         Object *parent;
00056         Object *owner;
00057         Object **target;
00058         Action action;
00059 };
00060 
00064 class Document: public Object, virtual public DialogOwner
00065 {
00066 friend class Application;
00067 friend class Object;
00068 friend class Dialog;
00069 public:
00075         Document (Application *App = NULL);
00079         virtual ~Document ();
00080 
00081 public:
00082 
00090         std::string& GetTranslatedId (const char* id) {return m_TranslationTable[id];}
00091 
00098         void EraseTranslationId (const char* Id) {m_TranslationTable.erase (Id);}
00099 
00105         void EmptyTranslationTable() {m_TranslationTable.clear();}
00106 
00110         virtual void SetTitle (std::string& title) {m_Title = title;}
00114         virtual void SetTitle (char const *title) {m_Title = title;}
00118         std::string &GetTitle () {return m_Title;}
00119 
00126         void NotifyDirty (Object* pObject) {m_DirtyObjects.insert (pObject);}
00131         virtual void Save () const {;}
00142         virtual Residue *CreateResidue (char const *name, char const *symbol, Molecule *molecule);
00152         virtual Residue const *GetResidue (char const *symbol, bool *ambiguous = NULL);
00158         virtual GtkWindow *GetGtkWindow () {return NULL;}
00159 
00172         bool SetTarget (char const *id, Object **target, Object *parent, Object *owner = NULL, Action action = ActionException) throw (std::runtime_error);
00173 
00178         virtual bool Loaded () throw (LoaderError);
00182         std::string Name ();
00183 
00184         void ObjectLoaded (Object *obj);
00185         std::set < Object * > GetNewObjects () {return m_NewObjects;}
00186         virtual Window *GetWindow () {return NULL;}
00187 
00188 private:
00189 
00199         char* GetNewId (char const *id, bool Cache = true);
00200 
00201 private:
00202         std::map <std::string, std::string> m_TranslationTable;//used when Ids translations are necessary (on pasting...)
00203         std::map <std::string, std::list <PendingTarget> > m_PendingTable;//used to set pointers to objects when loading does not occur in the ideal order
00204         std::set<Object*> m_NewObjects;
00205 
00206 protected:
00210         std::string m_Title;
00211 
00215         std::set<Object*> m_DirtyObjects;
00216 
00224 GCU_PROT_POINTER_PROP (Application, App)
00231 GCU_PROT_PROP (bool, Empty);
00243 GCU_PROP (double, Scale);
00244 };
00245 
00246 
00247 }
00248 #endif  //GCU_DOCUMENT_H