TolliumScreenBase (open)
The object for Tollium nodes
Syntax
LOADLIB "mod::tollium/lib/screenbase.whlib";
OBJECTTYPE TolliumScreenBase
Description
The TolliumScreenBase is the base object for every screen in tollium and gives you access to the Tollium framework
Constructor
Variables
- OBJECT frame
Frame object
- OBJECT parentscope (inherited from TolliumScope)
- BOOLEAN pvt_tolliumframeinitrun
- BOOLEAN pvt_tolliumframepreinits
- RECORD ARRAY tolliumdirtysubscreens
List of subscreens that have visible dirty components
- RECORD ARRAY tolliumdirtyvisiblecomponents
List of components that are both now visible (isnowvisible is true) and are dirty
- STRING tolliumresult
The return value for this dialog. Setting this member closes the dialog
- OBJECT tolliumscreenbuilder
- OBJECT tolliumscreenmanager
Properties
- PROPERTY contexts
Context object
- PROPERTY tolliumcontroller
The controller that constructed this screen
- PROPERTY tolliummodule
- PROPERTY tolliumparent
The screen that created this screen (default object if we're a top level window)
- PROPERTY tolliumscreenid
Screen ID - different for each screen, never changes after allocation
- PROPERTY tolliumscreenname
- PROPERTY tolliumuser
The user accessing this screen
- PROPERTY ^
Access all components through ^
Functions
- OBJECT FUNCTION BeginFeedback()
Begin transactional work
- OBJECT FUNCTION BeginLockedUnvalidatedWork(STRING mutex)
Begin transactional work without automatic validation, while keeping a mutex locked
- OBJECT FUNCTION BeginLockedWork(STRING mutex)
Begin transactional work with automatic validation, while keeping a mutex locked
- OBJECT FUNCTION BeginUnvalidatedFeedback()
Begin a feedback session without automatic validation
- OBJECT FUNCTION BeginUnvalidatedWork()
Begin transactional work without automatic validation
- OBJECT FUNCTION BeginWork(RECORD options)
Begin transactional work
- OBJECT FUNCTION CreateCustomComponent(STRING namespace, STRING type, RECORD options)
Create a custom component
- OBJECT FUNCTION CreateTolliumComponent(STRING type, RECORD options)
Create a tollium component
- RECORD ARRAY FUNCTION DoLoadComponents(RECORD ARRAY formobjects, OBJECT screenbuilder)
- RECORD FUNCTION GetDragType(STRING wanttype)
- BOOLEAN FUNCTION GetExclusiveAccess(RECORD tag, RECORD options)
Request exclusive access to a resource
- BOOLEAN FUNCTION GetExclusiveAccessForAction(RECORD tag, RECORD options)
Request exclusive access for running an action. Upon steal, exclusive access is released immediately and dialogs are cancelled with tolliumresult="".
- STRING FUNCTION GetHTMLTid(STRING localtid, STRING p1, STRING p2, STRING p3, STRING p4)
- STRING FUNCTION GetTid(STRING localtid, STRING p1, STRING p2, STRING p3, STRING p4)
- OBJECT FUNCTION LoadScreen(STRING name, RECORD params, RECORD options)
Open an application-defined screen
- RECORD FUNCTION LoadTolliumBodyFragment(RECORD ARRAY localrefs, RECORD ARRAY localhandlers, STRING resource, STRING resourcetype)
Load a XML document fragment as a collection of tollium lines (experimental function, will be removed in the future)
- MACRO RegisterLocalDragType(STRING name, STRING ARRAY flags)
- STRING FUNCTION RunMessageBox(STRING name, STRING p1, STRING p2, STRING p3, STRING p4)
Request a predefined message box (avoid - use ShowMessageBox in new applications)
- STRING FUNCTION RunModal()
Run this window in modal mode
- VARIANT FUNCTION RunScreen(STRING screen, RECORD initdata, RECORD options)
Load a screen and run it
- STRING FUNCTION RunSimpleScreen(STRING type, STRING message, RECORD options)
Display a simple screen with a yes/no or ok/cancel dialog
- STRING FUNCTION ShowMessageBox(STRING message, RECORD options)
- MACRO TolliumCloseScreen()
- BOOLEAN FUNCTION TolliumExecuteCancel()
- BOOLEAN FUNCTION TolliumExecuteSubmit()
- MACRO TolliumInitializeScreen(RECORD params)
- MACRO TolliumIsSubScreenChange(BOOLEAN add)
- MACRO TolliumSetComponentVisibleDirtyness(OBJECT component, BOOLEAN visibly_dirty)
- MACRO TolliumSetSubScreenDirtyness(OBJECT screen, BOOLEAN dirty, OBJECT component)
- OBJECT FUNCTION Tollium_GetPrivatePtr() (inherited from TolliumScope)