ICnrObjectSet::Cursor

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


ICnrObjectSet::Cursor - Member Functions and Data by Group

Constructors & Destructor

You can create and delete objects of this class.


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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
Cursor

Construct an object of this class to iterate over the elements of the ICnrObjectSet collection


Overload 1
public:
Cursor(const Cursor& cursor)

This is the copy constructor. It sets this cursor to be the same as the given cursor.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
Cursor(const ICnrObjectSet& objectList)

Creates a cursor over the given ICnrObjectSet.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator =
public:
Cursor& operator =(const Cursor& cursor)

Replaces the current cursor with the given cursor.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Cursor Movement

Use these functions to control the movement of cursors over an ICnrObjectSet collection.


[view class]
setToFirst
public:
bool setToFirst()

Resets the cursor position to the first element in the collection.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setToLast
public:
bool setToLast()

Resets the cursor position to the last element in the collection.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setToNext
public:
bool setToNext()

Advances the cursor position to the next element in the collection.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setToPrevious
public:
bool setToPrevious()

Sets the cursor position to the previous element in the collection.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Cursor Validation

Use these functions query the validity of a cursor.


[view class]
invalidate
public:
void invalidate()

Marks the cursor as invalid.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


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

If the cursor points to an element of the ICnrObjectSet collection, true is returned. Otherwise, false is returned.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Object Retrieval

Use these functions to retrieve elements from an ICnrObjectSet collection.


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

Returns the element pointed at by the cursor.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


ICnrObjectSet::Cursor - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data