Gui/Document.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (c) 2004 Jürgen Riegel <juergen.riegel@web.de>              *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Library General Public           *
 *   License as published by the Free Software Foundation; either          *
 *   version 2 of the License, or (at your option) any later version.      *
 *                                                                         *
 *   This library  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 Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this library; see the file COPYING.LIB. If not,    *
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef GUI_DOCUMENT_H
#define GUI_DOCUMENT_H

#include "MDIView.h"

#include <list>
#include <map>
#include <string>

#include <Base/Persistence.h>
#include <App/Document.h>

namespace Base
{
  class Matrix4D;
}

namespace Gui {

class ViewProvider;
class ViewProviderDocumentObject;
class Application;
class DocumentPy;

class GuiExport Document : public Base::Persistence
{
public:
    Document(App::Document* pcDocument, Application * app);
    ~Document();

protected:

    void slotNewObject(const App::DocumentObject&);
    void slotDeletedObject(const App::DocumentObject&);
    void slotChangedObject(const App::DocumentObject&, const App::Property&);
    void slotRenamedObject(const App::DocumentObject&);
    void slotActivatedObject(const App::DocumentObject&);
    void slotRestoredDocument(const App::Document&);

public:

    mutable boost::signal<void (const Gui::ViewProviderDocumentObject&)> signalNewObject;
    mutable boost::signal<void (const Gui::ViewProviderDocumentObject&)> signalDeletedObject;
    mutable boost::signal<void (const Gui::ViewProviderDocumentObject&,
                                const App::Property&)> signalChangedObject;
    mutable boost::signal<void (const Gui::ViewProviderDocumentObject&)> signalRenamedObject;
    mutable boost::signal<void (const Gui::ViewProviderDocumentObject&)> signalActivatedObject;
    mutable boost::signal<void (const Gui::ViewProviderDocumentObject&)> signalInEdit;
    mutable boost::signal<void (const Gui::ViewProviderDocumentObject&)> signalResetEdit;

    unsigned int getMemSize (void) const;
    bool save(void);
    bool saveAs(void);
    virtual void Save (Base::Writer &writer) const;
    virtual void Restore(Base::XMLReader &reader);
    virtual void SaveDocFile (Base::Writer &writer) const;
    virtual void RestoreDocFile(Base::Reader &reader);
    void exportObjects(const std::vector<App::DocumentObject*>&, Base::Writer&);
    void importObjects(const std::vector<App::DocumentObject*>&, Base::Reader&);

    void setModified(bool);
    bool isModified() const;

    App::Document*  getDocument(void) const;


    Gui::MDIView* getActiveView(void) const;
    void createView(const char* sType); 

    bool sendMsgToViews(const char* pMsg);
    void attachView(Gui::BaseView* pcView, bool bPassiv=false);
    void detachView(Gui::BaseView* pcView, bool bPassiv=false);
    void onUpdate(void);
    void onRelabel(void);
    std::list<MDIView*> getMDIViews() const;


    ViewProvider* getViewProvider(const App::DocumentObject *) const;
    void setAnnotationViewProvider(const char* name, ViewProvider *pcProvider);
    ViewProvider * getAnnotationViewProvider(const char* name) const;
    void removeAnnotationViewProvider(const char* name);
    bool isShow(const char* name);
    void setShow(const char* name);
    void setHide(const char* name);
    void setPos(const char* name, const Base::Matrix4D& rclMtrx);
    std::vector<ViewProvider*> getViewProvidersOfType(const Base::Type& typeId) const;
    ViewProvider *getViewProviderByName(const char* name) const;
    bool setEdit(Gui::ViewProvider* p, int ModNum=0);
    void resetEdit(void);
    ViewProvider *getInEdit(void) const;


    void openCommand(const char* sName=0);
    void commitCommand(void);
    void abortCommand(void);
    std::vector<std::string> getUndoVector(void) const;
    std::vector<std::string> getRedoVector(void) const;
    void undo(int iSteps);
    void redo(int iSteps) ;

    bool canClose();
    bool isLastView(void);

    virtual PyObject *getPyObject(void);

protected:
    // pointer to the python class
    Gui::DocumentPy *_pcDocPy;

private:
    struct DocumentP* d;
    static int _iDocCount;


    std::list<std::string> listUndoNames;
    std::list<std::string> listRedoNames;
};

} // namespace Gui


#endif // GUI_DOCUMENT_H