CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Friends | List of all members
CFxHostAppServices Class Referenceabstract

#include <FxHostAppServices.h>

Inheritance diagram for CFxHostAppServices:
OdDbHostAppServices2 OdDbHostAppServices OdDbBaseHostAppServices OdRxObject

Public Types

enum  InputMode { eAvailableSysVar , eCommandLine }
 
- Public Types inherited from OdDbBaseHostAppServices
enum  RemapFileContext { kDrawingOpen = 0 , kXrefResolution = 1 , kRasterResolution = 2 }
 
enum  FindFileHint {
  kDefault = 0 , kFontFile = 1 , kCompiledShapeFile = 2 , kTrueTypeFontFile = 3 ,
  kEmbeddedImageFile = 4 , kXRefDrawing = 5 , kPatternFile = 6 , kTXApplication = 7 ,
  kFontMapFile = 8 , kUnderlayFile = 9 , kTextureMapFile = 10 , kPhotometricWebFile = 11 ,
  kAssetLibXMLFile = 12
}
 
enum  GsBitmapDeviceFlags { kUseSoftwareHLR = (1 << 0) , kFor2dExportRender = (1 << 1) , kFor2dExportRenderHLR = (1 << 2) , kForThumbnail = (1 << 3) }
 

Public Member Functions

 CFxHostAppServices ()
 
 ~CFxHostAppServices () override
 
bool doFullCRCCheck () override
 
virtual bool getMappedFont (const CFxString &sOriginalFont, CFxString &sMappedFont, bool searchInFontMap=false)=0
 
virtual bool isSysVarAllowed (const CFxString &sysVarName, InputMode mode)=0
 
virtual CFxString getRawName (const CFxString &dsName)=0
 
virtual CFxString getDsName (const CFxString &rawName)=0
 
virtual CFxString translateAlias (const CFxString &aliasName)=0
 
virtual void LoadVariables (CFxSettings *pSettings)=0
 
virtual void SaveVariables (CFxSettings *pSettings)=0
 
virtual void SetVariablesDefault ()=0
 
- Public Member Functions inherited from OdDbHostAppServices
 ODRX_DECLARE_MEMBERS (OdDbHostAppServices)
 
 OdDbHostAppServices ()
 
virtual ~OdDbHostAppServices ()
 
virtual OdString findFile (const OdString &filename, OdDbBaseDatabase *pDb=0, FindFileHint hint=kDefault)
 
virtual OdDbHostAppProgressMeternewProgressMeter ()
 
virtual void releaseProgressMeter (OdDbHostAppProgressMeter *pProgressMeter)
 
virtual OdRxClassdatabaseClass () const
 
virtual OdDbDatabasePtr createDatabase (bool createDefault=true, OdDb::MeasurementValue measurement=OdDb::kEnglish) const
 
virtual OdDbDatabasePtr readFile (OdStreamBuf *pStreamBuf, bool allowCPConversion=false, bool partialLoad=false, const OdPassword &password=OdPassword())
 
virtual OdDbDatabasePtr recoverFile (OdStreamBuf *pStreamBuf, OdDbAuditInfo *pAuditInfo=0, const OdPassword &password=OdPassword())
 
virtual OdDbDatabasePtr readFile (const OdString &filename, bool allowCPConversion=false, bool partialLoad=false, Oda::FileShareMode shareMode=Oda::kShareDenyNo, const OdPassword &password=OdPassword())
 
virtual const OdString program ()
 
virtual const OdString product ()
 
virtual const OdString companyName ()
 
virtual ProdIdCode prodcode ()
 
virtual const OdString releaseMajorMinorString ()
 
virtual int releaseMajorVersion ()
 
virtual int releaseMinorVersion ()
 
virtual const OdString versionString ()
 
 TD_USING (OdDbBaseHostAppServices::warning)
 
virtual void warning (OdWarning warningOb, OdDbObjectId objectId)
 
virtual void warning (const char *warnVisGroup, OdWarning warningOb, OdDbObjectId objectId)
 
virtual void warning (const OdError &err)
 
virtual void warning (const char *warnVisGroup, const OdError &err)
 
virtual OdString getErrorDescription (unsigned int errorCode)
 
virtual OdString formatMessage (unsigned int errorCode,...)
 
virtual bool doFullCRCCheck ()
 
virtual OdDbUndoControllerPtr newUndoController ()
 
virtual void auditPrintReport (OdAuditInfo *pAuditInfo, const OdString &strLine, int printDest) const
 
