XmMessageBox(3X) OSF/Motif XmMessageBox(3X)NAMEXmMessageBox - 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 XmBul‐
letinBoard and depends on it for much of its general dialog behavior.
The default value for XmNinitialFocus is the value of XmNdefaultButton.
A typical MessageBox contains 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 bot‐
tom. The help button is positioned to the side of the other push but‐
tons. You can localize the default symbols and button labels for Mes‐
sageBox convenience dialogs.
The user can specify resources in a resource file for the gadgets cre‐
ated automatically that contain the MessageBox symbol pixmap and sepa‐
rator. The gadget names are "Symbol" and "Separator".
A MessageBox can also be customized by creating and managing new chil‐
dren that are added to the MessageBox children created automatically by
the convenience dialogs. In the case of TemplateDialog, only the sepa‐
rator child is created by default. If the callback, string, or pixmap
symbol resources are specified, the appropriate child will be created.
Additional children are laid out in the following manner: The first
MenuBar child is placed at the top of the window. All XmPushButton
widgets or gadgets, and their subclasses are placed after the OK button
in the order of their creation. A child that is not in the above cate‐
gories is placed above the row of buttons. If a message label exists,
the child is placed below the label. If a message pixmap exists, but a
message label is absent, the child is placed on the same row as the
pixmap. The child behaves as a work area and grows or shrinks to fill
the space above the row of buttons. The layout of multiple work area
children is undefined.
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, Con‐
straint, XmManager, and XmBulletinBoard.
The class pointer is xmMessageBoxWidgetClass.
The class name is XmMessageBox.
New Resources
The following table defines a set of widget resources used by the pro‐
grammer to specify data. The programmer can also set the resource val‐
ues 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 Default Access
Class Type
────────────────────────────────────────────────────────────
────────────────────────────────────────────────────────────
XmNcancelCallback NULL C
XmCCallback XtCallbackList
────────────────────────────────────────────────────────────
XmNcancelLabelString dynamic CSG
XmCCancelLabelString XmString
────────────────────────────────────────────────────────────
XmNdefaultButtonType XmDIALOG_OK_BUTTON CSG
XmCDefaultButtonType unsigned char
────────────────────────────────────────────────────────────
XmNdialogType XmDIALOG_MESSAGE CSG
XmCDialogType unsigned char
────────────────────────────────────────────────────────────
XmNhelpLabelString dynamic CSG
XmCHelpLabelString XmString
────────────────────────────────────────────────────────────
XmNmessageAlignment XmALIGNMENT_BEGINNING CSG
XmCAlignment unsigned char
────────────────────────────────────────────────────────────
XmNmessageString "" CSG
XmCMessageString XmString
────────────────────────────────────────────────────────────
XmNminimizeButtons False CSG
XmCMinimizeButtons Boolean
────────────────────────────────────────────────────────────
XmNokCallback NULL C
XmCCallback XtCallbackList
────────────────────────────────────────────────────────────
XmNokLabelString dynamic CSG
XmCOkLabelString XmString
────────────────────────────────────────────────────────────
XmNsymbolPixmap dynamic CSG
XmCPixmap Pixmap
────────────────────────────────────────────────────────────
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.
Specifies the string label for the cancel button. The default for this
resource depends on the locale. In the C locale the default is "Can‐
cel". Specifies the default PushButton. A value of XmDIALOG_NONE
means that there should be no default PushButton. The following are
valid types: XmDIALOG_CANCEL_BUTTON XmDIALOG_OK_BUTTON XmDIA‐
LOG_HELP_BUTTON XmDIALOG_NONE 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 Error‐
Dialog XmDIALOG_INFORMATION—indicates an InformationDialog XmDIA‐
LOG_MESSAGE—indicates a MessageDialog. This is the default MessageBox
dialog type. It does not have an associated message symbol. XmDIA‐
LOG_QUESTION—indicates a QuestionDialog XmDIALOG_TEMPLATE—indicates a
TemplateDialog. The TemplateDialog contains only a separator child.
It does not have an associated message symbol. XmDIALOG_WARNING—indi‐
cates a WarningDialog XmDIALOG_WORKING—indicates a WorkingDialog
If this resource is changed via XtSetValues, the symbol bitmap is modi‐
fied to the new XmNdialogType bitmap unless XmNsymbolPixmap is also
being set in the call to XtSetValues. If the dialog type does not have
an associated message symbol, then no bitmap will be displayed. Speci‐
fies the string label for the help button. The default for this
resource depends on the locale. In the C locale the default is "Help".
Controls the alignment of the message Label. Possible values include
the following: XmALIGNMENT_BEGINNING—the default XmALIGNMENT_CENTER
XmALIGNMENT_END Specifies the string to be used as the message. 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 pre‐
ferred size of each button. 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. Specifies the string label for the OK button.
The default for this resource depends on the locale. In the C locale
the default is "OK". Specifies the pixmap label to be used as the mes‐
sage symbol.
Inherited Resources
MessageBox inherits behavior and resources from the following super‐
classes. For a complete description of each resource, refer to the man
page for that superclass.
XmBulletinBoard Resource Set
──────────────────────────────────────────────────────────
Name Default Access
Class Type
──────────────────────────────────────────────────────────
──────────────────────────────────────────────────────────
XmNallowOverlap True CSG
XmCAllowOverlap Boolean
──────────────────────────────────────────────────────────
XmNautoUnmanage True CG
XmCAutoUnmanage Boolean
──────────────────────────────────────────────────────────
XmNbuttonFontList dynamic CSG
XmCButtonFontList XmFontList
──────────────────────────────────────────────────────────
XmNcancelButton Cancel button SG
XmCWidget Widget
──────────────────────────────────────────────────────────
XmNdefaultButton dynamic SG
XmCWidget Widget
──────────────────────────────────────────────────────────
XmNdefaultPosition True CSG
XmCDefaultPosition Boolean
──────────────────────────────────────────────────────────
XmNdialogStyle dynamic CSG
XmCDialogStyle unsigned char
──────────────────────────────────────────────────────────
XmNdialogTitle NULL CSG
XmCDialogTitle XmString
──────────────────────────────────────────────────────────
XmNfocusCallback NULL C
XmCCallback XtCallbackList
──────────────────────────────────────────────────────────
XmNlabelFontList dynamic CSG
XmCLabelFontList XmFontList
──────────────────────────────────────────────────────────
XmNmapCallback NULL C
XmCCallback XtCallbackList
──────────────────────────────────────────────────────────
XmNmarginHeight 10 CSG
XmCMarginHeight Dimension
──────────────────────────────────────────────────────────
XmNmarginWidth 10 CSG
XmCMarginWidth Dimension
──────────────────────────────────────────────────────────
XmNnoResize False CSG
XmCNoResize Boolean
──────────────────────────────────────────────────────────
XmNresizePolicy XmRESIZE_ANY CSG
XmCResizePolicy unsigned char
──────────────────────────────────────────────────────────
XmNshadowType XmSHADOW_OUT CSG
XmCShadowType unsigned char
──────────────────────────────────────────────────────────
XmNtextFontList dynamic CSG
XmCTextFontList XmFontList
──────────────────────────────────────────────────────────
XmNtextTranslations NULL C
XmCTranslations XtTranslations
──────────────────────────────────────────────────────────
XmNunmapCallback NULL C
XmCCallback XtCallbackList
──────────────────────────────────────────────────────────
XmManager Resource Set
────────────────────────────────────────────────────────────────
Name Default Access
Class Type
────────────────────────────────────────────────────────────────
────────────────────────────────────────────────────────────────
XmNbottomShadowColor dynamic CSG
XmCBottomShadowColor Pixel
────────────────────────────────────────────────────────────────
XmNbottomShadowPixmap XmUNSPECIFIED_PIXMAP CSG
XmCBottomShadowPixmap Pixmap
────────────────────────────────────────────────────────────────
XmNforeground dynamic CSG
XmCForeground Pixel
────────────────────────────────────────────────────────────────
XmNhelpCallback NULL C
XmCCallback XtCallbackList
────────────────────────────────────────────────────────────────
XmNhighlightColor dynamic CSG
XmCHighlightColor Pixel
────────────────────────────────────────────────────────────────
XmNhighlightPixmap dynamic CSG
XmCHighlightPixmap Pixmap
────────────────────────────────────────────────────────────────
XmNinitialFocus dynamic CSG
XmCInitialFocus Widget
────────────────────────────────────────────────────────────────
XmNnavigationType XmTAB_GROUP CSG
XmCNavigationType XmNavigationType
────────────────────────────────────────────────────────────────
XmNshadowThickness dynamic CSG
XmCShadowThickness Dimension
────────────────────────────────────────────────────────────────
XmNstringDirection dynamic CG
XmCStringDirection XmStringDirection
────────────────────────────────────────────────────────────────
XmNtopShadowColor dynamic CSG
XmCTopShadowColor Pixel
────────────────────────────────────────────────────────────────
XmNtopShadowPixmap dynamic CSG
XmCTopShadowPixmap Pixmap
────────────────────────────────────────────────────────────────
XmNtraversalOn True CSG
XmCTraversalOn Boolean
────────────────────────────────────────────────────────────────
XmNunitType dynamic CSG
XmCUnitType unsigned char
────────────────────────────────────────────────────────────────
XmNuserData NULL CSG
XmCUserData XtPointer
────────────────────────────────────────────────────────────────
Composite Resource Set
──────────────────────────────────────────────────────
Name Default Access
Class Type
──────────────────────────────────────────────────────
──────────────────────────────────────────────────────
XmNchildren NULL G
XmCReadOnly WidgetList
──────────────────────────────────────────────────────
XmNinsertPosition NULL CSG
XmCInsertPosition XtOrderProc
──────────────────────────────────────────────────────
XmNnumChildren 0 G
XmCReadOnly Cardinal
──────────────────────────────────────────────────────
Core Resource Set
─────────────────────────────────────────────────────────────────────
Name Default Access
Class Type
─────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────
XmNaccelerators dynamic N/A
XmCAccelerators XtAccelerators
─────────────────────────────────────────────────────────────────────
XmNancestorSensitive dynamic G
XmCSensitive Boolean
─────────────────────────────────────────────────────────────────────
XmNbackground dynamic CSG
XmCBackground Pixel
─────────────────────────────────────────────────────────────────────
XmNbackgroundPixmap XmUNSPECIFIED_PIXMAP CSG
XmCPixmap Pixmap
─────────────────────────────────────────────────────────────────────
XmNborderColor XtDefaultForeground CSG
XmCBorderColor Pixel
─────────────────────────────────────────────────────────────────────
XmNborderPixmap XmUNSPECIFIED_PIXMAP CSG
XmCPixmap Pixmap
─────────────────────────────────────────────────────────────────────
XmNborderWidth 0 CSG
XmCBorderWidth Dimension
─────────────────────────────────────────────────────────────────────
XmNcolormap dynamic CG
XmCColormap Colormap
─────────────────────────────────────────────────────────────────────
XmNdepth dynamic CG
XmCDepth int
─────────────────────────────────────────────────────────────────────
XmNdestroyCallback NULL C
XmCCallback XtCallbackList
─────────────────────────────────────────────────────────────────────
XmNheight dynamic CSG
XmCHeight Dimension
─────────────────────────────────────────────────────────────────────
XmNinitialResourcesPersistent True C
XmCInitialResourcesPersistent Boolean
─────────────────────────────────────────────────────────────────────
XmNmappedWhenManaged True CSG
XmCMappedWhenManaged Boolean
─────────────────────────────────────────────────────────────────────
XmNscreen dynamic CG
XmCScreen Screen *
─────────────────────────────────────────────────────────────────────
XmNsensitive True CSG
XmCSensitive Boolean
─────────────────────────────────────────────────────────────────────
XmNtranslations dynamic CSG
XmCTranslations XtTranslations
─────────────────────────────────────────────────────────────────────
XmNwidth dynamic CSG
XmCWidth Dimension
─────────────────────────────────────────────────────────────────────
XmNx 0 CSG
XmCPosition Position
─────────────────────────────────────────────────────────────────────
XmNy 0 CSG
XmCPosition Position
─────────────────────────────────────────────────────────────────────
Callback Information
A pointer to the following structure is passed to each callback: type‐
def struct { int reason; XEvent * event; } XmAny‐
CallbackStruct; Indicates why the callback was invoked 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:
Calls the activate callbacks for the cancel button if it is sensitive.
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. Calls the callbacks for XmNok‐
Callback. Calls the callbacks for XmNcancelCallback. Calls the call‐
backs for XmNhelpCallback. Calls the callbacks for XmNfocusCallback.
Calls the callbacks for XmNmapCallback if the parent is a DialogShell.
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).
RELATED INFORMATIONComposite(3X), Constraint(3X), Core(3X), XmBulletinBoard(3X), XmCre‐
ateErrorDialog(3X), XmCreateInformationDialog(3X), XmCreateMessage‐
Box(3X), XmCreateMessageDialog(3X), XmCreateQuestionDialog(3X), XmCre‐
ateTemplateDialog(3X), XmCreateWarningDialog(3X), XmCreateWorkingDia‐
log(3X), XmManager(3X), and XmMessageBoxGetChild(3X).
XmMessageBox(3X)
