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 Node 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 (String viewName=String())
	Returns the drawing tool manager. More...
QPoint	viewPosition (String viewName)
	Returns the position of the top left corner of the given view. More...
StringList	viewList (String viewType=String())
	Returns a list of available views of the given type. More...

Detailed Description

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

function viewScript()
{
  var myView = view.currentView();
  MessageLog.trace(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

viewName

The current view value, as returned by the currentView function.

Returns

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

currentToolManager

QObject* view::currentToolManager ( String  viewName = String() )

slot

Returns the drawing tool manager.

If no argument is passed, returns the drawing tool manager from the current view.

Parameters

viewName

: The name of the view to get the drawing tool manager from.

Returns

The drawing tool manager of the given view. Can be null.

currentView

String view::currentView ( )

slot

Returns a unique identifier for the current, active view.

Returns

A unique identifier for the current, active view.

group

String view::group ( String  viewName )

slot

Returns the name of the current Group Node in the active Network View.

Parameters

viewName

: The current view value, as returned by the currentView function.

Returns

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

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

viewName

: The current view value, as returned by the currentView function.

Returns

A string that indicates what type of View the currentView is.

viewList

StringList view::viewList ( String  viewType = String() )

slot

Returns a list of available views of the given type.

Parameters

viewType

: The type of view to get the list of available views for.

Note

If no parameter is passed, the list will contain every available view.

Returns

Returns an array of view names.

viewPosition

QPoint view::viewPosition ( String  viewName )

slot

Returns the position of the top left corner of the given view.

The point (0,0) is the top left corner of the main display.

Parameters

viewName

: The name of the view to get the position of.

Returns

Returns the position of the view in pixels.