ExclList Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class INode, Class ILoad, Class ISave, Class IMergeManager

Description:

This class is available in release 4.0 and later only.

This class represents an exclusion list and is a direct parallel to the NameTab, and converting from using one to the other is fairly simple.

#include <excllist.h>

Inheritance diagram for ExclList:

List of all members.

Public Member Functions
	ExclList ()
void	SetFlag (ULONG f, BOOL b=1)
BOOL	TestFlag (ULONG f) const
int	Count () const
CoreExport INode *	operator[] (const int i)
CoreExport void	Set (int i, INode *node)
CoreExport ExclList &	operator= (const ExclList &e)
CoreExport ExclList &	operator= (const NameTab &n)
CoreExport int	FindNode (INode *node)
CoreExport int	AddNode (INode *node)
CoreExport void	RemoveNode (INode *node)
CoreExport void	RemoveNode (int i)
CoreExport void	SetSize (int num)
void	SetCount (int num)
CoreExport IOResult	Load (ILoad *iload)
CoreExport IOResult	Save (ISave *isave)
CoreExport void	OnMerge (IMergeManager *imm)

---

Constructor & Destructor Documentation

ExclList

(

)

[inline]

Remarks:

Constructor.

{ flags = NT_AFFECT_ILLUM|NT_AFFECT_SHADOWCAST; }

---

Member Function Documentation

void SetFlag	(	ULONG	f,
		BOOL	b = 1
	)		[inline]

Search for all occurrences

Remarks:

Sets the specified flag to the specified value.

Parameters:

ULONG f

The flag(s) to set. One or more of the following values:

NT_INCLUDE

This bit is used to indicate "Include" mode.

NT_AFFECT_ILLUM

This bit is used to indicate the "Illumination" check box in the exclusion list dialog.

NT_AFFECT_SHADOWCAST

This bit is used to indicate the "Shadow Casting" check box in the exclusion list dialog.

BOOL b=1

The value to set.

{ if (b) flags|=f; else flags &= ~f; }

BOOL TestFlag

(

ULONG

f

)

const [inline]

Search for all occurrences

Remarks:

Returns TRUE if the specified flag(s) are set; otherwise FALSE.

Parameters:

ULONG f

The flag(s) to set. One or more of the following values:

NT_INCLUDE

This bit is used to indicate "Include" mode.

NT_AFFECT_ILLUM

This bit is used to indicate the "Illumination" check box in the exclusion list dialog.

NT_AFFECT_SHADOWCAST

This bit is used to indicate the "Shadow Casting" check box in the exclusion list dialog.

{ return (flags&f)?1:0; }

int Count

(

)

const [inline]

Search for all occurrences

Remarks:

This method returns the number of handles in the table.

{ return handles.Count(); }

CoreExport INode* operator[]

(

const int

i

)

Remarks:

Index operator.

CoreExport void Set	(	int	i,
		INode *	node
	)

Search for all occurrences

Remarks:

This method allows you to set a specified entry in the table to the specified node.

Parameters:

int i

The index in the table.

INode *node

The node to set.

CoreExport ExclList& operator=

(

const ExclList &

e

)

Remarks:

Assignment operator.

CoreExport ExclList& operator=

(

const NameTab &

n

)

Remarks:

Assignment operator.

CoreExport int FindNode

(

INode *

node

)

Search for all occurrences

Remarks:

Returns the index of the node passed; otherwise returns -1.

Parameters:

INode *node

The node to find.

CoreExport int AddNode

(

INode *

node

)

Search for all occurrences

Remarks:

Appends the specified node to the end of the list.

Parameters:

INode *node

The node to add.

Returns:

Returns the number of items in the list prior to appending.

CoreExport void RemoveNode

(

INode *

node

)

Search for all occurrences

Remarks:

Removes thes node from the list.

Parameters:

INode *node

The node to remove.

CoreExport void RemoveNode

(

int

i

)

Search for all occurrences

Remarks:

Removes the 'i-th' name from the list.

Parameters:

int i

Specifies the index of the node to remove.

CoreExport void SetSize

(

int

num

)

Search for all occurrences

Remarks:

Sets the size of the list. If the new size is smaller than the current size entries are deleted.

Parameters:

int num

Specifies the size of the list.

void SetCount

(

int

num

)

[inline]

Search for all occurrences

Remarks:

Sets the size of the list. If the new size is smaller than the current size entries are deleted.

Parameters:

int num

Specifies the size of the list.

{ SetSize(num); } 

CoreExport IOResult Load

(

ILoad *

iload

)

Search for all occurrences

Remarks:

Loads this ExclList from disk.

Parameters:

ILoad *iload

This class provides methods to load data from disk.

See also:

I/O Results.

CoreExport IOResult Save

(

ISave *

isave

)

Search for all occurrences

Remarks:

Saves this ExclList to disk.

Parameters:

ISave *isave

This class provides methods to save data to disk.

See also:

I/O Results.

CoreExport void OnMerge

(

IMergeManager *

imm

)

Search for all occurrences

Remarks:

This method takes care of setting the merge manager interface.

Parameters:

IMergeManager* imm

A pointer to the merge manager interface.