DbAudit.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2022 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
 
 
#ifndef _ODDB_AUDIT_INCLUDED_
#define _ODDB_AUDIT_INCLUDED_
 
#include "TD_PackPush.h"
 
#include "DbExport.h"
 
#include "OdString.h"
#include "CmColor.h"
#include "OdAuditInfo.h"
 
class OdDbObject;
class OdDbObjectId;
class OdDbDatabase;
class OdDbHandle;
class OdDbHostAppServices;
 
TOOLKIT_EXPORT OdString odDbGetObjectName(const OdDbObject* pObj);
TOOLKIT_EXPORT OdString odDbGetObjectIdName(const OdDbObjectId& id);
TOOLKIT_EXPORT OdString odDbGetHandleName(const OdDbHandle& handle);
TOOLKIT_EXPORT OdString odDbGenerateName(const OdDbObjectId& id, OdDbHostAppServices* pHostApp = 0);
TOOLKIT_EXPORT OdString odDbGenerateName(OdUInt32 i, OdDbHostAppServices* pHostApp = 0);
TOOLKIT_EXPORT bool     odDbAuditColorIndex(OdInt16& colorIndex, OdDbAuditInfo* pAuditInfo, OdDbHostAppServices* pHostApp = 0);
TOOLKIT_EXPORT bool     odDbAuditColorIndex(OdInt16& colorIndex, OdDbAuditInfo* pAuditInfo, OdDbHostAppServices* pHostApp, OdDbObject* pObj, unsigned int sid, unsigned int n);
TOOLKIT_EXPORT bool     odDbAuditColor(OdCmColor& color, OdDbAuditInfo* pAuditInfo, OdDbHostAppServices* pHostApp = 0);
TOOLKIT_EXPORT bool     odDbAuditColor(OdCmColor& color, OdDbAuditInfo* pAuditInfo, OdDbHostAppServices* pHostApp, OdDbObject* pObj, unsigned int sid, unsigned int n);
 
class DBENT_EXPORT OdDbAuditInfo : public OdAuditInfo
{
public:
  virtual void printError(
    const OdString& name,
    const OdString& value,
    const OdString& validation = OdString::kEmpty,
    const OdString& defaultValue = OdString::kEmpty );
 
  virtual void printError(
    const OdRxObject* pObject,
    const OdString& value,
    const OdString& validation = OdString::kEmpty,
    const OdString& defaultValue = OdString::kEmpty);
};
 
#include "TD_PackPop.h"
 
#endif // _ODDB_AUDIT_INCLUDED_