FRX SDK Documentation 2025 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
AcDbField Class Reference

#include <AcDbField.h>

Inheritance diagram for AcDbField:
AcDbObject AcGiDrawable AcRxObject AcRTTIObject AcObject

Public Types

enum  EvalOption {
  kDisable = 0 , kOnOpen = 0x01 , kOnSave = 0x02 , kOnPlot = 0x04 ,
  kOnEtransmit = 0x08 , kOnRegen = 0x10 , kOnDemand = 0x20 , kAutomatic = ( kOnOpen | kOnSave | kOnPlot | kOnEtransmit | kOnRegen | kOnDemand )
}
 
enum  EvalStatus {
  kNotYetEvaluated = 0x01 , kSuccess = 0x02 , kEvaluatorNotFound = 0x04 , kSyntaxError = 0x08 ,
  kInvalidCode = 0x10 , kInvalidContext = 0x20 , kOtherError = 0x40
}
 
enum  EvalContext {
  kOpen = 0x01 , kSave = 0x02 , kPlot = 0x04 , kEtransmit = 0x08 ,
  kRegen = 0x10 , kDemand = 0x20 , kPreview = 0x40
}
 
enum  FieldCodeFlag {
  kRawCode = 0x00 , kFieldCode = 0x01 , kEvaluatedText = 0x02 , kEvaluatedChildren = 0x04 ,
  kObjectReference = 0x08 , kAddMarkers = 0x10 , kEscapeBackslash = 0x20 , kStripOptions = 0x40 ,
  kPreserveFields = 0x80 , kTextField = 0x100 , kPreserveOptions = 0x200 , kDetachChildren = 0x400 ,
  kChildObjectReference = 0x800 , kForExpression = 0x1000
}
 
enum  FilingOption { kSkipFilingResult = 0x01 }
 
enum  State {
  kInitialized = 0x01 , kCompiled = 0x02 , kModified = 0x04 , kEvaluated = 0x08 ,
  kHasCache = 0x10 , kHasFormattedString = 0x20
}
 
- Public Types inherited from AcGiDrawable
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground
}
 
enum  SetAttributesFlags {
  kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 ,
  kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependentGeometry = 64 ,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableViewDependentViewportDraw = 2048
}
 

Public Member Functions

 AcDbField (void)
 
 AcDbField (wchar_t const *, bool=false)
 
bool hasHyperlink (void) const
 
bool isTextField (void) const
 
EvalOption evaluationOption (void) const
 
EvalStatus evaluationStatus (int *=nullptr, wchar_t **=nullptr) const
 
FilingOption filingOption (void) const
 
State state (void) const
 
AcValue::DataType dataType (void) const
 
Acad::ErrorStatus convertToTextField (void)
 
Acad::ErrorStatus evaluate (int, AcDbDatabase *, int *=NULL, int *=NULL)
 
Acad::ErrorStatus getChild (int, AcDbField *&, AcDb::OpenMode)
 
Acad::ErrorStatus getData (wchar_t const *, AcValue *) const
 
Acad::ErrorStatus getFieldCode (wchar_t *&, FieldCodeFlag, AcArray< AcDbField *, AcArrayMemCopyReallocator< AcDbField * > > *=0, AcDb::OpenMode=AcDb::kForRead) const
 
Acad::ErrorStatus getFormat (wchar_t *&) const
 
Acad::ErrorStatus getHyperlink (AcHyperlink &) const
 
Acad::ErrorStatus getHyperlink (wchar_t **, wchar_t **, wchar_t **, wchar_t **, long *) const
 
Acad::ErrorStatus getValue (AcFdFieldValue &) const
 
Acad::ErrorStatus getValue (AcValue &) const
 
Acad::ErrorStatus getValue (wchar_t *&) const
 
Acad::ErrorStatus postInDatabase (AcDbDatabase *)
 
Acad::ErrorStatus removeHyperlink (void)
 
Acad::ErrorStatus setData (wchar_t const *, AcValue const *)
 
Acad::ErrorStatus setData (wchar_t const *, AcValue const *, bool)
 
Acad::ErrorStatus setEvaluationOption (EvalOption)
 
