Public Member Functions | Private Member Functions | List of all members
InclusionTable Class Reference

#include <customgui_inexclude.h>

Detailed Description

Inclusion table for InExcludeData. Cannot be instantiated.

Note
Use FreeInclusionTable() to free instances.
See also
InExcludeData::BuildInclusionTable

Public Member Functions

Bool Check (const BaseList2D *op) const
 
Bool Check (const BaseList2D *op, Int32 &flags) const
 
Int32 GetObjectCount () const
 
BaseList2D * GetObject (Int32 lIndex) const
 

Private Member Functions

 InclusionTable ()
 
 ~InclusionTable ()
 

Constructor & Destructor Documentation

◆ InclusionTable()

InclusionTable ( )
private

◆ ~InclusionTable()

~InclusionTable ( )
private

Member Function Documentation

◆ Check() [1/2]

Bool Check ( const BaseList2D *  op) const

Checks if op is in the table.

Parameters
[in]opAn object. The caller owns the pointed object.
Returns
true if op is in the table, otherwise false.

◆ Check() [2/2]

Bool Check ( const BaseList2D *  op,
Int32 &  flags 
) const

Checks if op is in the table.

Parameters
[in]opAn object. The caller owns the pointed object.
[out]flagsAssigned the bit field for the initial selection state of op.
Returns
true if op is in the table, otherwise false.

◆ GetObjectCount()

Int32 GetObjectCount ( ) const

Gets the number of objects in the table.

Returns
The object count.

◆ GetObject()

BaseList2D* GetObject ( Int32  lIndex) const

Gets an object in the table at index lIndex.

Parameters
[in]lIndexThe object index: 0 <= lIndex < GetObjectCount()
Returns
The object at index lIndex, or nullptr. The document owns the pointed object.