CFx SDK Documentation  2020SP3
Public Member Functions | Protected Attributes | List of all members
OdDbHostAppServices Class Referenceabstract

#include <DbHostAppServices.h>

Inheritance diagram for OdDbHostAppServices:
OdDbBaseHostAppServices OdRxObject OdDbHostAppServices2 CFxHostAppServices

Public Member Functions

 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 OdResult pageObjects (OdDbDatabase *pDb)
 
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 OdString getTempPath () const
 
virtual OdStreamBufPtr getHistoryFile (OdDbDatabase *)
 
virtual OdResult brepBuilder (OdBrepBuilder &brepBuilder, BrepType bbType)
 
virtual OdDbKey * key () const =0
 
- Public Member Functions inherited from OdDbBaseHostAppServices
 ODRX_DECLARE_MEMBERS (OdDbBaseHostAppServices)
 
 OdDbBaseHostAppServices ()
 
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 OdStreamBufPtr newUndoStream ()
 
virtual bool ttfFileNameByDescriptor (const OdTtfDescriptor &description, OdString &filename)
 
virtual OdInt16 getMtMode () const
 
virtual int numThreads (OdDb::MultiThreadedMode mtMode)
 
- 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
 

Protected Attributes

OdMutex m_LayoutManagerMutex
 
OdMutex m_ValidatorMutex
 
OdMutex m_PwdCacheMutex
 
OdDbLayoutManagerPtr m_pLayoutManager
 
OdDbPlotSettingsValidatorPtr m_pValidator
 
OdPwdCachePtr m_pPwdCache
 

Additional Inherited Members

- 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
}
 
enum  GsBitmapDeviceFlags { kUseSoftwareHLR = (1 << 0), kFor2dExportRender = (1 << 1), kFor2dExportRenderHLR = (1 << 2), kForThumbnail = (1 << 3) }
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class is the base class for platform specific operations within Teigha.

Corresponding C++ library: TD_Db

<group OdDb_Classes> {noAutoLink}

Definition at line 64 of file DbHostAppServices.h.

Constructor & Destructor Documentation

◆ OdDbHostAppServices()

OdDbHostAppServices::OdDbHostAppServices ( )

◆ ~OdDbHostAppServices()

virtual OdDbHostAppServices::~OdDbHostAppServices ( )
virtual

Member Function Documentation

◆ auditPrintReport()

virtual void OdDbHostAppServices::auditPrintReport ( OdAuditInfo pAuditInfo,
const OdString strLine,
int  printDest 
) const
virtual

Print the audit report for the specified AuditInfo object.

Parameters
pAuditInfo[in] Pointer to an OdDbAuditInfo object.
strLine[in] The string to print.
printDest[in] Print destination.
Remarks
The default implementation of this function does nothing but return.

Reimplemented from OdDbBaseHostAppServices.

◆ brepBuilder()

virtual OdResult OdDbHostAppServices::brepBuilder ( OdBrepBuilder bbuilder,
BrepType  bbType 
)
inlinevirtual

Initialize brep builder with product specific implementation. Return eNotImplementedYet by default.

Parameters
brepBuilder[in] instance of brep builder class.
bbType[in] type of brep.

Reimplemented from OdDbBaseHostAppServices.

Definition at line 698 of file DbHostAppServices.h.

◆ collectFilePathsInDirectory()

virtual void OdDbHostAppServices::collectFilePathsInDirectory ( OdStringArray res,
const OdString sPath,
const OdString sFilter = L"*.*" 
)
virtual

Collects TrueType font paths.

Parameters
res[out] Array of full file names of TrueType fonts.
sPath[in] Array of folders paths with TrueType files.
sFilter[in] File name filter.
See also
Font Handling

Reimplemented from OdDbBaseHostAppServices.

◆ companyName()

virtual const OdString OdDbHostAppServices::companyName ( )
virtual

Returns the name of the client company. This function is typically used for populating "About" information.

