5.3 DUIM-Sheets Module

notify-user

Generic function

Summary

Creates and displays an alert dialog box with the specified criteria.

Signature

notify-user message-string #key frame owner title documentation exit-boxes name style foreground background text-style => boolean

Arguments

message-string: An instance of type <string>.
frame: An instance of type <frame>. Default value: current-frame().
owner: An instance of type <sheet>.
title: An instance of type <string>.
documentation: An instance of type false-or(<string>). Default value: #f.
exit-boxes: An instance of type <object>.
name: An instance of type <object>.
style: An instance of type one-of(#"information", #"question", #"warning", #"error", #"serious-error", #"fatal-error").
foreground: An instance of type false-or(<ink>). Default value: #f.
background: An instance of type false-or(<ink>). Default value: #f.
text-style: An instance of type false-or(<text-style>). Default value: #f.

Values

boolean: An instance of type <boolean>.

Library

duim-sheets

Module

duim-sheets

Description

Creates and displays an alert dialog box with the specified criteria. Use this function as a way of easily displaying simple messages to the user.

Figure 5.3 Simple output from notify-user

The message-string is the message that is displayed in the dialog. The arguments frame, owner, title, and documentation let you specify different attributes for the dialog in the same way as they can be specified for any other frame or dialog.

The exit-boxes argument lets you specify the buttons that are available in the dialog. If not supplied, then a single OK button is used by default, unless the style of the dialog is set to #"question", in which case, two buttons are created, to allow the user to respond "yes" or "no".

The style argument lets you specify the style of dialog that is produced. The different styles available reflect the Motif specification for dialog box types. Depending on the style of dialog you choose, the appearance of the dialog created may vary. For example, a different icon is commonly used to distinguish between error, informational, and warning messages.

The foreground, background, and text-style arguments let you specify foreground and background colors, and the font to use in the message text.