stbWebWindow

stbWebWindow

Tutorials:

stbWebWindow provides API to a web window functionality.

Methods

(static) windowId() → {number}

Get window ID.

Returns:

id

Type
number

(static) messageSend(windowId, message, dataopt)

Send message "message" with data "data" to window ID "windowId".
Message can be handled using callback stbEvent.onMessage(data) which should be defined in target window.

Parameters:
Name Type Attributes Description
windowId number

receiver

message string

id of the message

data string <optional>

message text

(static) messageBroadcast(message, data)

Send message "message" with data "data" to all existed windows.
Message can be handled using callback stbEvent.onBroadcastMessage(data)

Parameters:
Name Type Description
message string
data string

(static) close()

Close window

(static) SendVirtualKeypress(unicodeText, key)

Generate virtual key event using Unicode text "unicodeText" and QT key code "key".
Exists only in virtual keyboard window.

Parameters:
Name Type Description
unicodeText string
key number

(static) SetFullScreenMode(mode)

Set full screen mode for dedicated "Wild Web" window.
Exists only in WebFace window.

Parameters:
Name Type Description
mode boolean

possible values:

Value Description
true maximized mode
false normal mode

(static) SetZoomFactor(ratio)

Set zoom ratio for embedded web browser.
Exists only in WebFace window.

Parameters:
Name Type Description
ratio number

zoom ratio, percent [10..1000]

(static) getCurrentUrl() → {string}

Get currently opened URL.
Exists only in WebFace window.

Returns:
Type
string

(static) NavigateBack()

Go back in the navigation history.
Defined only for dedicated "Wild Web" window.
Exists only in WebFace window.

(static) NavigateForward()

Go forward in the navigation history.
Defined only for dedicated "Wild Web" window.
Exists only in WebFace window.

(static) ReloadDocument()

Reload current web document.
Exists only in WebFace window.

(static) StopLoading()

Cancel loading web document.
Exists only in WebFace window.

(static) FocusTopWindow()

Deprecated:
  • Yes

Give the focus to the top web browser frame.
Exists only in WebFace window.

(static) FocusMiddleWindow()

Deprecated:
  • Yes

Give the focus to the main web browser frame.
Exists only in WebFace window.