document system-alert

db4
Joe Groff 2010-02-23 20:29:51 -08:00
parent cdc17e38e8
commit 0eb6355827
1 changed files with 5 additions and 0 deletions

View File

@ -81,6 +81,11 @@ HELP: with-ui
HELP: beep
{ $description "Plays the system beep sound." } ;
HELP: system-alert
{ $values { "caption" string } { "text" string } }
{ $description "Displays an application-modal alert dialog box with the given caption and text." }
{ $notes "Since the window raised by this word is modal, all processing in all Factor threads will halt until the dialog is dismissed. In an application that makes full use of the UI framework, it would be more appropriate to display a pane gadget in a Factor window. This word is meant primarily to be used to display errors in deployed applications with minimal dependencies on the UI library, such as games." } ;
HELP: topmost-window
{ $values { "world" world } }
{ $description "Returns the " { $link world } " representing the currently focused window." } ;