OdDbHyperlinkCollection Class Reference

#include <DbHyperlink.h>

Inheritance diagram for OdDbHyperlinkCollection:

Public Member Functions
	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
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () 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

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class is a container object for OdDbHyperlink objects.

See also

OdDbEntityHyperlinkPE OdDbHyperlink OdDbHyperlinkCollection

Corresponding C++ library: TD_Db

<group OdDb_Classes>

Definition at line 176 of file DbHyperlink.h.

Constructor & Destructor Documentation

OdDbHyperlinkCollection()

OdDbHyperlinkCollection::OdDbHyperlinkCollection ( )

inline

Default constructor. Creates a new object of the OdDbHyperlinkCollection class.

Definition at line 187 of file DbHyperlink.h.

~OdDbHyperlinkCollection()

virtual OdDbHyperlinkCollection::~OdDbHyperlinkCollection ( )

inlinevirtual

Virtual destructor. Destroys an object of the OdDbHyperlinkCollection class and releases all resources that were used by the object.

Definition at line 193 of file DbHyperlink.h.

Member Function Documentation

addAt()

virtual void OdDbHyperlinkCollection::addAt ( const int  hyperlinkIndex, const OdString &  name, const OdString &  description, const OdString &  subLocation = OdString::kEmpty  )

pure virtual

Creates a HyperLink object and inserts it into this HyperlinkCollection object at the specified index.

Parameters

hyperlinkIndex	[in] Hyperlink index.
name	[in] Name for the Hyperlink object.
description	[in] Description for the Hyperlink object.
subLocation	[in] Sublocation for the Hyperlink object.

Remarks

Objects at or after index are moved toward the tail.

addHead()

virtual void OdDbHyperlinkCollection::addHead ( const OdString &  name, const OdString &  description, const OdString &  subLocation = OdString::kEmpty  )

pure virtual

Creates a HyperLink object and adds it to the beginning of this HyperlinkCollection object.

Parameters

name	[in] Name for the Hyperlink object.
description	[in] Description for the Hyperlink object.
subLocation	[in] Sublocation for the Hyperlink object.

addTail()

virtual void OdDbHyperlinkCollection::addTail ( const OdString &  name, const OdString &  description, const OdString &  subLocation = OdString::kEmpty  )

pure virtual

Creates a HyperLink object and adds it to the end of this HyperlinkCollection object.

Parameters

name	[in] Name for the Hyperlink object.
description	[in] Description for the Hyperlink object.
subLocation	[in] Sublocation for the Hyperlink object.

count()

virtual int OdDbHyperlinkCollection::count ( ) const

pure virtual

Returns the number of HyperLink objects in this HyperlinkCollection object.

item()

virtual OdDbHyperlink * OdDbHyperlinkCollection::item ( const int  hyperlinkIndex ) const

pure virtual

Returns the HyperLink object at the specified location in this HyperlinkCollection object.

Parameters

hyperlinkIndex

[in] Hyperlink index.

ODRX_DECLARE_MEMBERS()

OdDbHyperlinkCollection::ODRX_DECLARE_MEMBERS

(

OdDbHyperlinkCollection

)

removeAt()

virtual void OdDbHyperlinkCollection::removeAt ( const int  hyperlinkIndex )

pure virtual

Removes a Hyperlink object at the specified location in this HyperlinkCollection object.

Parameters

hyperlinkIndex

[in] Index of the Hyperlink to remove.

removeHead()

virtual void OdDbHyperlinkCollection::removeHead ( )

pure virtual

Removes the first Hyperlink object in this HyperlinkCollection object.

removeTail()

virtual void OdDbHyperlinkCollection::removeTail ( )

pure virtual

Removes the last Hyperlink object in this HyperlinkCollection object.

---

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

• DbHyperlink.h