Files
create/src/Gui/DocumentObserverPython.h

100 lines
4.3 KiB
C++

/***************************************************************************
* Copyright (c) 2018 Stefan Tröger <stefantroeger@gmx.net> *
* *
* 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_DOCUMENTOBSERVERPYTHON_H
#define GUI_DOCUMENTOBSERVERPYTHON_H
namespace Gui
{
/**
* The DocumentObserverPython class is used to notify registered Python instances
* whenever something happens to a document, like creation, destruction, adding or
* removing viewproviders or when viewprovider property changes. This is the equivalent to the app
* python document observer
*/
class GuiExport DocumentObserverPython
{
public:
/// Constructor
DocumentObserverPython(const Py::Object& obj);
virtual ~DocumentObserverPython();
static void addObserver(const Py::Object& obj);
static void removeObserver(const Py::Object& obj);
private:
/** Checks if a new document was created */
void slotCreatedDocument(const Gui::Document& Doc);
/** Checks if the given document is about to be closed */
void slotDeletedDocument(const Gui::Document& Doc);
/** Checks if the given document is relabeled */
void slotRelabelDocument(const Gui::Document& Doc);
/** Checks if the given document is renamed */
void slotRenameDocument(const Gui::Document& Doc);
/** Checks if the given document is activated */
void slotActivateDocument(const Gui::Document& Doc);
/** Checks if a new object was added. */
void slotCreatedObject(const Gui::ViewProvider& Obj);
/** Checks if the given object is about to be removed. */
void slotDeletedObject(const Gui::ViewProvider& Obj);
/** The property of an observed object has changed */
void slotBeforeChangeObject(const Gui::ViewProvider& Obj, const App::Property& Prop);
/** The property of an observed object has changed */
void slotChangedObject(const Gui::ViewProvider& Obj, const App::Property& Prop);
/** The object was set into edit mode */
void slotInEdit(const Gui::ViewProviderDocumentObject& Obj);
/** The has left edit mode */
void slotResetEdit(const Gui::ViewProviderDocumentObject& Obj);
private:
Py::Object inst;
static std::vector<DocumentObserverPython*> _instances;
typedef struct PythonObject {
boost::signals2::scoped_connection slot;
Py::Object py;
PyObject* ptr() {
return py.ptr();
}
} Connection;
Connection pyCreatedDocument;
Connection pyDeletedDocument;
Connection pyRelabelDocument;
Connection pyRenameDocument;
Connection pyActivateDocument;
Connection pyCreatedObject;
Connection pyDeletedObject;
Connection pyBeforeChangeObject;
Connection pyChangedObject;
Connection pyInEdit;
Connection pyResetEdit;
};
} //namespace Gui
#endif // GUI_DOCUMENTOBSERVERPYTHON_H