Python Script Engine  8.3
GL Studio Editor Python Script API
Highlighter.i File Reference

Classes

class  Highlighter
 

Functions

HighlighterCreateHighlighter (str objectName)
 
HighlighterCreateMenuHighlighter (str menuName, str actionName)
 
HighlighterCreateCodeBrowserContextMenuHighlighter (str actionName)
 
HighlighterCreateTabHighlighter (str tabName)
 
HighlighterCreateGeometryBrowserHighlighter (str objectName, int columnIndex)
 
HighlighterCreateTitleBarHighlighter (str objectName)
 
HighlighterCreateObjectPropertyHighlighter (str propertyName)
 
None ClearHighlighters ()
 
HighlighterCreateCodeBrowserHighlighter (str identifierName)
 
HighlighterCreateToolboxHighlighter (str objectName)
 

Detailed Description

Function Documentation

◆ ClearHighlighters()

None ClearHighlighters ( )

◆ CreateCodeBrowserContextMenuHighlighter()

Highlighter * CreateCodeBrowserContextMenuHighlighter ( str  actionName)

Create a Highlighter for the code brower's context menu actions.

Parameters
actionNamethe name of the editor action object
Returns
the created highlighter or NULL if the action object couldn't be found

◆ CreateCodeBrowserHighlighter()

Highlighter * CreateCodeBrowserHighlighter ( str  identifierName)

Create a Highlighter for an element of the code browser.

Parameters
identifierNamethe name of the object
Returns
the created highlighter or NULL if the object couldn't be found

◆ CreateGeometryBrowserHighlighter()

Highlighter * CreateGeometryBrowserHighlighter ( str  objectName,
int  columnIndex 
)

Create a Highlighter for an entry in the Geometry Browser.

Parameters
objectNamethe name of the object
columnIndexthe index of the column to highlight
Returns
the created highlighter or NULL if the object couldn't be found

◆ CreateHighlighter()

Highlighter * CreateHighlighter ( str  objectName)

Create a Highlighter.

Parameters
objectNamethe name of the editor object
Returns
the created highlighter or NULL if the object couldn't be found

◆ CreateMenuHighlighter()

Highlighter * CreateMenuHighlighter ( str  menuName,
str  actionName 
)

Create a Highlighter for File Menu actions.

Parameters
menuNamethe name of the parent menu for the incoming action
actionNamethe name of the editor action object
Returns
the created highlighter or NULL if the action object couldn't be found

◆ CreateObjectPropertyHighlighter()

Highlighter * CreateObjectPropertyHighlighter ( str  propertyName)

Create a Highlighter for an element of the Object Properties table.

Parameters
propertyNamethe name of the property
Returns
the created highlighter or NULL if the object couldn't be found

◆ CreateTabHighlighter()

Highlighter * CreateTabHighlighter ( str  tabName)

Create a Highlighter for a Dock Tab.

Parameters
tabNameThe name of the editor object.
Returns
The created highlighter or NULL if the object couldn't be found.

◆ CreateTitleBarHighlighter()

Highlighter * CreateTitleBarHighlighter ( str  objectName)

Create a Highlighter for an item on the TitleBar.

Parameters
objectNamethe name of the object
Returns
the created highlighter or NULL if the object couldn't be found

◆ CreateToolboxHighlighter()

Highlighter * CreateToolboxHighlighter ( str  objectName)

Create a Highlighter for an item in the creation toolbox.

Parameters
objectNamethe name of the object
Returns
the created highlighter or NULL if the object couldn't be found