Remarks
The default implementation of this function returns oddbGetLibraryInfo()->getCompanyName().

Implements OdDbBaseHostAppServices.

◆ createDatabase()

virtual OdDbDatabasePtr OdDbHostAppServices::createDatabase ( bool  createDefault = true,
OdDb::MeasurementValue  measurement = OdDb::kEnglish 
) const
virtual

Creates an instance of an OdDbDatabase object.

Parameters
createDefault[in] If and only if true, the newly created database will be populated with the default set of objects (all tables, ModelSpace and PaperSpace blocks etc.)
measurement[in] Units of measurement for creating the database.
Remarks
Returns the newly created database.

This HostAppServices object will be associated with the newly created database.

measurement must be one of the following:

Value Description OdDb::kEnglish 0 English OdDb::kMetric 1 Metric

◆ databaseClass()

virtual OdRxClass* OdDbHostAppServices::databaseClass ( ) const
virtual

Returns the static OdRxClass description object associated with the database.

Remarks
Returns OdDbDatabase::desc();

◆ doFullCRCCheck()

virtual bool OdDbHostAppServices::doFullCRCCheck ( )
virtual

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

Remarks
The default implementation of this function always returns false. Override this function to return true or false as desired to control this checking.

Reimplemented in CFxHostAppServices.

◆ educationalPlotStamp()

virtual OdUInt32 OdDbHostAppServices::educationalPlotStamp ( ) const
virtual

Returns non-zero if the application copy is educational.

◆ fileDialog()

virtual OdString OdDbHostAppServices::fileDialog ( int  flags,
const OdString dialogCaption = OdString::kEmpty,
const OdString defExt = OdString::kEmpty,
const OdString defFilename = OdString::kEmpty,
const OdString filter = OdString::kEmpty 
)
virtual

Prompts the user for a filename, and returns their response.

Parameters
flags[in] Dialog behavior.
dialogCaption[in] Dialog caption.
defExt[in] Default file extension without "."
defFilename[in] Default filename.
filter[in] Filter pattern.
Remarks
flags must be one of the following:

Value Description kGfpForOpen 0 For Open. kGfpForSave 1 For Save. kGfpOverwritePrompt 2 Enable overwrite prompt displaying when exist file selected for saving.

This function is intended for the selection of filenames via dialog boxes, although other methods may be used.

Returns "canceled" if the user cancels the request. Returns "unsupported" if the application does not support this user input.

Remarks
The default implementation of this function does nothing but return "unsupported".

Reimplemented from OdDbBaseHostAppServices.

◆ findFile()

virtual OdString OdDbHostAppServices::findFile ( const OdString filename,
OdDbBaseDatabase pDb = 0,
FindFileHint  hint = kDefault 
)
virtual

Returns the fully qualified path to the specified file.

Parameters
filename[in] Name of the file to find.
pDb[in] Pointer to the database context.
hint[in] Hint that indicates the type of file that is required.
Remarks
Returns an empty string if the file is not found.

This function is called by Teigha when access is needed to a file, such as a font file, a template file, etc.

pDb == 0 specifies that this file search is not related to a database.

If pDb != 0, call pDb->getFilename() to determine the path to the DWG file associated with the database.

The typical search order is as follows:

  1. The filename itself.
  2. The current directory.
  3. The drawing directory (for shx font, image, and xref files).
  4. The directories listed in the "ACAD" environment variable.
  5. The Windows fonts directory (only for TTF fonts on Windows).

hint must be one of the following:

Value Description Extension kDefault 0 Any file. any kFontFile 1 Can be either SHX or TTF file. SHX or TTF kCompiledShapeFile 2 SHX file. SHX kTrueTypeFontFile 3 TTF file. TTF kEmbeddedImageFile 4 Image file. ISM kXRefDrawing 5 Drawing template file. DWT kPatternFile 6 Pattern file (PAT) PAT kTXApplication 7 Teigha(R) Xtension file. TX kFontMapFile 8 FontMap file FMP kUnderlayFile 9 Underlay file kTextureMapFile 10

