summinfo.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 _SUMMINFO_H_
#define _SUMMINFO_H_
 
#include "RxObject.h"
#include "DbDatabase.h"
#include "DbLibraryInfo.h"
 
#include "TD_PackPush.h"
 
class TOOLKIT_EXPORT OdDbDatabaseSummaryInfo : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbDatabaseSummaryInfo);
 
  OdDbDatabaseSummaryInfo();
  
  virtual OdString getTitle() const = 0;
 
  virtual void setTitle(
    const OdString& title) = 0;
  
  virtual OdString getSubject() const = 0;
 
  virtual void setSubject(
    const OdString& subject) = 0;
  
  virtual OdString getAuthor() const = 0;
 
  virtual void setAuthor(
    const OdString& author) = 0;
 
  virtual OdString getKeywords() const = 0;
 
  virtual void setKeywords(
    const OdString& keywords) = 0;
 
  virtual OdString getComments() const = 0;
 
  virtual void setComments(
    const OdString& comments) = 0;
 
 
  virtual OdString getLastSavedBy() const = 0;
 
  virtual void setLastSavedBy(
    const OdString& lastSavedBy) = 0;
 
  virtual OdString getRevisionNumber() const = 0;
 
  virtual void setRevisionNumber(
    const OdString& revisionNumber) = 0;
    
  virtual OdString getHyperlinkBase() const = 0;
 
  virtual void setHyperlinkBase(
    const OdString& hyperlinkBase) = 0;
  virtual int numCustomInfo() const = 0;
  
  virtual void addCustomSummaryInfo(
    const OdString& key, 
    const OdString& value ) = 0;
  
  virtual void deleteCustomSummaryInfo(
    int fieldIndex) = 0;
  
  virtual bool deleteCustomSummaryInfo(
    const OdString& key) = 0;
    
    virtual void getCustomSummaryInfo(
    int fieldIndex, 
    OdString& key, 
    OdString& rvalue) const = 0;
 
  virtual void setCustomSummaryInfo(
    int fieldIndex, const OdString& key, 
    const OdString& value) = 0;
  
  virtual bool getCustomSummaryInfo(
    const OdString& customInfoKey, 
    OdString& rvalue ) const = 0;
  
  virtual void setCustomSummaryInfo(
    const OdString& customInfoKey, 
    const OdString& value) = 0;
  
  virtual OdDbDatabase* database() const = 0; 
  
  virtual void setDatabase(
    OdDbDatabase *pDb) = 0;
};
 
typedef OdSmartPtr<OdDbDatabaseSummaryInfo> OdDbDatabaseSummaryInfoPtr;
 
 
TOOLKIT_EXPORT OdDbLibraryInfo*           oddbGetLibraryInfo(void);
TOOLKIT_EXPORT OdDbDatabaseSummaryInfoPtr oddbGetSummaryInfo(OdDbDatabase* pDb);
TOOLKIT_EXPORT void                       oddbPutSummaryInfo(const OdDbDatabaseSummaryInfo* pInfo);
 
 
#include "TD_PackPop.h"
 
#endif // _SUMMINFO_H_