IDDEClientHotLinkSet

The IDDEClientHotLinkSet class is a set containing pointers to IDDEClientHotLinkEvent objects.

An IDDEClientConversation object creates objects of this class to keep track of the active hot links for the conversation. An application creates an object of this class to call the IDDEClientConversation::hotLinks member to get the current set of active hot links. If you remove individual elements of the set, delete the IDDEClientHotLinkEvent to which each element points or the memory is not recovered.


IDDEClientHotLinkSet - Member Functions and Data by Group

Constructors & Destructor

Use these to construct and destruct objects of this class.


[view class]
~IDDEClientHotLinkSet
public:
~IDDEClientHotLinkSet()

This member removes all the elements from the set and deletes them.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
IDDEClientHotLinkSet
public:
IDDEClientHotLinkSet()

You can construct objects of this class using the default constructor, which does not accept any arguments.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Addition and Removal

Use these functions to add and remove IDDEClientHotLinkEvent objects.


[view class]
add
public:
bool add(IDDEClientHotLinkEvent * const& hotLinkEvent)

Adds the IDDEClientHotLink object as the last element in the collection.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
removeAll

Removes all IDDEClientHotLinkEvent objects from the collection.


Overload 1
public:
unsigned long removeAll()

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Overload 2
public:
unsigned long removeAll( bool ( * predicateFunction ) ( IDDEClientHotLinkEvent * const&, void * ) , void* data = 0 )

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
removeAt
public:
void removeAt(Cursor& cursor)

Removes the IDDEClientHotLinkEvent object at the given cursor.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
replaceAt
public:
void replaceAt( const Cursor& cursor, IDDEClientHotLinkEvent * const& hotLinkEvent )

Replaces the IDDEClientHotLinkEvent object at the given cursor with the given IDDEClientHotLinkEvent object.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Iteration

Use these functions to operate on all objects in the collection.


[view class]
allElementsDo
public:
bool allElementsDo( bool ( * function ) ( IDDEClientHotLinkEvent *&, void * ) , void* additionalArgument = 0 )

Calls the specified function for each object in the set.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Query

Use these functions to determine characteristics of the collection.


[view class]
elementAt
public:
IDDEClientHotLinkEvent* elementAt( const Cursor& cursor ) const

Returns the IDDEClientHotLink object pointed to by the given cursor.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
isEmpty
public:
bool isEmpty() const

Returns true if the collection of IDDEClientHotLinkEvent objects is empty.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
numberOfElements
public:
unsigned long numberOfElements() const

Returns the number of IDDEClientHotLinkEvent objects in the collection.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


IDDEClientHotLinkSet - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data