Remarks
The client application can, in fact return any non-null string, so long as the application can handle that string in OdDbSystemServices::createFile.

Implements OdDbBaseHostAppServices.

◆ formatMessage()

virtual OdString OdDbHostAppServices::formatMessage ( unsigned int  errorCode,
  ... 
)
virtual

Returns a formatted message corresponding to the specified error code(s).

Parameters
errorCode[in] Error code.

Reimplemented from OdDbBaseHostAppServices.

◆ getAlternateFontName()

virtual OdString OdDbHostAppServices::getAlternateFontName ( ) const
virtual

Returns the font file to be used when a given font file is not found by Teigha.

See also
Font Handling

Implements OdDbBaseHostAppServices.

◆ getDgnHostAppServices()

virtual OdDbBaseHostAppServices* OdDbHostAppServices::getDgnHostAppServices ( ) const
virtual

Returns the OdDgHostAppServices object used for reading dgn files.

◆ getErrorDescription()

virtual OdString OdDbHostAppServices::getErrorDescription ( unsigned int  errorCode)
virtual

Returns the error description associated with the specified error code.

Parameters
errorCode[in] Error code.
Remarks
The default implementation of this function returns formatMessage(errorCode).

Reimplemented from OdDbBaseHostAppServices.

◆ getFontMapFileName()

virtual OdString OdDbHostAppServices::getFontMapFileName ( ) const
virtual

Returns the name of the font mapping file used by the getPreferableFont function.

See also
Font Handling
Remarks
The default implementation of this function does nothing but return an empty string. It will be fully implemented in a future release.

Implements OdDbBaseHostAppServices.

◆ getHistoryFile()

virtual OdStreamBufPtr OdDbHostAppServices::getHistoryFile ( OdDbDatabase )
virtual

◆ getPassword()

virtual bool OdDbHostAppServices::getPassword ( const OdString dwgName,
bool  isXref,
OdPassword password 
)
virtual

Notification function called whenever a drawing file requires a password.

Parameters
dwgName[in] Drawing file requiring the password.
isXref[in] True if and only if the drawing file is being opened as an Xref.
password[out] Password.
Remarks
Prompts the user for a password and returns said password.

Returns false if the user cancels the password entry, or if there is no user.

Remarks
The default implementation of this function does nothing but return false.

◆ getPasswordCache()

virtual OdPwdCachePtr OdDbHostAppServices::getPasswordCache ( )
virtual

◆ getPreferableFont()

virtual OdString OdDbHostAppServices::getPreferableFont ( const OdString fontName,
OdFontType  fontType 
)
virtual

Returns the preferable font name for the specified font name and type.

Parameters
fontName[in] Font name.
fontType[in] Font type.
Remarks
This function is called as the first step in the process of resolving a font file. The default implementation tries to locate a font mapping file by calling getFontMapFileName, and substitutes the font name based on the contents of this file.

fontType must be one of the following:

Value Description kFontTypeUnknown 0 Unknown. kFontTypeShx 1 SHX font. kFontTypeTrueType 2 TrueType font. kFontTypeShape 3 Shape file. kFontTypeBig 4 BigFont file.

See also
Font Handling

Implements OdDbBaseHostAppServices.

◆ getSubstituteFont()

virtual OdString OdDbHostAppServices::getSubstituteFont ( const OdString fontName,
OdFontType  fontType 
)
virtual

Returns the font to be used when the specified font is not found.

Parameters
fontName[in] Font name.
fontType[in] Font type.
Remarks
fontType must be one of the following:

Value Description kFontTypeUnknown 0 Unknown. kFontTypeShx 1 SHX font. kFontTypeTrueType 2 TrueType font. kFontTypeShape 3 Shape file. kFontTypeBig 4 BigFont file.

