InExcludeData Class Reference

#include <customgui_inexclude.h>

Inheritance diagram for InExcludeData:

Detailed Description

InExclude custom data type (CUSTOMDATATYPE_INEXCLUDE_LIST).

Private Member Functions
	InExcludeData ()
	~InExcludeData ()

Object
Bool	InsertObject (BaseList2D *pObject, Int32 lFlags)
Bool	DeleteObject (BaseDocument *doc, BaseList2D *pObject)
Bool	DeleteObject (Int32 lIndex)
void	Reset ()
Int32	GetObjectIndex (const BaseDocument *doc, const BaseList2D *pObject) const
BaseList2D *	ObjectFromIndex (const BaseDocument *doc, Int32 lIndex) const
Int32	GetObjectCount () const

Flags
Int32	GetFlags (Int32 lIndex) const
void	SetFlags (Int32 lIndex, Int32 lFlags)
Int32	GetFlags (BaseDocument *doc, BaseList2D *pObject) const
Int32	GetFlagCount () const
void	SetFlagCount (Int32 lFlagCount)
Int32	GetDefaultFlag () const
void	SetDefaultFlag (Int32 defaultFlag)

Data
BaseContainer *	GetData (Int32 lIndex) const
BaseContainer *	GetData (const BaseDocument *doc, const BaseList2D *pObject) const

Inclusion Table
InclusionTable *	BuildInclusionTable (const BaseDocument *doc, Int32 hierarchy_bit=NOTOK) const

Constructor & Destructor Documentation

InExcludeData()

InExcludeData ( )

private

~InExcludeData()

~InExcludeData ( )

private

Member Function Documentation

InsertObject()

Bool InsertObject	(	BaseList2D *	pObject,
		Int32	lFlags
	)

Inserts a link to pObject into the list.

Note

Sends MSG_DESCRIPTION_INEX_ADDED to the parent.

Parameters

[in]	pObject	The object to add to the list.
[in]	lFlags	A bit field for the initial selection state of pObject.

Returns

true if successful, otherwise false.

DeleteObject() [1/2]

Bool DeleteObject	(	BaseDocument *	doc,
		BaseList2D *	pObject
	)

Removes pObject from the list.

Note

Sends MSG_DESCRIPTION_INEX_DELETED to the parent.

Parameters

[in]	doc	The document to evaluate the links in. The caller owns the pointed document.
[in]	pObject	The object to remove. The caller owns the pointed object.

Returns

true if successful, otherwise false.

DeleteObject() [2/2]

Bool DeleteObject

(

Int32

lIndex

)

Removes the object at index lIndex in the list.

Note

Sends MSG_DESCRIPTION_INEX_DELETED to the parent.

Parameters

[in]

lIndex

The object index: 0 <= lIndex < GetObjectCount()

Returns

true if successful, otherwise false.

Reset()

void Reset

(

)

Resets the list.

GetObjectIndex()

Int32 GetObjectIndex	(	const BaseDocument *	doc,
		const BaseList2D *	pObject
	)		const

Gets the index of pObject in the list.

Parameters

[in]	doc	The document to evaluate the links in. The caller owns the pointed document.
[in]	pObject	The object to search for. The caller owns the pointed object.

Returns

The object index, or NOTOK if it was not found.

ObjectFromIndex()

BaseList2D* ObjectFromIndex	(	const BaseDocument *	doc,
		Int32	lIndex
	)		const

Gets the object at index lIndex in the list.

Parameters

[in]	doc	The document to evaluate the links in. The caller owns the pointed document.
[in]	lIndex	The object index: 0 <= lIndex < GetObjectCount()

Returns

The found object, or nullptr. The document owns the pointed object.

GetObjectCount()

Int32 GetObjectCount

(

)

const

Gets the number of objects in the list.

Returns

The object count.

GetFlags() [1/2]

Int32 GetFlags

(

Int32

lIndex

)

const

Gets the flags for the object at index lIndex in the list.

Parameters

[in]

lIndex

The object index: 0 <= lIndex < GetObjectCount()

Returns

A bit field for the selection state of the object.

SetFlags()

void SetFlags	(	Int32	lIndex,
		Int32	lFlags
	)

Sets the flags for the object at index lIndex in the list.

Parameters

[in]	lIndex	The object index: 0 <= lIndex < GetObjectCount()
[in]	lFlags	A bit field for the selection state of the object.

GetFlags() [2/2]

Int32 GetFlags	(	BaseDocument *	doc,
		BaseList2D *	pObject
	)		const

Gets the flags for pObject.

Parameters

[in]	doc	The document to evaluate the links in. The caller owns the pointed document.
[in]	pObject	The object to get the flags for. The caller owns the pointed object.

Returns

A bit field for the selection state of the object.

GetFlagCount()

Int32 GetFlagCount

(

)

const

Gets the number of flags for each object.

Since

R18

Returns

The number of flags for each object.

SetFlagCount()

void SetFlagCount

(

Int32

lFlagCount

)

Sets the number of flags for each object.

Since

R18

Parameters

[in]

lFlagCount

The number of flags for each object.

GetDefaultFlag()

Int32 GetDefaultFlag

(

)

const

Gets the default flag for new items in the list.

Since

R18

Returns

The default flag for new items in the list.

SetDefaultFlag()

void SetDefaultFlag

(

Int32

defaultFlag

)

Gets the default flag for this list.

Since

R18

Parameters

[in]

defaultFlag

The default flag for new items in the list.

GetData() [1/2]

BaseContainer* GetData

(

Int32

lIndex

)

const

Retrieves the data container for the object at index lIndex in the list.

Parameters

[in]

lIndex

The object index: 0 <= lIndex < GetObjectCount()

Returns

The data container. See IN_EXCLUDE_DATA_SELECTION. The inexclude list owns the pointed container.

GetData() [2/2]

BaseContainer* GetData	(	const BaseDocument *	doc,
		const BaseList2D *	pObject
	)		const

Retrieves the data container for pObject.

Parameters

[in]	doc	The document to evaluate the links in. The caller owns the pointed document.
[in]	pObject	The object to get the data for. The caller owns the pointed object.

Returns

The data container. See IN_EXCLUDE_DATA_SELECTION. The inexclude list owns the pointed container.

BuildInclusionTable()

InclusionTable* BuildInclusionTable	(	const BaseDocument *	doc,
		Int32	hierarchy_bit = NOTOK
	)		const

Builds an inclusion table for a specific bit.

Parameters

[in]	doc	The document to evaluate the links in. The caller owns the pointed document.
[in]	hierarchy_bit	The bit position to generate the table for.

Returns

The inclusion table, or nullptr. The caller owns the pointed inclusion table.
Delete it afterward by calling (table).