setInputFocus()

Sets the input focus.

Synopsis

int setInputFocus (string|shape object);

int setInputFocus (string moduleName, string panelName, string shapeName);

int setInputFocus (string panelName, string shapeName);

Parameters

Parameter Description
object Name of the object.
moduleName Name of the module
panelName Name of the panel
shapeName Name of the graphics object

Return value

In the event of errors -1, otherwise 0.

Description

This function sets the input focus to the given object. Either in the module "moduleName", in the panel "panelName" to the graphics object "shapeName", in the panel "panelName" to the graphics object "shapeName" or to the object "object".

The focus is only visible if the config entry "showInputFocus = 1" is set in the VISION (see also config entries for the User interface)!

Example

main()
{
  setInputFocus(myModuleName(), myPanelName(), "shape3");
}

Assignment

Graphics

Availability

UI