App::TransactionDocumentObject Class Reference
Represents an entry for a document object in a transaction. More...
#include <Transactions.h>
Public Member Functions | |
| void | applyDel (Document &Doc, TransactionalObject *pcObj) |
| void | applyNew (Document &Doc, TransactionalObject *pcObj) |
| TransactionDocumentObject () | |
| Construction. More... | |
| virtual | ~TransactionDocumentObject () |
| Destruction. More... | |
 Public Member Functions inherited from App::TransactionObject | |
| void | addOrRemoveProperty (const Property *pcProp, bool add) |
| virtual void | applyChn (Document &Doc, TransactionalObject *pcObj, bool Forward) |
| virtual void | applyDel (Document &Doc, TransactionalObject *pcObj) |
| virtual void | applyNew (Document &Doc, TransactionalObject *pcObj) |
| virtual unsigned int | getMemSize (void) const |
| This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More... | |
| virtual void | Restore (Base::XMLReader &reader) |
| This method is used to restore properties from an XML document. More... | |
| virtual void | Save (Base::Writer &writer) const |
| This method is used to save properties to an XML document. More... | |
| void | setProperty (const Property *pcProp) |
| TransactionObject () | |
| Construction. More... | |
| virtual | ~TransactionObject () |
| Destruction. More... | |
| Public Member Functions inherited from Base::Persistence | |
| void | dumpToStream (std::ostream &stream, int compression) |
| virtual unsigned int | getMemSize () const =0 |
| This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More... | |
| virtual Base::Type | getTypeId (void) const |
| virtual void | Restore (XMLReader &)=0 |
| This method is used to restore properties from an XML document. More... | |
| virtual void | RestoreDocFile (Reader &) |
| This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More... | |
| void | restoreFromStream (std::istream &stream) |
| virtual void | Save (Writer &) const =0 |
| This method is used to save properties to an XML document. More... | |
| virtual void | SaveDocFile (Writer &) const |
| This method is used to save large amounts of data to a binary file. More... | |
| Public Member Functions inherited from Base::BaseClass | |
| BaseClass () | |
| Construction. More... | |
| BaseClass (const BaseClass &)=default | |
| virtual PyObject * | getPyObject () |
| This method returns the Python wrapper for a C++ object. More... | |
| virtual Type | getTypeId () const |
| bool | isDerivedFrom (const Type type) const |
| BaseClass & | operator= (const BaseClass &)=default |
| virtual void | setPyObject (PyObject *) |
| virtual | ~BaseClass () |
| Destruction. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Base::Persistence | |
| static void * | create (void) |
| static std::string | encodeAttribute (const std::string &) |
| Encodes an attribute upon saving. More... | |
| static Base::Type | getClassTypeId (void) |
| static void | init (void) |
| Static Public Member Functions inherited from Base::BaseClass | |
| static void * | create () |
| static Type | getClassTypeId () |
| static void | init () |
| Protected Types inherited from App::TransactionObject | |
| enum | Status { New , Del , Chn } |
| Static Protected Member Functions inherited from Base::BaseClass | |
| static void | initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr) |
| Protected Attributes inherited from App::TransactionObject | |
| enum App::TransactionObject::Status | status |
Detailed Description
Represents an entry for a document object in a transaction.
Constructor & Destructor Documentation
◆ TransactionDocumentObject()
| TransactionDocumentObject::TransactionDocumentObject | ( | ) |
Construction.
A constructor.
A more elaborate description of the constructor.
◆ ~TransactionDocumentObject()
|
virtual |
Destruction.
A destructor.
A more elaborate description of the destructor.
Member Function Documentation
◆ applyDel()
|
virtual |
Reimplemented from App::TransactionObject.
References App::TransactionObject::Del, and App::TransactionObject::status.
◆ applyNew()
|
virtual |
Reimplemented from App::TransactionObject.
References App::TransactionObject::New, and App::TransactionObject::status.
The documentation for this class was generated from the following files:
- FreeCAD/src/App/Transactions.h
- FreeCAD/src/App/Transactions.cpp
