gcp/document.h

Go to the documentation of this file.

// -*- C++ -*-

/*
 * GChemPaint library
 * document.h
 *
 * Copyright (C) 2001-2012 Jean Bréfort <jean.brefort@normalesup.org>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#ifndef GCHEMPAINT_DOCUMENT_H
#define GCHEMPAINT_DOCUMENT_H

#include "operation.h"
#include <gcu/document.h>
#include <gcu/macros.h>
#include <gcugtk/printable.h>
#include <gcu/residue.h>
#include <gcugtk/printable.h>
#include <list>
#include <map>
#include <set>
#include <string>
#include <libxml/tree.h>
#include <gtk/gtk.h>

namespace OpenBabel
{
        class OBMol;
}

namespace gcp {

extern gcu::SignalId OnChangedSignal;
extern gcu::SignalId OnDeleteSignal;
extern gcu::SignalId OnThemeChangedSignal;

class View;
class Application;
class Window;
class Theme;
class Residue;
class Atom;
class Bond;
class Fragment;
class Molecule;

class Document: public gcu::Document, public gcugtk::Printable
{
        //Constructor and destructor
public:
        Document (Application *App, bool StandAlone, Window *window = NULL);
        virtual ~Document ();

        //Interface
public:
        void Clear ();
        GtkWidget* GetWidget ();
        View* GetView () {return m_pView;}
        void Save () const;
        virtual bool Load (xmlNodePtr node);
        const gchar* GetTitle () const;
        void SetTitle (const gchar* title);
        void SetLabel (const gchar* label);
        const gchar* GetLabel () const;
        void SetFileName (std::string const &filename, const gchar *mime_type);
        const gchar* GetFileName () const {return m_filename;}
        void DoPrint (GtkPrintOperation *print, GtkPrintContext *context, int page) const;
        void AddObject (Object* pObject);
        void AddAtom (Atom* pAtom);
        void AddFragment (Fragment* pFragment);
        void AddBond (Bond* pBond);
        void ParseXMLTree (xmlDocPtr xml);
        void LoadObjects (xmlNodePtr node);
        xmlDocPtr BuildXMLTree () const;
        void Update ();
        void Remove (Object* object);
        void Remove (const char* Id);
        void OnProperties ();
        void OnUndo ();
        void OnRedo ();
        const GDate* GetCreationDate () {return &CreationDate;}
        const GDate* GetRevisionDate () {return &RevisionDate;}
        const gchar* GetAuthor () {return m_author;}
        const gchar* GetMail () {return m_mail;}
        const gchar* GetComment () {return m_comment;}
        void SetAuthor (const gchar* author);
        void SetMail (const gchar* mail);
        void SetComment (const gchar* comment);
        void FinishOperation ();
        void AbortOperation ();
        void PopOperation ();
        void PushOperation (Operation* operation, bool undo = true);
        void SetActive ();
        Operation* GetNewOperation (OperationType type);
        Operation* GetCurrentOperation () {return m_pCurOp;}
        void PasteData (xmlNodePtr node);
        bool CanUndo () {return m_UndoList.size() > 0;}
        void SetEditable (bool editable) {m_bWriteable = editable; m_bUndoRedo = true;}
        bool GetEditable () {return m_bWriteable;}
        gcp::Application* GetApplication () {return m_pApp;}
        void ExportImage (std::string const &filename, const char* type, int resolution = -1);
        void SetReadOnly (bool ro);
        bool GetReadOnly () {return m_bReadOnly;}
        virtual double GetYAlign ();
        gcu::Window *GetWindow ();
        GtkWindow *GetGtkWindow ();
        void SetTheme (Theme *theme);
        bool OnSignal (gcu::SignalId Signal, gcu::Object *Child);
        void SetDirty (bool isDirty = true);
        void OnThemeNamesChanged ();
        double GetMedianBondLength ();
        bool SetProperty (unsigned property, char const *value);

        std::string GetProperty (unsigned property) const;

        void SetLoading (bool loading) {m_bIsLoading = loading;}
        void SaveResidue (Residue const *r, xmlNodePtr node);
        gcu::Residue const *GetResidue (char const *symbol, bool *ambiguous = NULL);
        gcu::Residue *CreateResidue (char const *name, char const *symbol, gcu::Molecule *molecule);

        std::set <std::string> &GetNewObjects () {return m_NewObjects;}

private:
        void RemoveAtom (Atom* pAtom);
        void RemoveBond (Bond* pBond);
        void RemoveFragment (Fragment* pFragment);

        //Implementation
private:
        View * m_pView;
        gchar* m_filename;
        gchar *m_title;
        gchar *m_label;
        gchar *m_comment, *m_author, *m_mail;
        bool m_bIsLoading, m_bUndoRedo, m_bReadOnly;
        std::string m_FileType;
        bool m_bWriteable;
        GDate CreationDate, RevisionDate;
        std::list<Operation*> m_UndoList, m_RedoList;
        Operation* m_pCurOp;
        Application* m_pApp;
        Window *m_Window;
        unsigned long m_OpID; // last operation ID
        unsigned m_LastStackSize; // undo list size when last saved
        std::set<Residue const *> m_SavedResidues;
        std::map<std::string, gcu::SymbolResidue> m_Residues;
        std::set <std::string> m_NewObjects;

/* Theme is not really a read only property, but we provide a special Set
method */
GCU_RO_PROP (Theme*, Theme)
GCU_PROP (double, BondLength)
GCU_PROP (double, BondAngle)
GCU_PROP (double, ArrowLength)
GCU_PROP (gchar*, TextFontFamily)
GCU_PROP (PangoStyle, TextFontStyle)
GCU_PROP (PangoWeight, TextFontWeight)
GCU_PROP (PangoVariant, TextFontVariant)
GCU_PROP (PangoStretch, TextFontStretch)
GCU_PROP (gint, TextFontSize)
GCU_RO_PROP (PangoAttrList*, PangoAttrList)
GCU_PROP (bool, AllowClipboard)
GCU_RO_PROP (unsigned, SoftwareVersion)
GCU_PROP (std::string, BracketsFontFamily)
GCU_PROP (int, BracketsFontSize)

GCU_PROP (bool, UseAtomColors)
};

}       //      namespace gcp

#endif // GCHEMPAINT_DOCUMENT_H