Standard Front-End Functions

Here are the built-in functions implemented by the front end in the "standard" module. Additional modules and functions are available for front ends, but are specific to the front-end type.

The names of front-end functions and predefined arguments are case-sensitive.

 

cbadd

Adds the text passed as an argument to the content of the clipboard of the front-end platform:

ui.Interface.frontCall("standard","cbadd", [text], [result])

text = text to be added

result = variable that holds results of the function execution (1 = success, 0 = error)

LyciaDesktop: yes

LyciaWeb: no

cbclear

Clears the content of the clipboard:

ui.Interface.frontCall("standard","cbсlear", [], [result])

result = variable that holds results of the function execution (1 = success, 0 = error)

Takes no input arguments.

LyciaDesktop: yes

LyciaWeb: no

cbget

Returns the current content of the clipboard:

ui.Interface.frontCall("standard","cbget", [], [text])

text = text found in the clipboard

Takes no input arguments.

LyciaDesktop: yes

LyciaWeb: no

cbpaste

Pastes the content of the clipboard to the current field:

ui.Interface.frontCall("standard","cbpaste", [], [result])

result = variable that holds results of the function execution (1 = success, 0 = error)

Takes no input arguments.

LyciaDesktop: yes

LyciaWeb: no

cbset

Sets the content of the clipboard:

ui.Interface.frontCall("standard","cbset", [text], [result])

text = text to be set

result = variable that holds results of the function execution (1 = success, 0 = error)

The text is passed as argument.

 LyciaDesktop: yes

 LyciaWeb: no

feinfo

Returns a front-end property value (according to the property name passed as the argument):

ui.Interface.frontCall("standard","feinfo", [name], [result])

name = name of the property

result = variable that holds results of the function execution (1 = success, 0 = error)

 LyciaDesktop: yes

 LyciaWeb: no

getenv

Returns the environment variable set in the user session on the front-end platform:

ui.Interface.frontCall("standard","getenv", [name], [value])

name = name of the environment variable

value = value of the environment variable.

 LyciaDesktop: yes

 LyciaWeb: no

getwindowid

Returns the local identifier that corresponds to the AUI window id passed as an argument, in the window manager where the front end is displaying application forms:

ui.Interface.frontCall("standard","getwindowid", [aui-win-id], [loc-win-id])

aui-win-id = id of the window node in the AUI tree:

OPEN WINDOW aui-win-id AT 5, 2 WITH 20 ROWS, 80 COLUMNS

loc-win-id = id of the window in the window manager where the front end is running

The node id must refer to a Window node: Otherwise, 0 is returned.

In the traditional mode, window widgets are simple frames.

Use 0 as an aui-win-id argument to get the top level window id in the local windowing system.

 LyciaDesktop,  LyciaWeb: server responds without requesting the client side

launchurl

Opens an URL with the default URL handler available on the front-end platform.

This is typically a web browser for HTTP: URLs, or the mailer for "mailto:" URLs, but the corresponding application may also be dedicated to the object type specified by the URL:

ui.Interface.frontCall("standard","launchurl", [url [,mode]], [])

url = URL to invoke

mode (optional) = front end specific meaning

launchurl is a powerful feature: Front-end applications can register themselves as URL handlers. So you can start applications on the front end through the lauchurl front call.

 LyciaDesktop: yes

 LyciaWeb: yes

opendir

Opens a file dialog window on the local file system where the end user can enter a directory path:

ui.Interface.frontCall("standard","opendir", [path,caption], [result])

path = default path

caption = caption to be displayed

result = name of the selected directory (or NULL if canceled)

If the user cancels the dialog, the front-call returns NULL for result.

 LyciaDesktop: yes

 LyciaWeb: no

openfile

Allows opening existing files: A file dialog window on the local file system is opened where the end user can enter the file path:

ui.Interface.frontCall("standard","openfile", [path,name,filetype,caption], [result])

path = default path

name = name to be displayed for the file type

filetype = file types (as a blank separated list of extensions)

caption = caption to be displayed

result = name of the selected file (or NULL if canceled)

If the user cancels the dialog, the front-call returns NULL for result.

 LyciaDesktop: yes

 LyciaWeb: no

savefile

Allows saving new files: A file dialog window on the local file system is opened where the end user can enter the file path:

ui.Interface.frontCall("standard","savefile", [path,name,filetype,caption], [result])

path = default path

name = name to be displayed for the file type

filetype = file types (as a blank separated list of extensions)

caption = caption to be displayed

result = name of the selected file (or NULL if canceled)

If the user cancels the dialog, the front-call returns NULL for result.

 LyciaDesktop: yes

 LyciaWeb: no

setwebcomponentpath

Defines the basic URL to find gICAPI web components files:

ui.Interface.frontCall("standard","setwebcomponentpath", [url], [])

url = basic URL to the web-component file:

For example, when web-component file is located in QUERIX_DIR/progs/wc02_action folder (web-component file should be present in program sources)

LET url ="http://localhost:9090/LyciaWeb/res/default/wc02_action"

LET url ="qx://application/wc02_action"

 LyciaDesktop: yes

 LyciaWeb: yes

shellexec

Opens a file on the front-end platform with the program associated with the file extension:

ui.Interface.frontCall("standard","shellexec", [document,action], [result])

document = document file to be opened

action (optional, ) = action to perform, related to the way the file type is registered in Windows Registry

result = variable that holds results of the function execution (1 = success, 0 = error)

To view documents which can be displayed by web browsers, it is better to use launchurl instead.

 LyciaDesktop: yes

 LyciaWeb: no