Acad::ErrorStatus setEvaluatorId (wchar_t const *)
 
Acad::ErrorStatus setFieldCode (wchar_t const *, AcDbField::FieldCodeFlag=(AcDbField::FieldCodeFlag) 0, AcArray< AcDbField *, AcArrayMemCopyReallocator< AcDbField * > > *=0)
 
Acad::ErrorStatus setFilingOption (FilingOption)
 
Acad::ErrorStatus setFormat (wchar_t const *)
 
Acad::ErrorStatus setHyperlink (AcHyperlink const &)
 
Acad::ErrorStatus setHyperlink (wchar_t const *, wchar_t const *, wchar_t const *)
 
Acad::ErrorStatus setHyperlink (wchar_t const *, wchar_t const *, wchar_t const *, long)
 
Acad::ErrorStatus setInObject (AcDbObject *, wchar_t const *)
 
virtual Acad::ErrorStatus subClose (void)
 
int childCount (void) const
 
virtual ~AcDbField (void)
 
virtual Acad::ErrorStatus dwgInFields (AcDbDwgFiler *)
 
virtual Acad::ErrorStatus dwgOutFields (AcDbDwgFiler *) const
 
virtual Acad::ErrorStatus dxfInFields (AcDbDxfFiler *)
 
virtual Acad::ErrorStatus dxfOutFields (AcDbDxfFiler *) const
 
wchar_t const * evaluatorId (void) const
 
wchar_t const * getFieldCode (FieldCodeFlag, AcArray< AcDbField *, AcArrayMemCopyReallocator< AcDbField * > > *=0, AcDb::OpenMode=AcDb::kForRead) const
 
wchar_t const * getFormat (void) const
 
wchar_t const * getValue (void) const
 
- Public Member Functions inherited from AcDbObject
 ACRX_DECLARE_MEMBERS (AcDbObject)
 
bool hasFields (void) const
 
bool hasPersistentReactor (AcDbObjectId) const
 
bool hasSaveVersionOverride (void)
 
bool isUndoRecordingDisabled (void) const
 
AcDbVoidPtrArray const * reactors (void) const
 
AcDbDatabase * database (void) const
 
AcDbDwgFiler * undoFiler (void)
 
AcDbObjectId extensionDictionary (void) const
 
AcDbObjectId getFieldDictionary (void) const
 
AcDbObjectId objectId (void) const
 
AcDbObjectId ownerId (void) const
 
Acad::ErrorStatus cancel (void)
 
Acad::ErrorStatus close (void)
 
Acad::ErrorStatus closeAndPage (int=0)
 
Acad::ErrorStatus createExtensionDictionary (void)
 
Acad::ErrorStatus downgradeOpen (void)
 
Acad::ErrorStatus downgradeToNotify (Adesk::Boolean)
 
Acad::ErrorStatus dwgIn (AcDbDwgFiler *)
 
Acad::ErrorStatus dwgOut (AcDbDwgFiler *) const
 
Acad::ErrorStatus dxfIn (AcDbDxfFiler *)
 
Acad::ErrorStatus dxfOut (AcDbDxfFiler *, Adesk::Boolean, unsigned char *) const
 
Acad::ErrorStatus erase (Adesk::Boolean=true)
 
Acad::ErrorStatus getBinaryData (wchar_t const *, long &, char *&) const
 
Acad::ErrorStatus getField (wchar_t const *, AcDbField *&, AcDb::OpenMode) const
 
Acad::ErrorStatus getField (wchar_t const *, AcDbObjectId &) const
 
Acad::ErrorStatus getFieldDictionary (AcDbDictionary *&, AcDb::OpenMode) const
 
Acad::ErrorStatus getObjectBirthVersion (AcDb::AcDbDwgVersion &, AcDb::MaintenanceReleaseVersion &)
 
Acad::ErrorStatus handOverTo (AcDbObject *, Adesk::Boolean=1, Adesk::Boolean=1)
 
Acad::ErrorStatus releaseExtensionDictionary (void)
 
Acad::ErrorStatus setBinaryData (wchar_t const *, long, char const *)
 
