#include <FdField.h>
Public Member Functions | |
| ODRX_DECLARE_MEMBERS (OdFdFieldEnginePE) | |
| virtual bool | getSheetSetProperty (OdString &propValue, const OdString &compName, const OdString &propName, OdDbDatabase *pDb)=0 |
| virtual bool | parseObjProp (const OdString &prop, OdDbDatabase *pDb, OdDbObjectId &objId, OdString &propName)=0 |
| virtual bool | getObjPropValue (const OdString &propName, const OdDbObjectId &objId, OdFdFieldResult &result)=0 |
| virtual OdDbDatabase * | getCurrentDb ()=0 |
| virtual OdString | getFileName (OdDbDatabase *pDb)=0 |
| virtual void | getLispVariable (const OdString &lispVar, OdFieldValue &fValue)=0 |
| virtual OdDbObjectId | getOwnerTable (const OdDbField *field)=0 |
 Public Member Functions inherited from OdRxObject | |
| ODRX_HEAP_OPERATORS () | |
| OdRxObject () | |
| virtual | ~OdRxObject () |
| virtual OdRxObject * | queryX (const OdRxClass *pClass) const |
| virtual OdRxObject * | x (const OdRxClass *pClass) const |
| virtual OdRxClass * | isA () const |
| virtual void | addRef ()=0 |
| virtual void | release ()=0 |
| virtual long | numRefs () const |
| bool | isKindOf (const OdRxClass *pClass) const |
| virtual OdRxObjectPtr | clone () const |
| virtual void | copyFrom (const OdRxObject *pSource) |
| virtual OdRx::Ordering | comparedTo (const OdRxObject *pOther) const |
| virtual bool | isEqualTo (const OdRxObject *pOther) const |
Additional Inherited Members | |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
This abstract class is the Field Engine Protocol Extension class. Its purpose is to provide services necessary for fields evaluation implemented at the host application level. <group Other_Classes>
Member Function Documentation
◆ getCurrentDb()
|
pure virtual |
Retrieves the current database of the host application. The purpose of the function is to allow using the current database's properties when processing NDBRO fields.
Returns pointer to the current OdDbDatabase object.
◆ getFileName()
|
pure virtual |
Returns the name of the file associated with this database object. Differs from the current behavior of OdDbDatabase::getFilename(), which returns autobackup filename, because OdDbDatabase::writeFile() always sets m_currentFileName.
- Parameters
-
pDb [in] database
◆ getLispVariable()
|
pure virtual |
Retrieves value of lisp variable.
- Parameters
-
lispVar [in] lisp variable name fValue [out] field value where the result is stored
◆ getObjPropValue()
|
pure virtual |
Retrieves object property value.
- Parameters
-
propName [in] property name objId [in] object result [out] result
Returns 'true' on success, otherwise returns 'false'.
◆ getOwnerTable()
|
pure virtual |
Returns OdDbTable entity ID which is supposed to be the owner of the field object. Intended to be used during adding or modifying a formula field in one of table cells, while the field can be non-database-resident.
- Parameters
-
field [in] pointer to the field object
◆ getSheetSetProperty()
|
pure virtual |
Retrieves sheet set property value.
- Parameters
-
propValue [out] result property value compName [in] component name propName [in] property name pDb [in] database
Returns 'true' if the property was successfully retrieved to 'propValue', otherwise returns 'false'.
◆ ODRX_DECLARE_MEMBERS()
| OdFdFieldEnginePE::ODRX_DECLARE_MEMBERS | ( | OdFdFieldEnginePE | ) |
◆ parseObjProp()
|
pure virtual |
Parses property string of ObjProp field code retrieving object id and property type.
- Parameters
-
prop [in] property string: "Object(%<\_ObjId XXX>%).PropName" pDb [in] database objId [out] object id propName [out] property name
Returns 'true' on success, otherwise returns 'false'.
The documentation for this class was generated from the following file: