| Python Script Engine 8.3 GL Studio Editor Python Script API

Public Member Functions | List of all members
DocumentArray Class Reference

## Public Member Functions
| DocumentArray ()
unsigned int | GetCount ()
Document * | GetObjectByIndex (unsigned int index)

## Detailed Description

Common editor interface Document array helper class.

## Constructor & Destructor Documentation

## ◆ DocumentArray()

DocumentArray::DocumentArray | ( |  | ) |

default ctor

## Member Function Documentation

## ◆ GetCount()

unsigned int DocumentArray::GetCount | ( |  | ) |

get the number of elements in the array

Returns
  the number of elements in the array

## ◆ GetObjectByIndex()

Document * DocumentArray::GetObjectByIndex | ( | unsigned int | index | ) |

Returns an item based on index.

Parameters

  index | the index of the item to be returned

Returns
  the Document at the given index

Exceptions

  CEIException | if index is invalid

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

- Editor.i