virtual OdDbPlotSettingsValidatorplotSettingsValidator ()
 
virtual OdString getAlternateFontName () const
 
virtual OdString getFontMapFileName () const
 
virtual OdString getPreferableFont (const OdString &fontName, OdFontType fontType)
 
virtual OdString getSubstituteFont (const OdString &fontName, OdFontType fontType)
 
virtual OdString getSubstituteFontByChar (const OdFont &pFont, OdChar unicodeChar, OdDbBaseDatabase *pDb)
 
virtual bool getSystemFontFolders (OdStringArray &aDirs)
 
virtual void collectFilePathsInDirectory (OdStringArray &res, const OdString &sPath, const OdString &sFilter=L"*.*")
 
virtual OdHatchPatternManagerpatternManager ()=0
 
virtual bool getPassword (const OdString &dwgName, bool isXref, OdPassword &password)
 
virtual OdPwdCachePtr getPasswordCache ()
 
virtual OdDbPageControllerPtr newPageController ()
 
virtual OdString fileDialog (int flags, const OdString &dialogCaption=OdString::kEmpty, const OdString &defExt=OdString::kEmpty, const OdString &defFilename=OdString::kEmpty, const OdString &filter=OdString::kEmpty)
 
virtual OdDbLayoutManagerPtr layoutManager () const
 
virtual OdUInt32 educationalPlotStamp () const
 
virtual OdDbBaseHostAppServicesgetDgnHostAppServices () const
 
virtual void getThumbSize (unsigned int &nWidth, unsigned int &nHeight)
 
virtual OdGsDevicePtr gsBitmapDevice (OdRxObject *pViewObj=NULL, OdDbBaseDatabase *pDb=NULL, OdUInt32 flags=0)
 
virtual OdStreamBufPtr getHistoryFile (OdDbDatabase *)
 
virtual OdResult brepBuilder (OdBrepBuilder &brepBuilder, BrepType bbType)
 
virtual OdString fixName (const OdDbSymbolTableRecord *pRecord)
 
virtual OdDbKey * key () const =0
 
- Public Member Functions inherited from OdDbBaseHostAppServices
 ODRX_DECLARE_MEMBERS (OdDbBaseHostAppServices)
 
 OdDbBaseHostAppServices ()
 
virtual OdString findFile (const OdString &filename, OdDbBaseDatabase *pDb=0, FindFileHint hint=kDefault)=0
 
virtual OdDbHostAppProgressMeternewProgressMeter ()
 
virtual void releaseProgressMeter (OdDbHostAppProgressMeter *pProgressMeter)
 
virtual const OdString program ()=0
 
virtual const OdString product ()=0
 
virtual const OdString companyName ()=0
 
virtual ProdIdCode prodcode ()
 
virtual const OdString releaseMajorMinorString ()
 
virtual int releaseMajorVersion ()
 
virtual int releaseMinorVersion ()
 
virtual const OdString versionString ()
 
virtual void warning (const OdString &message)
 
virtual void warning (const char *warnVisGroup, const OdString &message)
 
virtual void warning (OdWarning warningOb)
 
virtual void warning (const char *warnVisGroup, OdWarning warningOb)
 
virtual OdString getErrorDescription (unsigned int errorCode)
 
virtual OdString formatMessage (unsigned int errorCode,...)
 
virtual OdDbUndoControllerPtr newUndoController ()
 
virtual OdStreamBufPtr newUndoStream ()
 
virtual void auditPrintReport (OdAuditInfo *pAuditInfo, const OdString &strLine, int printDest) const
 
virtual bool ttfFileNameByDescriptor (const OdTtfDescriptor &description, OdString &filename)
 
virtual OdString getAlternateFontName () const =0
 
virtual OdString getFontMapFileName () const =0
 
virtual OdString getPreferableFont (const OdString &fontName, OdFontType fontType)=0
 
virtual OdString getSubstituteFont (const OdString &fontName, OdFontType fontType)=0
 
virtual OdString getSubstituteFontByChar (const OdFont &pFont, OdChar unicodeChar, OdDbBaseDatabase *pDb)
 
virtual bool getSystemFontFolders (OdStringArray &aDirs)
 
virtual void collectFilePathsInDirectory (OdStringArray &res, const OdString &sPath, const OdString &sFilter=L"*.*")
 
