08f0511b1f
* Add new API and signal handler in document observer * Pre initialize python handler function to improve performance. In case Python code use dynamic patching, i.e. add class method at runtime (which is rare and should be discouraged), the python feature can be re-initialized by simply assign proeprty Proxy again. * Add property tracking in DocumentObjectT * WidgetFactory adds support for accepting python QIcon, which is used by ViewProviderPythonFeature
103 lines
4.3 KiB
C++
103 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
|
|
|
|
#include <CXX/Objects.hxx>
|
|
|
|
#include <boost/signals2.hpp>
|
|
#include <boost/bind.hpp>
|
|
|
|
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 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 boost::signals2::connection Connection;
|
|
|
|
#define FC_PY_GDOC_OBSERVER \
|
|
FC_PY_ELEMENT(CreatedDocument,_1) \
|
|
FC_PY_ELEMENT(DeletedDocument,_1) \
|
|
FC_PY_ELEMENT(RelabelDocument,_1) \
|
|
FC_PY_ELEMENT(RenameDocument,_1) \
|
|
FC_PY_ELEMENT(ActivateDocument,_1) \
|
|
FC_PY_ELEMENT(CreatedObject,_1) \
|
|
FC_PY_ELEMENT(DeletedObject,_1) \
|
|
FC_PY_ELEMENT(ChangedObject,_1,_2) \
|
|
FC_PY_ELEMENT(InEdit,_1) \
|
|
FC_PY_ELEMENT(ResetEdit,_1)
|
|
|
|
#undef FC_PY_ELEMENT
|
|
#define FC_PY_ELEMENT(_name,...) \
|
|
Connection connect##_name;\
|
|
Py::Object py##_name;
|
|
|
|
FC_PY_GDOC_OBSERVER
|
|
};
|
|
|
|
} //namespace Gui
|
|
|
|
#endif // GUI_DOCUMENTOBSERVERPYTHON_H
|