FormIt.UI API

Description

Functions
json	FormIt.UI.LoadLangPack (filename)
	LoadLangPack loads the JSON with file name filename and populates the component in the dictionary named component.
json	FormIt.UI.Getbcp47NameCode ()
	Get FormIt Locale name code Parameters: In: Out: QT Locale name string code
json	FormIt.UI.TranslationLookup (value)
	Translate lookup a English string Looks up an English string through all of the components from the current loaded language string files.
json	FormIt.UI.AddorReplaceTranslation (Component, EnglishString, TranslatedString)
	Add or replace an English string to Translate lookup with its corresponding translation
json	FormIt.UI.CreatePanel (title, url)
	CreatePanel creates a dockable panel with the given name and displays the given URL.
json	FormIt.UI.CreateToolbar (tbJSON, URL)
	CreateToolbar creates a toolbar with the structure given by the passed in JSON.
json	FormIt.UI.ShowNotification (message, notificationType, nTimeout)
	ShowNotification displays a notification message to the user.
json	FormIt.UI.CloseNotification (notificationHandle)
	CloseNotification closes notification message being displayed related to the notificationHandle passed as input parameter.
json	FormIt.UI.HandleConfirmationResult (dialogId, isConfirming)
	HandleConfirmationResult reports the result of a confirmation dialog box.

Function Documentation

AddorReplaceTranslation()

json FormIt.UI.AddorReplaceTranslation	(	Component	,
		EnglishString	,
		TranslatedString
	)

Add or replace an English string to Translate lookup with its corresponding translation

Parameters: In: Translation component string (eg FormItUI, FormItCore, WSM or "") English string Translated string Out: translated string

Parameters

[in]	Component	String
[in]	EnglishString	String
[in]	TranslatedString	String

Returns

stringTrans

CloseNotification()

json FormIt.UI.CloseNotification

(

notificationHandle

)

CloseNotification closes notification message being displayed related to the notificationHandle passed as input parameter.

Parameters: In: handle Out: JSON_UNDEFINED

Parameters

[in]

notificationHandle

FormIt.NotificationHandle

Returns

JSON_UNDEFINED, i.e. {}

CreatePanel()

json FormIt.UI.CreatePanel	(	title	,
		url
	)

CreatePanel creates a dockable panel with the given name and displays the given URL.

Parameters: In: title, url Out: JSON_UNDEFINED FormIt.UI.CreatePanel("Hello Block!", "http://localhost:8000/hello_block.html");

Parameters

[in]	title	String
[in]	url	String

Returns

JSON_UNDEFINED, i.e. {}

CreateToolbar()

json FormIt.UI.CreateToolbar	(	tbJSON	,
		URL
	)

CreateToolbar creates a toolbar with the structure given by the passed in JSON.

Parameters: In: JSON description of toolbar Out: JSON_UNDEFINED

Parameters

[in]	tbJSON	String
[in]	URL	String

Returns

JSON_UNDEFINED, i.e. {}

Getbcp47NameCode()

json FormIt.UI.Getbcp47NameCode

(

)

Get FormIt Locale name code Parameters: In: Out: QT Locale name string code

Returns

{...}

HandleConfirmationResult()

json FormIt.UI.HandleConfirmationResult	(	dialogId	,
		isConfirming
	)

HandleConfirmationResult reports the result of a confirmation dialog box.

Parameters: In: dialogId (number) isConfirming (bool) Out: JSON_UNDEFINED

Parameters

[in]	dialogId	int
[in]	isConfirming	bool

Returns

JSON_UNDEFINED, i.e. {}

LoadLangPack()

json FormIt.UI.LoadLangPack

(

filename

)

LoadLangPack loads the JSON with file name filename and populates the component in the dictionary named component.

Parameters: In: filename Out: JSON_UNDEFINED

Parameters

[in]

filename

String

Returns

JSON_UNDEFINED, i.e. {}

ShowNotification()

json FormIt.UI.ShowNotification	(	message	,
		notificationType	,
		nTimeout
	)

ShowNotification displays a notification message to the user.

The nTimeout parameter is the time in ms that the notification should be displayed. A value of 0 means to use the default timeout. notificationType: FormIt.NotificationType.Unspecified FormIt.NotificationType.Information FormIt.NotificationType.Warning FormIt.NotificationType.Error FormIt.NotificationType.Success Parameters: In: message, notificationType, nTimeout (OPTIONAL) Out: NotificationHandle

Parameters

[in]	message	String
[in]	notificationType	FormIt.NotificationType
[in]	nTimeout	(OPTIONAL, default = 0) int

Returns

notificationHandle

TranslationLookup()

json FormIt.UI.TranslationLookup

(

value

)

Translate lookup a English string Looks up an English string through all of the components from the current loaded language string files.

And returns the first matching string.

Parameters: In: English string Out: translated string

Parameters

[in]

value

String

Returns

stringTrans