Module cProcessStatusPanel.pkg
cProcessStatusPanel.pkg
Class used to create StatusPanels.
This class does not provide any of the inner objects that make up a status panel. Instead an
interface is provided that is used to update the various areas of status panel. At this level,
those areas (title area, message area, action area, button area) are logical. You create the
physical objects at the object level and then bind these objects to the interface.
Take a look at StatPnl.pkg to see how this is used.
the standard Interface for status panels are:
Send Initialize_StatusPanel - initializes values for caption, title & message
Send Start_StatusPanel - start the status panel
Send Stop_StatusPanel - stop the status panel
Send Update_StatusPanel - update the status panel's action area
Get Check_StatusPanel - check for cancel (if cancel or pbCancel is set, close the panel)
Get/Set Caption_Text - updates the caption bar
Get/Set Title_Text - updates the title area
Get/Set Message_Text - updates the Message area
Get/Set Action_Text - updates the action area
Get/Set Button_Text - updates the button area
Get/Set Allow_cancel_state - determines if panel can be canceled
Send EnableCancelButton - code must be provided in the cancel button object to enable/disable cancel button
cProcessStatusPanel.pkg (view source)- import declarations
- cProcessStatusPanel : cStatusPanel
Construct_Object()
Set(string sText)
Any of the properties that change the text of a status panel must also send
ProcessEvents which allows the panel to process painting messages. The ProcessEvents
is essential when using status panels within a tight loop
- string
Caption_Text()
Set(String sText)
- string
Message_Text()
Set(String sText)
- string
Action_Text()
Set(String sText)
- string
Button_Text()
Set(String sText)
- string
Title_Text()
Initialize_StatusPanel(String sCaption String sTitle string sMessage)
initializes values for caption, title & message
Update_StatusPanel(String sAction)
update the status panel's action area
Close_Panel()
stop the status panel
EnableCancelButton(boolean bEnable)
Code must be provided in the cancel button object to enable/disable cancel button
- integer
Check_StatusPanel()
check for cancel (if cancel or pbCancel is set, close the panel)
- Boolean
bCancel
Start_StatusPanel()
start the status panel
Stop_StatusPanel()
stop the status panel
References (1):
Field References (0):
Module | Containing Symbol | Line |
---|