SubClassList Class Reference

This reference page is linked to from the following overview topics: Incremental Improvements.

---

Search for all occurrences

---

Detailed Description

A collection of ClassEntry objects that have the same super class id.

Clients can get a SubClassList via ClassDirectory::GetClassList().

See also:

Class DllDir, Class ClassDirectory, Class ClassEntry, Class ClassDesc, Class SClassUIInfo.

#include <plugin.h>

Inheritance diagram for SubClassList:

List of all members.

Public Member Functions
CoreExport ClassEntry &	operator[] (int i) const
	Returns a reference to the 'i-th' ClassEntry for this super class.
CoreExport int	FindClass (Class_ID classID) const
	Returns the index in the list of sub-classes of the class whose Class_ID is passed.
CoreExport int	FindClass (const MCHAR *name) const
	Returns the index in the list of sub-classes of the class whose ClassName() is passed.
CoreExport void	AddClass (ClassDesc *cld, int dllNum, int index, bool load)
CoreExport int	Count (int accType) const
	Returns the number of sub-classes that match the specified access type.
CoreExport SClass_ID	SuperID () const
	Returns the Super class ID corresponding to this sub-class list.
CoreExport int	GetFirst (int accType) const
	Returns the index of the first ClassDesc of the specified type in the list of sub-classes.
CoreExport int	GetNext (int accType) const
	Returns the index of the next ClassDesc of the specified type (or -1 at the end).
CoreExport int	operator== (const SubClassList &lst) const
	Equality operator.
CoreExport int	operator== (const SubClassList &sl)
	Equality operator.
CoreExport int	DeleteClass (ClassDesc *cld)
CoreExport void	SetUIInfo (SClassUIInfo *uiInfo)
	Allows developer to provide some additional information on a superclass.
CoreExport SClassUIInfo *	GetUIInfo () const
	This method returns additional user interface related information on a given superclass.
CoreExport void	ReplaceClass (int idx, ClassDesc *cld, int dllNum, int index, bool load)
	~SubClassList ()
	SubClassList (SClass_ID sid)

---

Constructor & Destructor Documentation

~SubClassList

(

)

Destructor

SubClassList

(

SClass_ID

sid

)

Constructor

---

Member Function Documentation

CoreExport ClassEntry& operator[]

(

int

i

)

const

Returns a reference to the 'i-th' ClassEntry for this super class.

Parameters:

i	- The index of the entry to return. Valid values begin at an index of 1.

CoreExport int FindClass

(

Class_ID

classID

)

const

Search for all occurrences

Returns the index in the list of sub-classes of the class whose Class_ID is passed.

Parameters:

classID

- Specifies which class to return the index of.

CoreExport int FindClass

(

const MCHAR *

name

)

const

Search for all occurrences

Returns the index in the list of sub-classes of the class whose ClassName() is passed.

Parameters:

name	- Specifies which class to return the index of.

CoreExport void AddClass	(	ClassDesc *	cld,
		int	dllNum,
		int	index,
		bool	load
	)

Search for all occurrences

This method is used internally.

CoreExport int Count

(

int

accType

)

const

Search for all occurrences

Returns the number of sub-classes that match the specified access type.

Parameters:

accType

- One of the following values: ACC_PUBLIC - public classes ACC_PRIVATE - non-public classes ACC_ALL - both of the above (ACC_PUBLIC|ACC_PRIVATE).

CoreExport SClass_ID SuperID

(

)

const

Search for all occurrences

Returns the Super class ID corresponding to this sub-class list.

CoreExport int GetFirst

(

int

accType

)

const

Search for all occurrences

Returns the index of the first ClassDesc of the specified type in the list of sub-classes.

Parameters:

accType

- One of the following values: ACC_PUBLIC - public classes ACC_PRIVATE - non-public classes

CoreExport int GetNext

(

int

accType

)

const

Search for all occurrences

Returns the index of the next ClassDesc of the specified type (or -1 at the end).

Parameters:

accType

- One of the following values: ACC_PUBLIC - public classes ACC_PRIVATE - non-public classes

CoreExport int operator==

(

const SubClassList &

lst

)

const

Equality operator.

CoreExport int operator==

(

const SubClassList &

sl

)

Equality operator.

CoreExport int DeleteClass

(

ClassDesc *

cld

)

Search for all occurrences

CoreExport void SetUIInfo

(

SClassUIInfo *

uiInfo

)

Search for all occurrences

Allows developer to provide some additional information on a superclass.

Currently this includes a color, and a method which draws a representative image in a Windows DC.

Parameters:

uiInfo

- Points to the information to set.

CoreExport SClassUIInfo* GetUIInfo

(

)

const

Search for all occurrences

This method returns additional user interface related information on a given superclass.

Returns NULL if no superclass information was assigned.

CoreExport void ReplaceClass	(	int	idx,
		ClassDesc *	cld,
		int	dllNum,
		int	index,
		bool	load
	)

Search for all occurrences

This method is for internal use only.