XmMessageBox(3X) UNIX System V XmMessageBox(3X)
NAME
XmMessageBox - the MessageBox widget class.
SYNOPSIS
#include <Xm/MessageB.h>
DESCRIPTION
MessageBox is a dialog class used for creating simple message dialogs.
Convenience dialogs based on MessageBox are provided for several common
interaction tasks, which include giving information, asking questions,
and reporting errors.
A MessageBox dialog is typically transient in nature, displayed for the
duration of a single interaction. MessageBox is a subclass of
XmBulletinBoard and depends on it for much of its general dialog
behavior.
A MessageBox can contain a message symbol, a message, and up to three
standard default PushButtons: OK, Cancel, and Help. It is laid out with
the symbol and message on top and the PushButtons on the bottom. The
help button is positioned to the side of the other push buttons. You can
localize the default symbols and button labels for MessageBox convenience
dialogs.
At initialization, MessageBox looks for the following bitmap files:
⊕ xm_error
⊕ xm_information
⊕ xm_question
⊕ xm_working
⊕ xm_warning
See XmGetPixmap(3X) for a list of the paths that are searched for these
files.
Classes
MessageBox inherits behavior and resources from Core, Composite,
Constraint, XmManager, and XmBulletinBoard.
The class pointer is xmMessageBoxWidgetClass.
The class name is XmMessageBox.
10/89 Page 1
XmMessageBox(3X) UNIX System V XmMessageBox(3X)
New Resources
The following table defines a set of widget resources used by the
programmer to specify data. The programmer can also set the resource
values for the inherited classes to set attributes for this widget. To
reference a resource by name or by class in a .Xdefaults file, remove the
XmN or XmC prefix and use the remaining letters. To specify one of the
defined values for a resource in a .Xdefaults file, remove the Xm prefix
and use the remaining letters (in either lowercase or uppercase, but
include any underscores between words). The codes in the access column
indicate if the given resource can be set at creation time (C), set by
using XtSetValues (S), retrieved by using XtGetValues (G), or is not
applicable (N/A).
_______________________________________________________________________________________________
| XmMessageBox Resource Set |
|____________________|______________________|________________|_______________________|________|
|Name | Class | Type | Default | Access|
|____________________|______________________|________________|_______________________|________|
|____________________|______________________|________________|_______________________|________|
|XmNcancelCallback | XmCCallback | XtCallbackList| NULL | C |
|____________________|______________________|________________|_______________________|________|
|XmNcancelLabelString| XmCCancelLabelString| XmString | "Cancel" | CSG |
|____________________|______________________|________________|_______________________|________|
|XmNdefaultButtonType| XmCDefaultButtonType| unsigned char | XmDIALOG_OK_BUTTON | CSG |
|____________________|______________________|________________|_______________________|________|
|XmNdialogType | XmCDialogType | unsigned char | XmDIALOG_MESSAGE | CSG |
|____________________|______________________|________________|_______________________|________|
|XmNhelpLabelString | XmCHelpLabelString | XmString | "Help" | CSG |
|____________________|______________________|________________|_______________________|________|
|XmNmessageAlignment | XmCAlignment | unsigned char | XmALIGNMENT_BEGINNING| CSG |
|____________________|______________________|________________|_______________________|________|
|XmNmessageString | XmCMessageString | XmString | "" | CSG |
|____________________|______________________|________________|_______________________|________|
|XmNminimizeButtons | XmCMinimizeButtons | Boolean | False | CSG |
|____________________|______________________|________________|_______________________|________|
|XmNokCallback | XmCCallback | XtCallbackList| NULL | C |
|____________________|______________________|________________|_______________________|________|
|XmNokLabelString | XmCOkLabelString | XmString | "OK" | CSG |
|____________________|______________________|________________|_______________________|________|
|XmNsymbolPixmap | XmCPixmap | Pixmap | dynamic | CSG |
|____________________|______________________|________________|_______________________|________|
Page 2 10/89
XmMessageBox(3X) UNIX System V XmMessageBox(3X)
XmNcancelCallback
Specifies the list of callbacks that is called when the user clicks
on the cancel button. The reason sent by the callback is
XmCR_CANCEL.
XmNcancelLabelString
Specifies the string label for the cancel button.
XmNdefaultButtonType
Specifies the default PushButton. The following are valid types:
⊕ XmDIALOG_CANCEL_BUTTON
⊕ XmDIALOG_OK_BUTTON
⊕ XmDIALOG_HELP_BUTTON
XmNdialogType
Specifies the type of MessageBox dialog, which determines the
default message symbol. The following are the possible values for
this resource:
⊕ XmDIALOG_ERROR - indicates an ErrorDialog
⊕ XmDIALOG_INFORMATION - indicates an InformationDialog
⊕ XmDIALOG_MESSAGE - indicates a MessageDialog. This is the
default MessageBox dialog type. The default message symbol is
NULL.
⊕ XmDIALOG_QUESTION - indicates a QuestionDialog
⊕ XmDIALOG_WARNING - indicates a WarningDialog
⊕ XmDIALOG_WORKING - indicates a WorkingDialog
If this resource is changed via XtSetValues, the symbol bitmap is
modified to the new XmdialogType bitmap unless XmNsymbolPixmap is
also being set in XtSetValues.
XmNhelpLabelString
Specifies the string label for the help button.
10/89 Page 3
XmMessageBox(3X) UNIX System V XmMessageBox(3X)
XmNmessageAlignment
Controls the alignment of the message Label. Possible values
include the following:
⊕ XmALIGNMENT_BEGINNING - the default
⊕ XmALIGNMENT_CENTER
⊕ XmALIGNMENT_END
XmNmessageString
Specifies the string to be used as the message.
XmNminimizeButtons
Sets the buttons to the width of the widest button and height of
the tallest button if False. If True, button width and height are
set to the preferred size of each button.
XmNokCallback
Specifies the list of callbacks that is called when the user clicks
on the OK button. The reason sent by the callback is XmCR_OK.
XmNokLabelString
Specifies the string label for the OK button.
XmNsymbolPixmap
Specifies the pixmap label to be used as the message symbol.
Inherited Resources
MessageBox inherits behavior and resources from the following
superclasses. For a complete description of each resource, refer to the
man page for that superclass.
Page 4 10/89
XmMessageBox(3X) UNIX System V XmMessageBox(3X)
____________________________________________________________________________________
| XmBulletinBoard Resource Set |
|___________________|____________________|________________|_______________|________|
|Name | Class | Type | Default | Access|
|___________________|____________________|________________|_______________|________|
|___________________|____________________|________________|_______________|________|
|XmNallowOverlap | XmCAllowOverlap | Boolean | True | CSG |
|___________________|____________________|________________|_______________|________|
|XmNautoUnmanage | XmCAutoUnmanage | Boolean | True | CG |
|___________________|____________________|________________|_______________|________|
|XmNbuttonFontList | XmCButtonFontList | XmFontList | dynamic | CSG |
|___________________|____________________|________________|_______________|________|
|XmNcancelButton | XmCWidget | Widget | Cancel button| SG |
|___________________|____________________|________________|_______________|________|
|XmNdefaultButton | XmCWidget | Widget | dynamic | SG |
|___________________|____________________|________________|_______________|________|
|XmNdefaultPosition | XmCDefaultPosition| Boolean | True | CSG |
|___________________|____________________|________________|_______________|________|
|XmNdialogStyle | XmCDialogStyle | unsigned char | dynamic | CSG |
|___________________|____________________|________________|_______________|________|
|XmNdialogTitle | XmCDialogTitle | XmString | NULL | CSG |
|___________________|____________________|________________|_______________|________|
|XmNfocusCallback | XmCCallback | XtCallbackList| NULL | C |
|___________________|____________________|________________|_______________|________|
|XmNlabelFontList | XmCLabelFontList | XmFontList | dynamic | CSG |
|___________________|____________________|________________|_______________|________|
|XmNmapCallback | XmCCallback | XtCallbackList| NULL | C |
|___________________|____________________|________________|_______________|________|
|XmNmarginHeight | XmCMarginHeight | Dimension | 10 | CSG |
|___________________|____________________|________________|_______________|________|
|XmNmarginWidth | XmCMarginWidth | Dimension | 10 | CSG |
|___________________|____________________|________________|_______________|________|
|XmNnoResize | XmCNoResize | Boolean | False | CSG |
|___________________|____________________|________________|_______________|________|
|XmNresizePolicy | XmCResizePolicy | unsigned char | XmRESIZE_ANY | CSG |
|___________________|____________________|________________|_______________|________|
|XmNshadowType | XmCShadowType | unsigned char | XmSHADOW_OUT | CSG |
|___________________|____________________|________________|_______________|________|
|XmNtextFontList | XmCTextFontList | XmFontList | dynamic | CSG |
|___________________|____________________|________________|_______________|________|
|XmNtextTranslations| XmCTranslations | XtTranslations| NULL | C |
|___________________|____________________|________________|_______________|________|
|XmNunmapCallback | XmCCallback | XtCallbackList| NULL | C |
|___________________|____________________|________________|_______________|________|
10/89 Page 5
XmMessageBox(3X) UNIX System V XmMessageBox(3X)
_________________________________________________________________________________________________________
| XmManager Resource Set |
|_____________________|_____________________________|___________________|______________________|________|
|Name | Class | Type | Default | Access|
|_____________________|_____________________________|___________________|______________________|________|
|_____________________|_____________________________|___________________|______________________|________|
|XmNbottomShadowColor | XmCBottomShadowColor | Pixel | dynamic | CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNbottomShadowPixmap| XmCBottomShadowPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNforeground | XmCForeground | Pixel | dynamic | CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNhelpCallback | XmCCallback | XtCallbackList | NULL | C |
|_____________________|_____________________________|___________________|______________________|________|
|XmNhighlightColor | XmCHighlightColor | Pixel | dynamic | CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNhighlightPixmap | XmCHighlightPixmap | Pixmap | dynamic | CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNnavigationType | XmCNavigationType | XmNavigationType | dynamic | CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNshadowThickness | XmCShadowThickness | Dimension | dynamic | CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNstringDirection | XmCStringDirection | XmStringDirection| dynamic | CG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNtopShadowColor | XmCBackgroundTopShadowColor| Pixel | dynamic | CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNtopShadowPixmap | XmCTopShadowPixmap | Pixmap | dynamic | CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNtraversalOn | XmCTraversalOn | Boolean | True | CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNunitType | XmCUnitType | unsigned char | dynamic | CSG |
|_____________________|_____________________________|___________________|______________________|________|
|XmNuserData | XmCUserData | Pointer | NULL | CSG |
|_____________________|_____________________________|___________________|______________________|________|
_______________________________________________________________________
| Composite Resource Set |
|__________________|___________________|____________|_________|________|
| Name | Class | Type | Default| Access|
|__________________|___________________|____________|_________|________|
|__________________|___________________|____________|_________|________|
| XmNchildren | XmCReadOnly | WidgetList| NULL | G |
|__________________|___________________|____________|_________|________|
| XmNinsertPosition| XmCInsertPosition| (*)() | NULL | CSG |
|__________________|___________________|____________|_________|________|
| XmNnumChildren | XmCReadOnly | Cardinal | 0 | G |
|__________________|___________________|____________|_________|________|
Page 6 10/89
XmMessageBox(3X) UNIX System V XmMessageBox(3X)
________________________________________________________________________________________________________________
| Core Resource Set |
|_____________________________|_______________________________|________________|______________________|________|
|Name | Class | Type | Default | Access|
|_____________________________|_______________________________|________________|______________________|________|
|_____________________________|_______________________________|________________|______________________|________|
|XmNaccelerators | XmCAccelerators | XtAccelerators| dynamic | N/A |
|_____________________________|_______________________________|________________|______________________|________|
|XmNancestorSensitive | XmCSensitive | Boolean | dynamic | G |
|_____________________________|_______________________________|________________|______________________|________|
|XmNbackground | XmCBackground | Pixel | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNbackgroundPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderColor | XmCBorderColor | Pixel | XtDefaultForeground | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderWidth | XmCBorderWidth | Dimension | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNcolormap | XmCColormap | Colormap | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNdepth | XmCDepth | int | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNdestroyCallback | XmCCallback | XtCallbackList| NULL | C |
|_____________________________|_______________________________|________________|______________________|________|
|XmNheight | XmCHeight | Dimension | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNinitialResourcesPersistent| XmCInitialResourcesPersistent| Boolean | True | C |
|_____________________________|_______________________________|________________|______________________|________|
|XmNmappedWhenManaged | XmCMappedWhenManaged | Boolean | True | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNscreen | XmCScreen | Screen * | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNsensitive | XmCSensitive | Boolean | True | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNtranslations | XmCTranslations | XtTranslations| dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNwidth | XmCWidth | Dimension | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNx | XmCPosition | Position | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNy | XmCPosition | Position | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
Callback Information
A pointer to the following structure is passed to each callback:
typedef struct
{
int reason;
10/89 Page 7
XmMessageBox(3X) UNIX System V XmMessageBox(3X)
XEvent * event;
} XmAnyCallbackStruct;
reason Indicates why the callback was invoked
event Points to the XEvent that triggered the callback
Translations
XmMessageBox includes the translations from XmManager.
Additional Behavior
The XmMessageBox widget has the additional behavior described below:
MAny KCancel:
Calls the activate callbacks for the cancel button if it is
sensitive.
KActivate:
Calls the activate callbacks for the button with the keyboard
focus. If no button has the keyboard focus, calls the activate
callbacks for the default button if it is sensitive.
<Ok Button Activated>:
Calls the callbacks for XmNokCallback.
<Cancel Button Activated>:
Calls the callbacks for XmNcancelCallback.
<Help Button Activated>:
Calls the callbacks for XmNhelpCallback.
<FocusIn>:
Calls the callbacks for XmNfocusCallback.
<Map>:
Calls the callbacks for XmNmapCallback if the parent is a
DialogShell.
<Unmap>:
Calls the callbacks for XmNunmapCallback if the parent is a
DialogShell.
Virtual Bindings
The bindings for virtual keys are vendor specific. For information about
bindings for virtual buttons and keys, see VirtualBindings(3X).
Page 8 10/89
XmMessageBox(3X) UNIX System V XmMessageBox(3X)
RELATED INFORMATION
Composite(3X), Constraint(3X), Core(3X), XmBulletinBoard(3X),
XmCreateErrorDialog(3X), XmCreateInformationDialog(3X),
XmCreateMessageBox(3X), XmCreateMessageDialog(3X),
XmCreateQuestionDialog(3X), XmCreateWarningDialog(3X),
XmCreateWorkingDialog(3X), XmManager(3X), and XmMessageBoxGetChild(3X).
10/89 Page 9