File size: 7,628 Bytes
985c397 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | // SPDX-License-Identifier: LGPL-2.1-or-later
/***************************************************************************
* Copyright (c) 2009 Werner Mayer <wmayer[at]users.sourceforge.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 APP_DOCUMENTOBSERVERPYTHON_H
#define APP_DOCUMENTOBSERVERPYTHON_H
#include <FCGlobal.h>
#include <fastsignals/signal.h>
#include <CXX/Objects.hxx>
#include <string>
#include <vector>
namespace App
{
class Document;
class DocumentObject;
class ExtensionContainer;
class Property;
/**
* The DocumentObserverPython class is used to notify registered Python instances
* whenever something happens to a document, like creation, destruction, adding or
* removing objects or when property changes.
*
* @author Werner Mayer
*/
class AppExport 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 App::Document& Doc);
/** Checks if the given document is about to be closed */
void slotDeletedDocument(const App::Document& Doc);
/** Checks if the given document is relabeled */
void slotRelabelDocument(const App::Document& Doc);
/** Checks if the given document is activated */
void slotActivateDocument(const App::Document& Doc);
/** The property of an observed document has changed */
void slotBeforeChangeDocument(const App::Document& Obj, const App::Property& Prop);
/** The property of an observed document has changed */
void slotChangedDocument(const App::Document& Obj, const App::Property& Prop);
/** Checks if a new object was added. */
void slotCreatedObject(const App::DocumentObject& Obj);
/** Checks if the given object is about to be removed. */
void slotDeletedObject(const App::DocumentObject& Obj);
/** The property of an observed object has changed */
void slotBeforeChangeObject(const App::DocumentObject& Obj, const App::Property& Prop);
/** The property of an observed object has changed */
void slotChangedObject(const App::DocumentObject& Obj, const App::Property& Prop);
/** Undoes the last transaction of the document */
void slotUndoDocument(const App::Document& Doc);
/** Redoes the last undone transaction of the document */
void slotRedoDocument(const App::Document& Doc);
/** Called when a given object is recomputed */
void slotRecomputedObject(const App::DocumentObject& Obj);
/** Called before an observed document is recomputed */
void slotBeforeRecomputeDocument(const App::Document& Doc);
/** Called when an observed document is recomputed */
void slotRecomputedDocument(const App::Document& Doc);
/** Called when an observed document opens a transaction */
void slotOpenTransaction(const App::Document& Doc, std::string str);
/** Called when an observed document commits a transaction */
void slotCommitTransaction(const App::Document& Doc);
/** Called when an observed document aborts a transaction */
void slotAbortTransaction(const App::Document& Doc);
/** Called after application wide undo */
void slotUndo();
/** Called after application wide redo */
void slotRedo();
/** Called before closing/aborting application active transaction */
void slotBeforeCloseTransaction(bool abort);
/** Called after closing/aborting application active transaction */
void slotCloseTransaction(bool abort);
/** Called when an object gets a new dynamic property added*/
void slotAppendDynamicProperty(const App::Property& Prop);
/** Called when an object gets a dynamic property removed*/
void slotRemoveDynamicProperty(const App::Property& Prop);
/** Called when an object property gets a new editor relevant status like hidden or read only*/
void slotChangePropertyEditor(const App::Document& Doc, const App::Property& Prop);
/** Called when a document is about to be saved*/
void slotStartSaveDocument(const App::Document&, const std::string&);
/** Called when an document has been saved*/
void slotFinishSaveDocument(const App::Document&, const std::string&);
/** Called before an object gets a new extension added*/
void slotBeforeAddingDynamicExtension(const App::ExtensionContainer&, std::string extension);
/** Called when an object gets a dynamic extension added*/
void slotAddedDynamicExtension(const App::ExtensionContainer&, std::string extension);
private:
Py::Object inst;
static std::vector<DocumentObserverPython*> _instances;
using Connection = struct PythonObject
{
fastsignals::scoped_connection slot;
Py::Object py;
PyObject* ptr()
{
return py.ptr();
}
};
Connection pyCreatedDocument;
Connection pyDeletedDocument;
Connection pyRelabelDocument;
Connection pyActivateDocument;
Connection pyUndoDocument;
Connection pyRedoDocument;
Connection pyBeforeChangeDocument;
Connection pyChangedDocument;
Connection pyCreatedObject;
Connection pyDeletedObject;
Connection pyBeforeChangeObject;
Connection pyChangedObject;
Connection pyRecomputedObject;
Connection pyBeforeRecomputeDocument;
Connection pyRecomputedDocument;
Connection pyOpenTransaction;
Connection pyCommitTransaction;
Connection pyAbortTransaction;
Connection pyUndo;
Connection pyRedo;
Connection pyBeforeCloseTransaction;
Connection pyCloseTransaction;
Connection pyStartSaveDocument;
Connection pyFinishSaveDocument;
Connection pyAppendDynamicProperty;
Connection pyRemoveDynamicProperty;
Connection pyChangePropertyEditor;
Connection pyBeforeAddingDynamicExtension;
Connection pyAddedDynamicExtension;
};
} // namespace App
#endif // APP_DOCUMENTOBSERVERPYTHON_H
|