INotebook::Cursor

The nested class INotebook::Cursor defines objects that you can use to iterate through the pages of a notebook. In the same way that you can use a cursor to iterate through the objects in a collection, you can use this cursor object to iterate through a notebook, one page at a time.

An object of this class processes IPageHandle objects, each of which can be thought of as a pointer to a specific page in the notebook.


INotebook::Cursor - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
Cursor
public:
Cursor(const INotebook& notebook)

Create objects of this nested class by specifying a notebook. Use the object to iterate through the pages of the notebook that you specified.

notebook
Reference to the notebook object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Page Iteration

Use these members to iterate through the pages of a notebook.


[view class]
invalidate
public:
virtual void invalidate()

Flags this cursor as not valid.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


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

Queries whether the cursor points to a valid item and returns true if it does.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setToFirst
public:
virtual bool setToFirst()

Sets the cursor to point to the first page of the notebook.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setToLast
public:
virtual bool setToLast()

Sets the cursor to point to the last page of the notebook.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setToNext
public:
virtual bool setToNext()

Sets the cursor to point to the next page of the notebook.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setToPrevious
public:
virtual bool setToPrevious()

Sets the cursor to point to the previous page of the notebook.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Page Retrieval

Use these members to retrieve notebook pages.


[view class]
current
public:
virtual IPageHandle current() const

Returns an IPageHandle object for the notebook page to which the cursor currently points.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
first
public:
virtual IPageHandle first()

Points to the first notebook page and returns an IPageHandle object that points to that page.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
last
public:
virtual IPageHandle last()

Points to the last notebook page and returns an IPageHandle object that points to that page.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
next
public:
virtual IPageHandle next()

Points to the next notebook page and returns an IPageHandle object that points to that page.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
previous
public:
virtual IPageHandle previous()

Points to the previous notebook page and returns an IPageHandle object that points to that page.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setCurrent
public:
void setCurrent(const IPageHandle& current)

Sets the cursor to point to the specified notebook page, therefore making it the current page.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


INotebook::Cursor - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data