BDE 4.39.x Production Release
Loading...
Searching...
No Matches
ball::CategoryManagerManip Class Reference

#include <ball_categorymanager.h>

Detailed Description

This class defines an iterator providing sequential, modifiable access to the categories in the registry of a category manager. The order of the iteration is undefined.

Deprecated:
Use CategoryManager::visitCategories manipulator instead.

See ball_categorymanager

Public Member Functions

 CategoryManagerManip (CategoryManager *categoryManager)
 
 ~CategoryManagerManip ()=default
 
void advance ()
 
Categoryoperator() ()
 
 operator const void * () const
 

Constructor & Destructor Documentation

◆ CategoryManagerManip()

ball::CategoryManagerManip::CategoryManagerManip ( CategoryManager categoryManager)
inlineexplicit

Create an iterator providing modifiable access to the categories in the specified categoryManager that is initialized to refer to the first category in the sequence of categories in the registry of categoryManager, if one exists, and is initialized to be invalid otherwise. The order of iteration is undefined.

Precondition
The behavior is undefined unless the lifetime of categoryManager is at least as long as the lifetime of this iterator.

◆ ~CategoryManagerManip()

ball::CategoryManagerManip::~CategoryManagerManip ( )
default

Destroy this iterator.

Member Function Documentation

◆ advance()

void ball::CategoryManagerManip::advance ( )
inline

Advance this iterator to refer to the next unvisited category. If no such category exists, this iterator becomes invalid.

Precondition
The behavior is undefined unless this iterator is initially valid.
Note
Note that the order of iteration is undefined.

◆ operator const void *()

ball::CategoryManagerManip::operator const void * ( ) const
inline

Return a non-zero value if this iterator is valid, and 0 otherwise.

◆ operator()()

Category & ball::CategoryManagerManip::operator() ( )
inline

Return a non-const reference to the category currently referred to by this iterator.

Precondition
The behavior is undefined unless this iterator is valid.

The documentation for this class was generated from the following file: