Harmony
Scripting Interface Documentation
view Class Reference

The view JavaScript global object. Provides information about the contents of selected View windows. More...

Public Slots

String currentView ()
 returns a unique identifier for the current, active View. More...
 
String type (String viewName)
 returns a string that indicates what type of View the currentView is. More...
 
String group (String viewName)
 returns the name of the current Group Module in the active Network View. More...
 
String column (String viewName)
 returns the name of the column for the currently displayed function in the Function View. More...
 
void refreshViews ()
 forces a refresh of the drawing and scene planning views. More...
 
QObject * currentToolManager ()
 returns the drawing tool manager. More...
 

Detailed Description

The view JavaScript global object. Provides information about the contents of selected View windows.

function viewScript()
{
var myView = view.currentView();
System.println(view.type(myView));
}

Member Function Documentation

◆ column

String view::column ( String  viewName)
slot

returns the name of the column for the currently displayed function in the Function View.

Parameters
viewNameThe current view value, as returned by the currentView function.

◆ currentToolManager

QObject* view::currentToolManager ( )
slot

returns the drawing tool manager.

◆ currentView

String view::currentView ( )
slot

returns a unique identifier for the current, active View.

◆ group

String view::group ( String  viewName)
slot

returns the name of the current Group Module in the active Network View.

Parameters
viewNameThe current view value, as returned by the currentView function.

◆ refreshViews

void view::refreshViews ( )
slot

forces a refresh of the drawing and scene planning views.

◆ type

String view::type ( String  viewName)
slot

returns a string that indicates what type of View the currentView is.

Parameters
viewNameThe current view value, as returned by the currentView function.