DzCallBack Class Reference

DAZ Script callback object. More...

Inheritance diagram for DzCallBack:

List of all members.

Methods
void	addToGroup (String group)
void	clearConnection ()
Object	getArg (Number which)
Number	getArgCount ()
Array	getGroups ()
String	getScript ()
Object	getSender ()
Boolean	isEvaluated ()
void	removeFromGroup (String group)
Boolean	setConnection (Object sender, String signal)
void	setScript (String script, Boolean evaluate)

---

Detailed Description

DAZ Script callback object.

Todo:

Provide descriptions.

See also:

DzCallBackMgr::createCallBack(), DzCallBackMgr::getCallBack()

---

Member Function Documentation

void DzCallBack::addToGroup

(

String

group

)

Adds the callback to the given callback group.

Parameters:

group

The name of the group to add the callback to.

void DzCallBack::clearConnection

(

)

Disconnects from the signal that triggers this callback.

Object DzCallBack::getArg

(

Number

which

)

Returns:

The i'th argument from the current execution of the callback.

Number DzCallBack::getArgCount

(

)

Returns:

The number of arguments for the current execution of the callback.

Array DzCallBack::getGroups

(

)

Returns:

A list of the groups that this callback belongs to.

String DzCallBack::getScript

(

)

Returns:

The script that is executed when the signal is emitted.

Object DzCallBack::getSender

(

)

Returns:

The object that sent the signal, or NULL.

bool DzCallBack::isEvaluated

(

)

Returns:

true if the script text for this callback is the actual code that gets executed, false if the script text contains the filename of the script to execute.

void DzCallBack::removeFromGroup

(

String

group

)

Removes the callback from the given callback group.

Parameters:

group

The name of the group to remove the callback from.

Boolean DzCallBack::setConnection	(	Object	sender,
		String	signal
	)

Makes the connection that triggers this callback.

Parameters:

	sender	The object that the signal belongs to.
	signal	The signature of the signal to connect to.

void DzCallBack::setScript	(	String	script,
		Boolean	evaluate
	)

Sets the script that will be executed by this callback.

Parameters:

	script	The filename or actual text of the script to execute
	evaluate	If true, the given script is the actual code that should be evaluated, otherwise, it is assumed that the given text is the name of a script file to execute.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.