UserComponentList Class Reference

UserComponentList class is used to manage the list of UserComponent objects. It enables to create, duplicate, and delete a user component.
The class can be called from Application class.
. More...

Public Member Functions
UserComponent *	CreateUserComponent (String &name)
	Creates a user component object by specifying a name. More...
void	DeleteUserComponent (Variant &val)
	Deletes the user component specified with its name or index. More...
void	DeleteUserComponentByObject (UserComponent *object)
	Deletes the user component specified with its UserComponent object. More...
UserComponent *	GetUserComponent (Variant &val)
	Returns the user component. More...
bool	IsSingleton ()
	Since this is an internal function, it is not officially supported. More...
bool	IsValid ()
	Returns True if an object is valid. More...
int	NumUserComponents ()
	Returns the number of user components. More...

Detailed Description

UserComponentList class is used to manage the list of UserComponent objects. It enables to create, duplicate, and delete a user component.
The class can be called from Application class.
.

Example of calling the class object:

app.GetUserComponentList()

Member Function Documentation

UserComponent * UserComponentList::CreateUserComponent

(

String &

name

)

Creates a user component object by specifying a name.

Parameters

name	Name of the user component

Returns

UserComponent object

void UserComponentList::DeleteUserComponent

(

Variant &

val

)

Deletes the user component specified with its name or index.

Parameters

val	Name or index of the user component

void UserComponentList::DeleteUserComponentByObject

(

UserComponent *

object

)

Deletes the user component specified with its UserComponent object.

Parameters

object

UserComponent object

UserComponent * UserComponentList::GetUserComponent

(

Variant &

val

)

Returns the user component.

Parameters

val	Name or index of the user component

Returns

UserComponent object

bool UserComponentList::IsSingleton

(

)

Since this is an internal function, it is not officially supported.

Deprecated:

bool UserComponentList::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the user component objects in the list are valid

int UserComponentList::NumUserComponents

(

)

Returns the number of user components.

Returns

Number of user components