DbHyperlink.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 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 _ODDBHYPERLINK_INCLUDED_
#define _ODDBHYPERLINK_INCLUDED_
 
#include "TD_PackPush.h"
#include "RxObject.h"
#include "DbStubPtrArray.h"
 
class DBROOT_EXPORT OdDbHyperlink
{
public:
  enum HLinkFlags 
  {
    kUndefined = 0,
    kConvertDwgToDwf = 0x1
  };
 
  OdDbHyperlink() {};
  virtual ~OdDbHyperlink(){};
  
  virtual const OdString name() const = 0;   
 
  virtual void setName(
    const OdString& name) = 0; 
  
  virtual const OdString description() const = 0;  
 
  virtual void setDescription(
    const OdString& description) = 0;
  
  virtual const OdString subLocation() const = 0;  
 
  virtual void setSubLocation(
    const OdString& subLocation) = 0;
  
  virtual const OdString getDisplayString() const = 0;  
  
  virtual bool isOutermostContainer() const = 0;
  
  virtual int getNestedLevel() const = 0;
 
  virtual OdInt32 flags() const  = 0;
 
  virtual void setFlags(OdInt32 lFlags) = 0;
 
};
 
class DBROOT_EXPORT OdDbHyperlinkCollection : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbHyperlinkCollection);
  OdDbHyperlinkCollection() {};
  virtual ~OdDbHyperlinkCollection(){};
  
  virtual void addHead(
    const OdString& name, 
    const OdString& description, 
    const OdString& subLocation = OdString::kEmpty) = 0;
 
  virtual void addTail(
    const OdString& name, 
    const OdString& description, 
    const OdString& subLocation = OdString::kEmpty) = 0;
 
  virtual void addAt(
    const int hyperlinkIndex,
    const OdString& name, 
    const OdString& description, 
    const OdString& subLocation = OdString::kEmpty) = 0;
 
  virtual void removeHead() = 0;
 
  virtual void removeTail() = 0;
 
  virtual void removeAt(
    const int hyperlinkIndex) = 0;
  
  virtual int count() const = 0;
  
  
  virtual OdDbHyperlink * item(
    const int hyperlinkIndex) const = 0;
};
 
typedef OdSmartPtr<OdDbHyperlinkCollection> OdDbHyperlinkCollectionPtr;
 
 
class DBROOT_EXPORT OdDbEntityHyperlinkPE : public OdRxObject
{
public:
  
  OdDbEntityHyperlinkPE();
  virtual ~OdDbEntityHyperlinkPE();
 
  ODRX_DECLARE_MEMBERS(OdDbEntityHyperlinkPE);
  
  virtual OdDbHyperlinkCollectionPtr getHyperlinkCollection(
    const OdRxObject* pObject, 
    bool oneOnly = false, 
    bool ignoreBlockDefinition = true) = 0;
 
  virtual OdDbHyperlinkCollectionPtr getHyperlinkCollection(
    const OdDbStubPtrArray*& objectIds,
    bool oneOnly = false,                                               
    bool ignoreBlockDefinition = true) = 0;
 
  virtual void setHyperlinkCollection(
    const OdRxObject * pObject, 
    OdDbHyperlinkCollection * pHCO) = 0;
  
  virtual unsigned int getHyperlinkCount(
    const OdRxObject * pObject, 
    bool ignoreBlockDefinition = true) = 0;
 
  virtual unsigned int getHyperlinkCount(
    const OdDbStubPtrArray *& idContainers, 
    bool ignoreBlockDefinition = true) = 0;
  
  virtual bool hasHyperlink(
    const OdRxObject * pObject, 
    bool ignoreBlockDefinition = true) = 0;
  
  
  virtual bool hasHyperlink(
    const OdDbStubPtrArray *& objectIds, 
    bool ignoreBlockDefinition = true) = 0;
  
};
typedef OdSmartPtr<OdDbEntityHyperlinkPE> OdDbEntityHyperlinkPEPtr;
 
typedef void (*ODDBHYPERLINK_CALLBACK)(const OdDbHyperlink*);
DBROOT_EXPORT void odrxRegisterHyperlinkDestructorCallback(ODDBHYPERLINK_CALLBACK callbackFunc);
DBROOT_EXPORT void odrxUnregisterHyperlinkDestructorCallback();
#include "TD_PackPop.h"
#endif // _ODDBHYPERLINK_INCLUDED_