The default implementation of this function calls getAlternateFontName for fonts that are not of type kFontTypeShape or kFontTypeBig. When they are, and empty string is returned.

Client code could override this function to perform custom substitution for these types of fonts.

See also
Font Handling

Implements OdDbBaseHostAppServices.

◆ getSubstituteFontByChar()

virtual OdString OdDbHostAppServices::getSubstituteFontByChar ( const OdFont pFont,
OdChar  unicodeChar,
OdDbBaseDatabase pDb 
)
virtual

Returns the typeface name of the TTF font which has the character.

Parameters
pFont[in] Current font.
unicodeChar[in] Current symbol.
pDb[in] Pointer to the database context.
See also
Font Handling
Remarks
The default implementation uses Windows API for getting the font.

Reimplemented from OdDbBaseHostAppServices.

◆ getSystemFontFolders()

virtual bool OdDbHostAppServices::getSystemFontFolders ( OdStringArray aDirs)
virtual

Collects folders with TrueType fonts.

Parameters
aDirs[out] Array names of folders.
See also
Font Handling

Reimplemented from OdDbBaseHostAppServices.

◆ getTempPath()

virtual OdString OdDbHostAppServices::getTempPath ( ) const
virtual

Returns the path to the temporary files folder.

Reimplemented from OdDbBaseHostAppServices.

◆ getThumbSize()

virtual void OdDbHostAppServices::getThumbSize ( unsigned int &  nWidth,
unsigned int &  nHeight 
)
virtual

Returns thumbnail preview size. Default implementation returns sizes based on THUMBSIZE Registry variable.

◆ gsBitmapDevice()

virtual OdGsDevicePtr OdDbHostAppServices::gsBitmapDevice ( OdRxObject pViewObj = NULL,
OdDbBaseDatabase pDb = NULL,
OdUInt32  flags = 0 
)
virtual

Returns a the gsBitmapDevice associated with this HostAppServices object.

Parameters
pViewObj[in] OdAbstractViewPE compatible object (OdGsView, OdDbViewport or etc.).
pDb[in] Pointer to the database context.
flags[in] Bitmap device flags.

Reimplemented from OdDbBaseHostAppServices.

◆ key()

virtual OdDbKey* OdDbHostAppServices::key ( ) const
pure virtual

◆ layoutManager()

virtual OdDbLayoutManagerPtr OdDbHostAppServices::layoutManager ( ) const
virtual

◆ newPageController()

virtual OdDbPageControllerPtr OdDbHostAppServices::newPageController ( )
virtual

Returns an alternate PageController object for Teigha.

Remarks
The paging type will be determined by the overridden OdDbPageController::pagingType function in the returned instance.

A null SmartPointer indicates no paging of database objects is to be done.

Remarks
The default implementation of this function always returns a null SmartPointer.

◆ newProgressMeter()

virtual OdDbHostAppProgressMeter* OdDbHostAppServices::newProgressMeter ( )
virtual

Returns an instance of an OdDbHostAppProgressMeter.

Reimplemented from OdDbBaseHostAppServices.

◆ newUndoController()

virtual OdDbUndoControllerPtr OdDbHostAppServices::newUndoController ( )
virtual

Returns an alternate UndoController object for Teigha.

Remarks
The default implementation of this function always returns a null SmartPointer.

Each database requires at most 2 undo controllers (for undo and redo).

Reimplemented from OdDbBaseHostAppServices.

◆ ODRX_DECLARE_MEMBERS()

OdDbHostAppServices::ODRX_DECLARE_MEMBERS ( OdDbHostAppServices  )

◆ pageObjects()

virtual OdResult OdDbHostAppServices::pageObjects ( OdDbDatabase pDb)
virtual

Callback method to use with paging functionality.

Remarks
Return eInvalidInput in case if pDb is null.
The default implementation of this function calls odDbPageObjects.