virtual OdString fileDialog (int flags, const OdString &dialogCaption=OdString::kEmpty, const OdString &defExt=OdString::kEmpty, const OdString &defFilename=OdString::kEmpty, const OdString &filter=OdString::kEmpty)
 
virtual OdGsDevicePtr gsBitmapDevice (OdRxObject *pViewObj=NULL, OdDbBaseDatabase *pDb=NULL, OdUInt32 flags=0)
 
virtual OdString getTempPath () const
 
virtual OdInt16 getMtMode () const
 
virtual int numThreads (OdDb::MultiThreadedMode mtMode)
 
virtual OdResult brepBuilder (OdBrepBuilder &bbuilder, BrepType bbType)
 
virtual OdResult getEnv (const OdString &varName, OdString &value)
 
virtual OdResult setEnv (const OdString &varName, const OdString &newValue)
 
virtual OdString getAppUserName (Oda::UserNameFormat unFormat=Oda::kUserId)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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
 

Friends

class CFxDatabaseImpl
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Attributes inherited from OdDbHostAppServices2
OdMutex m_KeyMutex
 
- Protected Attributes inherited from OdDbHostAppServices
OdMutex m_LayoutManagerMutex
 
OdMutex m_ValidatorMutex
 
OdMutex m_PwdCacheMutex
 
OdDbLayoutManagerPtr m_pLayoutManager
 
OdDbPlotSettingsValidatorPtr m_pValidator
 
OdPwdCachePtr m_pPwdCache
 

Detailed Description

Description: Represents the implementation for OdDbHostAppServices. Library: DDKERNEL

Definition at line 33 of file FxHostAppServices.h.

Member Enumeration Documentation

◆ InputMode

Description: Values that represent InputMode.

Enumerator
eAvailableSysVar 
eCommandLine 

Definition at line 72 of file FxHostAppServices.h.

Constructor & Destructor Documentation

◆ CFxHostAppServices()

CFxHostAppServices::CFxHostAppServices ( )

Constructor.

◆ ~CFxHostAppServices()

CFxHostAppServices::~CFxHostAppServices ( )
override

Destructor.

Member Function Documentation

◆ doFullCRCCheck()

bool CFxHostAppServices::doFullCRCCheck ( )
inlineoverridevirtual

Description: Returns true if and only if DWGdirect is to do full-time CRC checking on database filing operations.

Reimplemented from OdDbHostAppServices.

Definition at line 47 of file FxHostAppServices.h.

◆ getDsName()

virtual CFxString CFxHostAppServices::getDsName ( const CFxString rawName)
pure virtual

Description: Gets the ds name. Arguments:

Parameters
rawNameName of the raw. Return Value: The ds name.

◆ getMappedFont()

virtual bool CFxHostAppServices::getMappedFont ( const CFxString sOriginalFont,
CFxString sMappedFont,
bool  searchInFontMap = false 
)
pure virtual

◆ getRawName()

virtual CFxString CFxHostAppServices::getRawName ( const CFxString dsName)
pure virtual

Description: Gets a raw name. Arguments:

Parameters
dsNameName of the ds.

Return Value: The raw name.

◆ isSysVarAllowed()

virtual bool CFxHostAppServices::isSysVarAllowed ( const CFxString sysVarName,
InputMode  mode 
)
pure virtual

Description: Query if 'sysVarName' is system variable allowed. Arguments:

Parameters
sysVarNameName of the system variable.
modeThe mode.

Return Value: true if system variable allowed, false if not.

◆ LoadVariables()

virtual void CFxHostAppServices::LoadVariables ( CFxSettings pSettings)
pure virtual

Description: Loads variables from settings. Read-only variables will use default values. Arguments:

Parameters
pSettingsSettings that contain variable values.

◆ SaveVariables()

virtual void CFxHostAppServices::SaveVariables ( CFxSettings pSettings)
pure virtual

Description: Saves variables to settings. Arguments:

Parameters
pSettingsSettings that will contain variable values.

◆ SetVariablesDefault()

virtual void CFxHostAppServices::SetVariablesDefault ( )
pure virtual

Description: Resets variables to defaults.

◆ translateAlias()

virtual CFxString CFxHostAppServices::translateAlias ( const CFxString aliasName)
pure virtual

Description: Translate alias. Arguments:

Parameters
aliasNameName of the alias.

Return Value: .

Friends And Related Function Documentation

◆ CFxDatabaseImpl

friend class CFxDatabaseImpl
friend

Definition at line 35 of file FxHostAppServices.h.


The documentation for this class was generated from the following file: