#include <elementinterface.h>

Inheritance diagram for Drawing:

Collaboration diagram for Drawing:

Public Slots
int	numberOf (int elementId)
	return the # of drawings in the element. More...

String	name (int elementId, int drawingIndex)
	return the drawing id. More...

bool	isExists (int elementId, String timing)
	return true if the given drawing exists in this element. More...

bool	create (int elementId, String timing, bool fileExists)
	create a drawing. More...

String	filename (int elementId, String drawingName)
	return the 'load' filename of this drawing. This filename may be in the temp folder or project folder. Before the project is actually saved, this is where the drawing must reside to be found by the application. More...

Detailed Description

provide an interface for iterating and manipulating the collection of drawings of an element

You can use it in Script Editor only.

Member Function Documentation

bool Drawing::create	(	int	elementId,
		String	timing,
		bool	fileExists
	)

slot

create a drawing.

Parameters

elementId	: the unique id of the element
timing	the proposed drawing name.
fileExists	: not used

Returns: true if new drawing created. false if not.

String Drawing::filename	(	int	elementId,
		String	drawingName
	)

slot

return the 'load' filename of this drawing. This filename may be in the temp folder or project folder. Before the project is actually saved, this is where the drawing must reside to be found by the application.

Parameters

elementId	the unique id of the element
drawingName	the drawing name

bool Drawing::isExists	(	int	elementId,
		String	timing
	)

slot

return true if the given drawing exists in this element.

Parameters

elementId	the unique id of the element
timing	the drawing name

String Drawing::name	(	int	elementId,
		int	drawingIndex
	)

slot

return the drawing id.

Parameters

elementId	the unique id of the element
drawingIndex

int Drawing::numberOf ( int elementId )

slot

return the # of drawings in the element.

Parameters

elementId the unique id of the element

The documentation for this class was generated from the following file:

dox_files/variableScript/elementinterface.h

Public Slots

Detailed Description

Member Function Documentation