The IContainerControl::ColumnCursor class navigates through the container's details view columns.
The leftmost column that the Container widget maintains automatically is never accessed by the ColumnCursor.
Iterating of columns in a native Windows container (that is, a container constructed without the pmCompatible style) may not be as expected. Any icon column added other than the valid one is considered invalid and not visible and will be iterated after the valid columns are iterated. The native Windows container also has a required first column. If IContainerColumn(s) are not inserted for these, then the cursor will not iterate them. See IContainerColumn documentation for more details.
You can construct and destruct objects of this class.
![]() |
public:
virtual ~ColumnCursor()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
ColumnCursor( const IContainerControl& container, bool visibleOnly = false )
Constructs objects of this class by using a cursor to iterate through all columns in the container meeting the visibility criteria (all columns or visible columns only). You must specify the following:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to move the cursor and retrieve columns.
![]() |
public:
virtual IContainerColumn* current() const
Returns the current column of this cursor.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IContainerColumn* first()
Points to and returns the first column in the container. If there are no objects in the container, 0 is returned. This function validates a cursor that was set invalid as a result of adding or removing columns from the container.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IContainerColumn* last()
Points to and returns the last column in the container. Returns 0 if there are no columns in the container. This function validates a cursor that was set invalid as a result of adding or removing columns from the container.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IContainerColumn* next()
Points to and returns the next or first column in the container. If the cursor has reached the end of the list of columns in the container, 0 is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IContainerColumn* previous()
Points to and returns the previous or last column in the container.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual ColumnCursor& setCurrent( const IContainerColumn* currentColumn )
Sets the cursor to point to the specified column and validates the cursor. This function does not check for visibility.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to move the cursor and retrieve columns.
![]() |
public:
virtual bool setToFirst()
Points to the first column in the container. If there are no objects in the container, false is returned. This function validates a cursor that was set invalid as a result of adding or removing columns from the container.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual bool setToLast()
Points to the last column in the container. If there is a last column, true is returned. Otherwise, false is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual bool setToNext()
Points to the next column in the container. If the cursor does not point to a column, this function is the same as setToFirst. The cursor does not point to a column when it is initially created. In other words, setToNext on a new cursor is the same as setToFirst.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual bool setToPrevious()
Points to the previous or last column in the container.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to validate the cursor.
![]() |
public:
virtual ColumnCursor& invalidate()
Flags the cursor as not valid.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual bool isValid() const
Queries whether the cursor is valid.
The cursor is not valid if any of the following occur:
Windows | OS/2 | AIX |
Yes | Yes | Yes |