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. 

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). 

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.

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. 

Callback Information

A pointer to the following structure is passed to each callback:

typedef struct
{
intreason;
XEvent∗ event;
} XmAnyCallbackStruct;

reasonIndicates why the callback was invoked

eventPoints 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). 

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). 

April 13, 2022  —  Last change: