Tutorial User Guide > User Interface Functions > Buttons
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Buttons
AAUI.sthelp_helpcb
()
Description:
This function will be called as part of the call back from the Help button. It will call AAI.step_help_doc, 130 in order to display a help document in the Browser.
Input:
Output:
Error Conditions:
None.
Remarks:
The application author is not expected to use this call.
Example:
None.
AAUI.helpdoc_display
(doc_URL)
Description:
This function will display any specified HTML document available on the file system, or display any http: URL address.
Input:
STRING
doc_URL[]
This value specifies the path or URL address for the document to be displayed by the commercial browser that is used for auxiliary display.
Output:
Error Conditions:
None.
Remarks:
This call spawns the auxiliary HTML browser display as a separate process. Once initiated there is no further communication available to change the browser display or to close the process.
The format for the doc_URL argument can reference either a local file (relative or absolute path) or a http address. For relative path references, the home drive page directory defined by the environment variable ACUMEN_APPLICATIONS is appended onto the beginning of the relative path.
 
Important:  
Because of parsing issues, the format for http references needs to be “http_//www....” instead of http://www....”.
Example of a relative path for doc_URL:
AAUI.helpdoc_display(“helpdocs/st2help.html”)
Example of an absolute path for doc_URL:
AAUI.helpdoc_display(“d:/testing/step_test/helpdocs/st2help.html”)
Example of a web address for doc_URL:
AAUI.helpdoc_display(“http_//www.macsch.com/helpdocs/st2help.html”)
AAUI.quickreview_quickcb
()
Description:
This function will post the Quick Review form to the screen. This is called as part of the callback from the “Quick Review” button. The Quick Review form displays user response variables from the State Table as indicated by the <uresponse> tags for each analysis step.
Input:
Output:
Error Conditions:
None.
Remarks:
The application author is not expected to make this call.
Example:
None
AAUI.quit_quitcb
()
Description:
This function will close down the MSC Acumen GUI. This is called as part of the callback for the “Quit” button.
Input:
Output:
Error Conditions:
None.
Remarks:
This call is also useful as a method to close down the application from a hyertext link selection. This method of quitting is preferred over the MSC Patran built-in PCL call to close down the database and quit, because it also provides for storing the current contents of the memory State Table to the modeling database before shutting down.
Example:
None
AAUI.backup_backupcb
()
Description:
This function will cause the dialog to back up to the previous dialog. This call is made as part of the callback to the “Dialog Backup” button.
Input:
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 make this call.
Example:
None
AAUI.backup_status
(backup)
 
Description:
This function will indicate whether or not a backup action is in progress.
Input:
Output:
LOGICAL
backup
This value returns TRUE if the dialog backup action is in progress, or a FALSE if a dialog backup action is not in progress.
Error Conditions:
None.
Remarks:
A call to this function indicates whether or not the current dialog arrived at through action of the “Dialog Backup” button. Note that functions indicated as the value of an undo attribute to the <dialog> tag are automatically executed upon a “Dialog Backup” action. The platform software uses this interface call to determine such backup status. As soon as the new dialog is displayed, then a AAUI.notify_backup_done, 114 call is automatically made.
Example:
None
AAUI.notify_backup_done
()
Description:
This function will reset the backup status to FALSE, so any subsequent call to AAUI.backup_status() will return FALSE.
Input:
Output:
Error Conditions:
None.
Remarks:
The application author is not expected to use this call.
Example:
None.
AAUI.backup_enable
(on_off)
Description:
This function provides a mechanism for independent enabling and disabling of the UI form "Dialog Backup" button. Use this function to guard against <dialog> backup actions within a step where the workflow sequence is not designed to support a backup.
Input:
STRING
on_off[]
If this value is "ON" then the “Dialog Backup” button is enabled so that a user can select it. If this value is "OFF" (actually any value other than "ON") then the button is disabled so that no backup action selection is possible.
Output:
Error Conditions:
None.
Remarks:
Use of this function is recommended only as an exception to normal operation. Note that the "Dialog Backup" button is automatically enabled upon step selection and display of the first step <dialog>. The button is automatically disabled at the termination of a step when the AAUI.mainpanel_unselect_steps() call is made.
Example:
Following is an example of how a call to this function which disables backups is made in the initftn attribute of a <dialog>.
<dialog dlgid="first"
inputid="null"
initftn="FUNC:AAUI.backup_enable;STR:off"
...