AcDbField.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#include "..\acdb17\AcDbObject.h"
#include "..\acdb17\AcDb.h"
#include "..\acdb17\AcValue.h"
#include "..\acad\Acad.h"
 
template < typename Param1 > class AcArrayMemCopyReallocator;
class AcDbDatabase;
class AcDbDwgFiler;
class AcDbDxfFiler;
class AcDbObject;
class AcDbSystemInternals;
class AcFdFieldValue;
class AcRxClass;
class AcValue;
struct AcHyperlink;
 
class ARX_API AcDbField : public AcDbObject
{
public:
        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:
         ACRX_DECLARE_MEMBERS(AcDbField)
 
public:
          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 ;
 
protected:
          AcDbField( AcDbSystemInternals *);
 
};