IDDEClientHotLinkSet::Cursor

Use the nested class IDDEClientHotLinkSet::Cursor to iterate over the elements of an IDDEClientHotLinkSet collection.


IDDEClientHotLinkSet::Cursor - Member Functions and Data by Group

Constructors & Destructor

Use these to construct and destruct objects of this class.


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

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
Cursor
public:
Cursor(const IDDEClientHotLinkSet& hotLinkSet)

Constructs the cursor and associates it with the given IDDEClientHotLinkSet collection. The cursor is initially invalid.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Cursor Movement

Use these functions to set the cursor to a specified element of the associated collection.


[view class]
setToFirst
public:
bool setToFirst()

Sets the cursor to the first IDDEClientHotLinkEvent object in the collection. Invalidates the cursor if the collection is empty. Returns true if there was a first object.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
setToNext
public:
bool setToNext()

Sets the cursor to the next IDDEClientHotLinkEvent object in the collection. Invalidates the cursor if there were no more objects to be visited. Returns true if there was a next object.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Cursor Validation

Use these members to determine if the cursor is valid or invalidate the cursor.


[view class]
invalidate
public:
void invalidate()

Invalidates the cursor.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


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

Returns true if the cursor refers to a valid IDDEClientHotLinkEvent object.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Object Retrieval

Use these functions to retrieve objects from the collection.


[view class]
element
public:
IDDEClientHotLinkEvent * const element() const

Returns the IDDEClientHotLinkEvent object at the cursor location.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


IDDEClientHotLinkSet::Cursor - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data