Tutorial User Guide > User Interface Functions > Main Panel
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Main Panel
  
AAUI.mainpanel_include_steps
(num_steps, step_ids, completed, step_names)
 
Description:
This function will display the analysis steps in the main step selection box. It is called by the function AAI.allsteps_display() which reads the drive pages and obtains the information to display.
Input:
INTEGER
num_steps
This value specifies the number of analysis steps to create switch items for.
STRING
step_ids[4](num_steps)
This value specifies the step ids or labels for the switch items. Note: multi-byte characters are NOT allowed for step ids.
STRING
completed[1](num_steps)
This value specifies whether a step is completed or not. The single character values will be a blank, a ‘C’ or an ‘X’ indicating “not tested yet”, “completed”, or “completion test failed” respectively.
STRING
step_names[36](num_steps)
This value specifies the descriptions assigned to the steps.
Output:
Error Conditions:
None
Remarks:
Note that the application author is not expected to make this call. The function AAI.allsteps_display is typically called upon completion of analysis step-1 after the “NEXTPAGE” user response variable is recorded.
Example:
None
AAUI.mainpanel_current_step
(step_id)
Description:
This function will provide the step id label for the current step as selected on the UI main panel. If no step is currently selected, the value returned will be the last step that was previously selected.
Input:
Output:
STRING
step_id[4]
This value returns the current step id.
Error Conditions:
None.
Remarks:
None
Example:
None
AAUI.mainpanel_step_complete
(step_id, complete)
Description:
This function will change the display of the completeness indicator for an analysis step displayed in the main step selection box.
Input:
STRING
step_id[4]
This value specifies the step id that will be modified.
STRING
complete[1]
This value specifies the value the completion indicator will be set to. The values “ “ (blank), “C” or “X” are expected in normal practice.
Output:
Error Conditions:
None.
Remarks:
Note that calling this function changes the “main panel” display only. Usually an additional call to AASTATE.record_ur_string, 88 is also made to record the completion indicator in the State Table.
Example:
None.
AAUI.mainpanel_lock_steps
()
Description:
This function will disable the main step selection box widget so that a user cannot make a new step selection. This is useful to force the completion of one step before another can be selected.
Input:
Output:
Error Conditions:
None.
Remarks:
Note that a call to AAUI.mainpanel_step_complete, 107 will not successfully change the display while steps are locked. Steps must be unlocked before changing the display.
Example:
None
AAUI.mainpanel_unlock_steps
()
Description:
This function will reverse the action of the lock_steps function, enabling the main step selection box switches to be selected. Unlocking also enables any subsequent display change of completion indicators.
Input:
Output:
Error Conditions:
None.
Remarks:
None
Example:
None
AAUI.mainpanel_unselect_steps
()
Description:
This function will change the state of the main step selection box switch widget to a null state, so that no analysis step is currently selected.
Input:
Output:
Error Conditions:
None.
Remarks:
This call is typically made as part of a step_wrapup() function at the conclusion of each analysis step. It is also useful to call in conjunction with an error dialog that excludes the user from executing the selected step.
Example:
None
AAUI.switch_highlight
(step_id)
Description:
This function selects a step on the UI form “main step selection box” in an automated mode. This is a software method of selecting a step as opposed to having the user select the step manually.
Input:
STRING
step_id[4]
This value specifies the step id that will be highlighted.
Output:
INTEGER
 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
A good use for this function is to create an automatic process which cycles until a particular condition has been satisfied. Alternatively, the author may choose to write applications with all automated step selection. In this case, the step selection box serves as a status indicator only.
Example:
None
AAUI.switch_highlight_restorer
(step_id)
Description:
This function is automatically called by the platform software upon re-opening an existing database. This function automatically selects the correct step for continuing, and precisely the next dialog for the user to act upon.
Input:
STRING
step_id[4]
This value specifies the step id that will be highlighted.
Output:
INTEGER
 
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
None.
Remarks:
The application author is not expected to use this function call. The platform software automatically invokes this call upon re-opening of an existing database. See the function AAUI.switch_highlight, 109 for automated cycling through steps.
Example:
None