Published Interface
- Last UpdatedMar 28, 2023
- 1 minute read
The main components to the event control system that are available to the AppWare developer can be split into three main sections:
Adding/Removing Events
Methods for adding and removing event packets to and from the event system:
|
Name |
Result |
Action |
|
.add(EDGPACKET) |
BOOLEAN |
Add the passed event packet to the system, making it active. |
|
.remove(STRING) |
Removes the first event packets with the passed event packet description from the system. |
Modifying Active/Stacked Events
Methods used to modify event packets within the event system:
|
Name |
Result |
Action |
|
.setPrompt(STRING) |
Sets the primary prompt of the currently active event. |
|
|
.setPrompt(STRING, STRING) |
Sets the primary and secondary prompt of the currently active event. |
|
|
setStackPrompt(STRING, STRING) |
Sets the primary prompt of the stacked event with the passed description. |
Viewing Stack Contents
Methods used to view the current contents for the event system:
|
Name |
Result |
Action |
|
.viewStack() |
Displays the currently active and stacked event in the system. |
|
|
.viewStack(REAL) |
Display the event at the specified stack position, zero will display the currently active event. |
Note:
All members and methods not defined within the table should be classed as being private to the control object.
Therefore, AppWare developer should never use them when writing applications.