File size: 4,984 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 | // SPDX-License-Identifier: LGPL-2.1-or-later
/***************************************************************************
* Copyright (c) 2016 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 APP_DOCUMENTOBJECTEXTENSION_H
#define APP_DOCUMENTOBJECTEXTENSION_H
#include "Extension.h"
namespace Base
{
class Matrix4D;
}
namespace App
{
class DocumentObject;
class DocumentObjectExecReturn;
/**
* @brief Extension with special document object calls
*
*/
class AppExport DocumentObjectExtension: public App::Extension
{
// The cass does not have properties itself, but it is important to provide the property access
// functions. see cpp file for details
EXTENSION_PROPERTY_HEADER_WITH_OVERRIDE(App::DocumentObjectExtension);
public:
DocumentObjectExtension();
~DocumentObjectExtension() override;
App::DocumentObject* getExtendedObject();
const App::DocumentObject* getExtendedObject() const;
// override if execution is necessary
virtual short extensionMustExecute();
virtual App::DocumentObjectExecReturn* extensionExecute();
/// get called after setting the document
virtual void onExtendedSettingDocument();
/// get called after a document has been fully restored
virtual void onExtendedDocumentRestored();
/// get called after a brand new object was created
virtual void onExtendedSetupObject();
/// get called when object is going to be removed from the document
virtual void onExtendedUnsetupObject();
PyObject* getExtensionPyObject() override;
/// returns the type name of the ViewProviderExtension which is automatically attached
/// to the viewprovider object when it is initiated
virtual const char* getViewProviderExtensionName() const
{
return "";
}
/** Get the sub object by name
* @sa DocumentObject::getSubObject()
*
* @return Return turn if handled, the sub object is returned in \c ret
*/
virtual bool extensionGetSubObject(DocumentObject*& ret,
const char* subname,
PyObject** pyObj,
Base::Matrix4D* mat,
bool transform,
int depth) const;
/** Get name references of all sub objects
* @sa DocumentObject::getSubObjects()
*
* @return Return turn if handled, the sub object is returned in \c ret
*/
virtual bool extensionGetSubObjects(std::vector<std::string>& ret, int reason) const;
/** Get the linked object
* @sa DocumentObject::getLinkedObject()
*
* @return Return turn if handled, the linked object is returned in \c ret
*/
virtual bool extensionGetLinkedObject(DocumentObject*& ret,
bool recursive,
Base::Matrix4D* mat,
bool transform,
int depth) const;
virtual int extensionSetElementVisible(const char*, bool)
{
return -1;
}
virtual int extensionIsElementVisible(const char*)
{
return -1;
}
virtual bool extensionHasChildElement() const
{
return false;
}
};
} // namespace App
#endif // APP_DOCUMENTOBJECTEXTENSION_H
|