Python Script Engine  1.0
GL Studio Editor Python Script API
DocumentArray Class Reference

Public Member Functions

 DocumentArray ()
 
unsigned int GetCount ()
 
DocumentGetObjectByIndex (unsigned int index)
 

Detailed Description

Common editor interface Document array helper class.

Constructor & Destructor Documentation

DocumentArray::DocumentArray ( )

default ctor

Member Function Documentation

unsigned int DocumentArray::GetCount ( )

get the number of elements in the array

Returns
the number of elements in the array
Document* DocumentArray::GetObjectByIndex ( unsigned int  index)

Returns an item based on index.

Parameters
indexthe index of the item to be returned
Returns
the Document at the given index
Exceptions
CEIExceptionif index is invalid

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