◆ patternManager()

virtual OdHatchPatternManager* OdDbHostAppServices::patternManager ( )
pure virtual

Returns the PatternManager associated with this HostAppServices object.

Remarks
If no PatternManager object is associated with this HostAppServices object, one is created and associated with it.

◆ plotSettingsValidator()

virtual OdDbPlotSettingsValidator* OdDbHostAppServices::plotSettingsValidator ( )
virtual

Returns the PlotSettingsValidator object associated with HostAppServices object.

Remarks
If no PlotSettingsValidator object is associated with this HostAppServices object, one is created and associated with it.

◆ prodcode()

virtual ProdIdCode OdDbHostAppServices::prodcode ( )
virtual

Returns the name of the client product code. This function is typically used for populating "About" information.

prodcode() returns one of the following:

Value Description kProd_ACAD 1 Plain kProd_LT 2 Lite kProd_OEM 3 OEM kProd_OdDb 4 ..

Remarks
The default implementation of this function returns kProd_OEM, and should not be overridden.

Reimplemented from OdDbBaseHostAppServices.

◆ product()

virtual const OdString OdDbHostAppServices::product ( )
virtual

Returns the name of the client product. This function is typically used for populating "About" information.

Returns
The default implementation of this function returns program().

Implements OdDbBaseHostAppServices.

◆ program()

virtual const OdString OdDbHostAppServices::program ( )
virtual

Returns the name of the client program. This function is typically used for populating "About" information.

Remarks
The default implementation of this function returns oddbGetLibraryInfo()->getLibName()

Implements OdDbBaseHostAppServices.

◆ readFile() [1/2]

virtual OdDbDatabasePtr OdDbHostAppServices::readFile ( const OdString filename,
bool  allowCPConversion = false,
bool  partialLoad = false,
Oda::FileShareMode  shareMode = Oda::kShareDenyNo,
const OdPassword password = OdPassword() 
)
inlinevirtual

Loads the contents of the specified StreamBuf or DWG/DXF file into the database with which this HostAppServices object is associated.

Parameters
filename[in] Path of the DWG/DXF file to read.
shareMode[in] Sharing mode to use when opening the file.
Remarks
shareMode must be one of the following:

Value Description Oda::kShareDenyReadWrite 0x10 deny read/write mode Oda::kShareDenyWrite 0x20 deny write mode Oda::kShareDenyRead 0x30 deny read mode Oda::kShareDenyNo 0x40 deny none mode

Definition at line 230 of file DbHostAppServices.h.

◆ readFile() [2/2]

virtual OdDbDatabasePtr OdDbHostAppServices::readFile ( OdStreamBuf pStreamBuf,
bool  allowCPConversion = false,
bool  partialLoad = false,
const OdPassword password = OdPassword() 
)
virtual

Loads the contents of the specified StreamBuf or DWG/DXF file into the database with which this HostAppServices object is associated.

Parameters
pStreamBuf[in] Pointer to the StreamBuf object from which the data are to be read.
partialLoad[in] Controls the partial loading of .dwg files.
password[in] Password for file.
allowCPConversion[in] If and only if true, allows code page conversion.
Returns
Returns a SmartPointer to the database containing the contents of the file.

◆ recoverFile()

virtual OdDbDatabasePtr OdDbHostAppServices::recoverFile ( OdStreamBuf pStreamBuf,
OdDbAuditInfo pAuditInfo = 0,
const OdPassword password = OdPassword() 
)
virtual

Performs a recover operation on the specified StreamBuf file.

Parameters
pStreamBuf[in] Pointer to the StreamBuf object from which the data are to be read.
pAuditInfo[in] Pointer to an OdDbAuditInfo object.
password[in] Password for file.
Remarks
The specified AuditInfo object controls the audit, and receives the audit status.

When overriding this function for a custom class, first call OdDbObject::audit(pAuditInfo) to validate the audit operation.