Acad::ErrorStatus swapIdWith (AcDbObjectId, Adesk::Boolean=0, Adesk::Boolean=0)
 
Acad::ErrorStatus upgradeFromNotify (Adesk::Boolean &)
 
Acad::ErrorStatus upgradeOpen (void)
 
Acad::ErrorStatus xDataTransformBy (AcGeMatrix3d const &)
 
Adesk::Boolean isAProxy (void) const
 
Adesk::Boolean isAcDbObjectIdsInFlux (void) const
 
Adesk::Boolean isCancelling (void) const
 
Adesk::Boolean isEraseStatusToggled (void) const
 
Adesk::Boolean isErased (void) const
 
Adesk::Boolean isModified (void) const
 
Adesk::Boolean isModifiedGraphics (void) const
 
Adesk::Boolean isModifiedXData (void) const
 
Adesk::Boolean isNewObject (void) const
 
Adesk::Boolean isNotifyEnabled (void) const
 
Adesk::Boolean isNotifying (void) const
 
Adesk::Boolean isReadEnabled (void) const
 
Adesk::Boolean isReallyClosing (void) const
 
Adesk::Boolean isTransactionResident (void) const
 
Adesk::Boolean isUndoing (void) const
 
Adesk::Boolean isWriteEnabled (void) const
 
virtual ~AcDbObject (void)
 
virtual AcDbObjectId id (void) const
 
virtual AcGiDrawable * drawable (void)
 
virtual AcGsNode * gsNode (void) const
 
virtual AcRxObject * clone (void) const
 
virtual AcDb::DuplicateRecordCloning mergeStyle (void) const
 
virtual Acad::ErrorStatus applyPartialUndo (AcDbDwgFiler *, AcRxClass *)
 
virtual Acad::ErrorStatus audit (AcDbAuditInfo *)
 
virtual Acad::ErrorStatus copyFrom (AcRxObject const *)
 
virtual Acad::ErrorStatus decomposeForSave (AcDb::AcDbDwgVersion, AcDbObject *&, AcDbObjectId &, int &)
 
virtual Acad::ErrorStatus deepClone (AcDbObject *, AcDbObject *&, AcDbIdMapping &, Adesk::Boolean=1) const
 
virtual Acad::ErrorStatus getClassID (_GUID *) const
 
virtual Acad::ErrorStatus getObjectSaveVersion (AcDbDwgFiler const *, AcDb::AcDbDwgVersion &, AcDb::MaintenanceReleaseVersion &)
 
virtual Acad::ErrorStatus getObjectSaveVersion (AcDbDxfFiler const *, AcDb::AcDbDwgVersion &, AcDb::MaintenanceReleaseVersion &)
 
virtual Acad::ErrorStatus removeField (AcDbObjectId)
 
virtual Acad::ErrorStatus removeField (wchar_t const *)
 
virtual Acad::ErrorStatus removeField (wchar_t const *, AcDbObjectId &)
 
virtual Acad::ErrorStatus removePersistentReactor (AcDbObjectId)
 
virtual Acad::ErrorStatus setField (wchar_t const *, AcDbField *, AcDbObjectId &)
 
virtual Acad::ErrorStatus setOwnerId (AcDbObjectId)
 
virtual Acad::ErrorStatus setXData (resbuf const *)
 
virtual Acad::ErrorStatus subCancel (void)
 
virtual Acad::ErrorStatus subErase (Adesk::Boolean)
 
virtual Acad::ErrorStatus subHandOverTo (AcDbObject *)
 
virtual Acad::ErrorStatus subOpen (AcDb::OpenMode)
 
virtual Acad::ErrorStatus subSwapIdWith (AcDbObjectId, Adesk::Boolean=0, Adesk::Boolean=0)
 
virtual Acad::ErrorStatus swapReferences (AcDbIdMapping const &)
 
virtual Acad::ErrorStatus wblockClone (AcRxObject *, AcDbObject *&, AcDbIdMapping &, Adesk::Boolean=1) const
 
virtual Adesk::UInt32 subSetAttributes (AcGiDrawableTraits *pTraits)
 
virtual void subViewportDraw (AcGiViewportDraw *)
 
