TolliumControllerBase (open)
The Tollium controller controls the tollium environment
Syntax
LOADLIB "mod::tollium/lib/internal/controllerbase.whlib";
OBJECTTYPE TolliumControllerBase
Constructor
Variables
- BOOLEAN debugging
Indicates whether debugging is enabled
- BOOLEAN forceallpublic
- BOOLEAN objectprofiling
- FUNCTION PTR onsessionexpired
Callback called when the session has expired
- FUNCTION PTR onsessionexpireschange
Callback called when the session expiry changes
- FUNCTION PTR onuseractivity
Callback called when the user initiates activity
- INTEGER profiling
- STRING ARRAY pvt_inapppath
experimental: directly execute app actions
- FUNCTION PTR pvt_sendinitialmessage
Fptr where initial startup message (with init & link data) will be sent to
- OBJECT ARRAY windowstack
List of visible screens (FIXME should not be writable!)
Properties
- PROPERTY appicon
Application icon
- PROPERTY applicationtarget
Application target data (RECORD)
- PROPERTY apptitle
Application title
- PROPERTY baseurl
- PROPERTY contexts
Tollium contexts
- PROPERTY issueflag
Issue flag
- PROPERTY isvalidation
Are we loading the current screen for validation only, and will not be actually starting it?
- PROPERTY secure
Whether the interface runs on https
- PROPERTY sessionexpires
- PROPERTY startupoptions
The original startup options/context for this application. Used for subapps
- PROPERTY tolliumuser
- PROPERTY type
Controller type
- PROPERTY user
Current user
- PROPERTY userapi
The user api
- PROPERTY wrdauthplugin
The WRD auth plugin (if available)
Functions
- MACRO ActivateWebController()
- BOOLEAN FUNCTION AddFavorite(STRING app, RECORD target, RECORD message, STRING title, STRING icon)
- MACRO CloseUploadFor(RECORD file_or_dragdata)
Abandon an upload session
- MACRO EnsureVisibleScreen(OBJECT screen)
- OBJECT FUNCTION ExecuteClientCall(STRING type, VARIANT ARRAY params)
- MACRO ExitApplication()
- OBJECT FUNCTION GetAsyncFileTransferAction(OBJECT component, STRING ftid, BOOLEAN create)
- OBJECT FUNCTION GetAsyncObject(OBJECT component, STRING type, STRING ftid, BOOLEAN create)
Creates/returns an async action object
- RECORD FUNCTION GetClientInfo()
Returns info about the client
- STRING FUNCTION GetClientState(RECORD options)
Request client to send its state to us. Warning: experimental! Interval won't run and callbacks may occur from within this function.
- STRING FUNCTION GetComponentFileTransferURL(OBJECT component, STRING type, RECORD data, RECORD options)
- RECORD FUNCTION GetDynamicDocumentationInfo(STRING doclink)
- RECORD FUNCTION GetGlobalDragType(STRING wanttype)
- MACRO HandleControllerMessage(RECORD msg)
- RECORD FUNCTION HandleDragout(RECORD draginfo)
- BOOLEAN FUNCTION IsTrustedToDebug()
Would we trust this user with the debugger or other 'raw' access ?
- MACRO LaunchApplication(STRING appname, RECORD data)
- OBJECT FUNCTION LoadBackgroundTask(OBJECT screen, STRING lib, STRING objname, RECORD data)
Runs a background task
- OBJECT FUNCTION LoadScreen(STRING name, RECORD params, RECORD options)
- MACRO MarkChildrenScreensAsStolen(OBJECT parentscreen)
- MACRO MarkScreenAsStolen(OBJECT screen)
- MACRO OpenAppDocumentation(STRING url, RECORD options)
- OBJECT FUNCTION PVT_LoadScreen(RECORD loaddata)
- MACRO RestartApplication(RECORD options)
Restarts this application in the frontend, optionally updating the application target and sending a message
- STRING FUNCTION RunMessageBox(STRING name, STRING p1, STRING p2, STRING p3, STRING p4)
- MACRO RunModalScreen(OBJECT screen)
- VARIANT FUNCTION RunScreen(STRING screen, RECORD initdata, RECORD options)
- STRING FUNCTION RunSimpleScreen(STRING type, STRING message, RECORD options)
- MACRO SendAppLevelMessage(STRING type, RECORD data)
- MACRO SendApplicationMessage(STRING app, RECORD apptarget, RECORD messagedata, BOOLEAN reuse_instance)
Send a message to an application, launch it if needed
- MACRO SendComponent(OBJECT comp, RECORD data)
- MACRO SendComponentReadonly(OBJECT comp, STRING value, BOOLEAN wordwrap)
- MACRO SendComponentUpdate(OBJECT comp, RECORD updinfo)
- MACRO SetupDynamicDocumentation(STRING baseurl, RECORD options)
Setup dynamic embedded documentation
- STRING FUNCTION ShowMessageBox(STRING message, RECORD options)
- MACRO StartApplication(STRING app, RECORD target, RECORD message, RECORD options)
Send a message to an application, launch it if needed
- BOOLEAN FUNCTION Tollium_ParsePendingEvents()