◆ releaseMajorMinorString()

virtual const OdString OdDbHostAppServices::releaseMajorMinorString ( )
virtual

Returns the release major and minor version string of the client application.

Remarks
The default implementation of this function returns oddbGetLibraryInfo()->getLibVersion().

Reimplemented from OdDbBaseHostAppServices.

◆ releaseMajorVersion()

virtual int OdDbHostAppServices::releaseMajorVersion ( )
virtual

Returns the release major version of the client application.

Remarks
The default implementation of this function returns TD_MAJOR_VERSION.

Reimplemented from OdDbBaseHostAppServices.

◆ releaseMinorVersion()

virtual int OdDbHostAppServices::releaseMinorVersion ( )
virtual

Returns the release minor version of the client application.

Remarks
The default implementation of this function returns TD_MINOR_VERSION.

Reimplemented from OdDbBaseHostAppServices.

◆ releaseProgressMeter()

virtual void OdDbHostAppServices::releaseProgressMeter ( OdDbHostAppProgressMeter pProgressMeter)
virtual

Notification function called whenever Teigha no longer needs the specified ProgressMeter object.

Parameters
pProgressMeter[in] Pointer to the ProgressMeter object no longer needed by Teigha.
Remarks
The default implementation of this function does nothing but return.

Reimplemented from OdDbBaseHostAppServices.

◆ TD_USING()

OdDbHostAppServices::TD_USING ( OdDbBaseHostAppServices::warning  )

Displays the specified warning message.

Parameters
warnVisGroup[in] Group of warning message visibility (always visible if empty).
message[in] Warning message.
warningOb[in] Warning object.
objectId[in] Object ID of the object associated with the warning.
Remarks
These functions call odSystemServices()->warning(message) to display the warning.

◆ versionString()

virtual const OdString OdDbHostAppServices::versionString ( )
virtual

Returns the release version string of the client application.

Remarks
The default implementation of this function returns oddbGetLibraryInfo()->getLibVersion().

Reimplemented from OdDbBaseHostAppServices.

◆ warning() [1/4]

virtual void OdDbHostAppServices::warning ( const char *  warnVisGroup,
const OdError err 
)
inlinevirtual

Definition at line 349 of file DbHostAppServices.h.

◆ warning() [2/4]

virtual void OdDbHostAppServices::warning ( const char *  warnVisGroup,
OdWarning  warningOb,
OdDbObjectId  objectId 
)
virtual

◆ warning() [3/4]

virtual void OdDbHostAppServices::warning ( const OdError err)
inlinevirtual

Definition at line 347 of file DbHostAppServices.h.

◆ warning() [4/4]

virtual void OdDbHostAppServices::warning ( OdWarning  warningOb,
OdDbObjectId  objectId 
)
inlinevirtual

Definition at line 340 of file DbHostAppServices.h.

Member Data Documentation

◆ m_LayoutManagerMutex

OdMutex OdDbHostAppServices::m_LayoutManagerMutex
protected

Definition at line 718 of file DbHostAppServices.h.

◆ m_pLayoutManager

OdDbLayoutManagerPtr OdDbHostAppServices::m_pLayoutManager
protected

Definition at line 722 of file DbHostAppServices.h.

◆ m_pPwdCache

OdPwdCachePtr OdDbHostAppServices::m_pPwdCache
protected

Definition at line 724 of file DbHostAppServices.h.

◆ m_pValidator

OdDbPlotSettingsValidatorPtr OdDbHostAppServices::m_pValidator
protected

Definition at line 723 of file DbHostAppServices.h.

◆ m_PwdCacheMutex

OdMutex OdDbHostAppServices::m_PwdCacheMutex
protected

Definition at line 720 of file DbHostAppServices.h.

◆ m_ValidatorMutex

OdMutex OdDbHostAppServices::m_ValidatorMutex
protected

Definition at line 719 of file DbHostAppServices.h.


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