virtual Adesk::Boolean isPersistent (void) const
 
virtual Adesk::Boolean worldDraw (AcGiWorldDraw *)
 
virtual resbuf * xData (wchar_t const *=NULL) const
 
virtual unsigned long setAttributes (AcGiDrawableTraits *)
 
virtual void addPersistentReactor (AcDbObjectId)
 
virtual void cancelled (AcDbObject const *)
 
virtual void copied (AcDbObject const *, AcDbObject const *)
 
virtual void erased (AcDbObject const *, Adesk::Boolean)
 
virtual void goodbye (AcDbObject const *)
 
virtual void modified (AcDbObject const *)
 
virtual void modifiedGraphics (AcDbEntity const *)
 
virtual void modifiedXData (AcDbObject const *)
 
virtual void modifyUndone (AcDbObject const *)
 
virtual void objectClosed (AcDbObjectId const)
 
virtual void openedForModify (AcDbObject const *)
 
virtual void reappended (AcDbObject const *)
 
virtual void recvPropagateModify (AcDbObject const *)
 
virtual void setGsNode (AcGsNode *)
 
virtual void subObjModified (AcDbObject const *, AcDbObject const *)
 
virtual void unappended (AcDbObject const *)
 
virtual void viewportDraw (AcGiViewportDraw *)
 
virtual void xmitPropagateModify (void) const
 
void addReactor (AcDbObjectReactor *) const
 
void assertNotifyEnabled (void) const
 
void assertReadEnabled (void) const
 
void assertWriteEnabled (Adesk::Boolean=1, Adesk::Boolean=1)
 
void disableUndoRecording (Adesk::Boolean)
 
void getAcDbHandle (AcDbHandle &) const
 
void removeReactor (AcDbObjectReactor *) const
 
void setAcDbObjectIdsInFlux (void)
 
void setHasSaveVersionOverride (bool)
 
virtual Adesk::Boolean subWorldDraw (AcGiWorldDraw *)
 
virtual Acad::ErrorStatus subDeepClone (AcDbObject *, AcDbObject *&, AcDbIdMapping &, Adesk::Boolean=1) const
 
virtual Acad::ErrorStatus subWblockClone (AcRxObject *, AcDbObject *&, AcDbIdMapping &, Adesk::Boolean=1) const
 
virtual Acad::ErrorStatus subGetClassID (_GUID *) const
 
- Public Member Functions inherited from AcGiDrawable
 ACRX_DECLARE_MEMBERS (AcGiDrawable)
 
virtual Adesk::UInt32 subViewportDrawLogicalFlags (AcGiViewportDraw *)
 
virtual bool bounds (AcDbExtents &) const
 
virtual unsigned long viewportDrawLogicalFlags (AcGiViewportDraw *)
 
virtual void setDrawStream (AcGiDrawStream *)
 
virtual AcGiDrawStream * drawStream (void) const
 
virtual ~AcGiDrawable (void)
 
- Public Member Functions inherited from AcRxObject
virtual AcRxObject * queryX (AcRxClass const *) const
 
AcRxObject * x (AcRxClass const *) const
 
virtual AcRxClass * isA (void) const
 
virtual AcRx::Ordering comparedTo (AcRxObject const *) const
 
virtual int isEqualTo (AcRxObject const *) const
 
bool isKindOf (const AcRxClass *pOtherClass) const
 
virtual ~AcRxObject (void)
 
- Public Member Functions inherited from AcRTTIObject
 AcRTTIObject ()
 
virtual ~AcRTTIObject ()
 
- Public Member Functions inherited from AcObject
 AcObject ()
 
 AcObject (const AcObject &source)
 
virtual ~AcObject ()
 
void * data () const
 

Protected Member Functions

 AcDbField (AcDbSystemInternals *)
 
- Protected Member Functions inherited from AcDbObject
 AcDbObject (AcDbSystemInternals *)
 
 AcDbObject (void)
 
- Protected Member Functions inherited from AcRxObject
 AcRxObject (void)
 
virtual AcRxObject * subQueryX (AcRxClass const *) const
 

Additional Inherited Members

- Static Public Member Functions inherited from AcRxObject
static AcRxClass *__cdecl desc (void)
 
static AcRxObject *__cdecl cast (AcRxObject const *)
 
- Protected Attributes inherited from AcDbObject
AcDbObjectImpl * m_pImpl
 
- Protected Attributes inherited from AcObject
void * m_pData
 

Detailed Description

Definition at line 35 of file AcDbField.h.

Member Enumeration Documentation

◆ EvalContext

enum AcDbField::EvalContext
Enumerator
kOpen 
kSave 
kPlot 
kEtransmit 
kRegen 
kDemand 
kPreview 

Definition at line 59 of file AcDbField.h.

◆ EvalOption

enum AcDbField::EvalOption
Enumerator
kDisable 
kOnOpen 
kOnSave 
kOnPlot 
kOnEtransmit 
kOnRegen 
kOnDemand 
kAutomatic 

Definition at line 38 of file AcDbField.h.

◆ EvalStatus

enum AcDbField::EvalStatus
Enumerator
kNotYetEvaluated 
kSuccess 
kEvaluatorNotFound 
kSyntaxError 
kInvalidCode 
kInvalidContext 
kOtherError 

Definition at line 49 of file AcDbField.h.

◆ FieldCodeFlag

enum AcDbField::FieldCodeFlag
Enumerator
kRawCode 
kFieldCode 
kEvaluatedText 
kEvaluatedChildren 
kObjectReference 
kAddMarkers 
kEscapeBackslash 
kStripOptions 
kPreserveFields 
kTextField 
kPreserveOptions 
kDetachChildren 
kChildObjectReference 
kForExpression 

Definition at line 69 of file AcDbField.h.

◆ FilingOption

enum AcDbField::FilingOption
Enumerator
kSkipFilingResult 

Definition at line 86 of file AcDbField.h.

◆ State

enum AcDbField::State
Enumerator
kInitialized 
kCompiled 
kModified 
kEvaluated 
kHasCache 
kHasFormattedString 

Definition at line 90 of file AcDbField.h.

Constructor & Destructor Documentation

◆ AcDbField() [1/3]

AcDbField::AcDbField ( void )

◆ AcDbField() [2/3]

AcDbField::AcDbField ( wchar_t const * ,
bool = false )

◆ ~AcDbField()

virtual AcDbField::~AcDbField ( void )
virtual

◆ AcDbField() [3/3]

AcDbField::AcDbField ( AcDbSystemInternals * )
protected

Member Function Documentation

◆ childCount()

int AcDbField::childCount ( void ) const

◆ convertToTextField()

Acad::ErrorStatus AcDbField::convertToTextField ( void )

◆ dataType()

AcValue::DataType AcDbField::dataType ( void ) const

◆ dwgInFields()

virtual Acad::ErrorStatus AcDbField::dwgInFields ( AcDbDwgFiler * )
virtual

Reimplemented from AcDbObject.

◆ dwgOutFields()

virtual Acad::ErrorStatus AcDbField::dwgOutFields ( AcDbDwgFiler * ) const
virtual

Reimplemented from AcDbObject.

◆ dxfInFields()

virtual Acad::ErrorStatus AcDbField::dxfInFields ( AcDbDxfFiler * )
virtual

Reimplemented from AcDbObject.

◆ dxfOutFields()

virtual Acad::ErrorStatus AcDbField::dxfOutFields ( AcDbDxfFiler * ) const
virtual

Reimplemented from AcDbObject.

◆ evaluate()

Acad::ErrorStatus AcDbField::evaluate ( int ,
AcDbDatabase * ,
int * = NULL,
int * = NULL )

◆ evaluationOption()

EvalOption AcDbField::evaluationOption ( void ) const

◆ evaluationStatus()

EvalStatus AcDbField::evaluationStatus ( int * = nullptr,
wchar_t ** = nullptr ) const

◆ evaluatorId()

wchar_t const * AcDbField::evaluatorId ( void ) const

◆ filingOption()

FilingOption AcDbField::filingOption ( void ) const

◆ getChild()

Acad::ErrorStatus AcDbField::getChild ( int ,
AcDbField *& ,
AcDb::OpenMode  )

