API Docs for:
Show:

GSDocumentTree Class

A document tree shows a hierarchical structure of documents like scenes or chapters and allows the user to select a document. It stores only the UID of the document. It is useful if you like to let the user select a scene or another type of document.

Properties

autoLoad

Boolean

Indicates if a document automatically gets loaded on selection. In most cases that isn't necessary.

BindingSignal.[itemName]

Object

Allows to send any item of the selected document's items collection.

BindingSlot.[itemName]

Object

Allows to set any item of the selected document's items collection.

controller

String

Name of the internal tree-controller class used for the view. It can be one of the following values:

  • GSDocumentTreeController - General Document Controller
  • GSVNSceneTreeController - Scene Document Controller. Provides additional actions and handling for scenes.

documentTypes

String

Array of document types like vn.scene, vn.chapter, etc.

headerText

String

The header-text for the tree-view. If not present the header-line is hidden.

outline

Boolean

Indicates if the tree-view should have an outline/border.

readOnly

Boolean

Indicates if documents can only be selected without options to edit, delete or add documents.

rootHidden

Boolean

Indicates if the root-node, which is the project-document, will be hidden.