◆ getData()

Acad::ErrorStatus AcDbField::getData ( wchar_t const * ,
AcValue *  ) const

◆ getFieldCode() [1/2]

wchar_t const * AcDbField::getFieldCode ( FieldCodeFlag ,
AcArray< AcDbField *, AcArrayMemCopyReallocator< AcDbField * > > * = 0,
AcDb::OpenMode = AcDb::kForRead ) const

◆ getFieldCode() [2/2]

Acad::ErrorStatus AcDbField::getFieldCode ( wchar_t *& ,
FieldCodeFlag ,
AcArray< AcDbField *, AcArrayMemCopyReallocator< AcDbField * > > * = 0,
AcDb::OpenMode = AcDb::kForRead ) const

◆ getFormat() [1/2]

wchar_t const * AcDbField::getFormat ( void ) const

◆ getFormat() [2/2]

Acad::ErrorStatus AcDbField::getFormat ( wchar_t *& ) const

◆ getHyperlink() [1/2]

Acad::ErrorStatus AcDbField::getHyperlink ( AcHyperlink & ) const

◆ getHyperlink() [2/2]

Acad::ErrorStatus AcDbField::getHyperlink ( wchar_t ** ,
wchar_t ** ,
wchar_t ** ,
wchar_t ** ,
long *  ) const

◆ getValue() [1/4]

Acad::ErrorStatus AcDbField::getValue ( AcFdFieldValue & ) const

◆ getValue() [2/4]

Acad::ErrorStatus AcDbField::getValue ( AcValue & ) const

◆ getValue() [3/4]

wchar_t const * AcDbField::getValue ( void ) const

◆ getValue() [4/4]

Acad::ErrorStatus AcDbField::getValue ( wchar_t *& ) const

◆ hasHyperlink()

bool AcDbField::hasHyperlink ( void ) const

◆ isTextField()

bool AcDbField::isTextField ( void ) const

◆ postInDatabase()

Acad::ErrorStatus AcDbField::postInDatabase ( AcDbDatabase * )

◆ removeHyperlink()

Acad::ErrorStatus AcDbField::removeHyperlink ( void )

◆ setData() [1/2]

Acad::ErrorStatus AcDbField::setData ( wchar_t const * ,
AcValue const *  )

◆ setData() [2/2]

Acad::ErrorStatus AcDbField::setData ( wchar_t const * ,
AcValue const * ,
bool  )

◆ setEvaluationOption()

Acad::ErrorStatus AcDbField::setEvaluationOption ( EvalOption )

◆ setEvaluatorId()

Acad::ErrorStatus AcDbField::setEvaluatorId ( wchar_t const * )

◆ setFieldCode()

Acad::ErrorStatus AcDbField::setFieldCode ( wchar_t const * ,
AcDbField::FieldCodeFlag = (AcDbField::FieldCodeFlag) 0,
AcArray< AcDbField *, AcArrayMemCopyReallocator< AcDbField * > > * = 0 )

◆ setFilingOption()

Acad::ErrorStatus AcDbField::setFilingOption ( FilingOption )

◆ setFormat()

Acad::ErrorStatus AcDbField::setFormat ( wchar_t const * )

◆ setHyperlink() [1/3]

Acad::ErrorStatus AcDbField::setHyperlink ( AcHyperlink const & )

◆ setHyperlink() [2/3]

Acad::ErrorStatus AcDbField::setHyperlink ( wchar_t const * ,
wchar_t const * ,
wchar_t const *  )

◆ setHyperlink() [3/3]

Acad::ErrorStatus AcDbField::setHyperlink ( wchar_t const * ,
wchar_t const * ,
wchar_t const * ,
long  )

◆ setInObject()

Acad::ErrorStatus AcDbField::setInObject ( AcDbObject * ,
wchar_t const *  )

◆ state()

State AcDbField::state ( void ) const

◆ subClose()

virtual Acad::ErrorStatus AcDbField::subClose ( void )
virtual

Reimplemented from AcDbObject.

The documentation for this class was generated from the following file:
Generated on Mon Mar 4 2024 12:50:15