XmMessageBox - Man Page

MessageBox automatically creates the descendants shown in the following table. An application can use XtNameToWidget to gain access to the named descendant. In addition, a user or an application can use the named descendant when specifying resource values.

MessageBox inherits behavior, resources, and traits from Core, Composite, Constraint, XmManager, and XmBulletinBoard.

The class pointer is xmMessageBoxWidgetClass.

The class name is XmMessageBox.

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. The default for this resource depends on the locale. In the C locale the default is Cancel.

Now that some default localized label strings are provided through message catalogs for the children of composite widgets, the labelString resources cannot be set on the child through default resource files. Instead, the resource provided at the parent level must be used.

XmNdefaultButtonType

Specifies the default PushButton. A value of XmDIALOG_NONE means that there should be no default PushButton. The following types are valid:

  ·

XmDIALOG_CANCEL_BUTTON

  ·

XmDIALOG_OK_BUTTON

  ·

XmDIALOG_HELP_BUTTON

  ·

XmDIALOG_NONE

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. It does not have an associated message symbol.

XmDIALOG_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

Indicates a WarningDialog.

XmDIALOG_WORKING

Indicates a WorkingDialog.

If this resource is changed with XtSetValues, the symbol bitmap is modified 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.

XmNhelpLabelString

Specifies the string label for the help button. The default for this resource depends on the locale. In the C locale the default is Help.

Now that some default localized label strings are provided through message catalogs for the children of composite widgets, the labelString resources cannot be set on the child through default resource files. Instead, the resource provided at the parent level must be used.

XmNmessageAlignment

Controls the alignment of the message Label. Possible values include the following:

  ·

XmALIGNMENT_BEGINNING (default)

  ·

XmALIGNMENT_CENTER

  ·

XmALIGNMENT_END

See the description of XmNalignment in the XmLabel reference page for an explanation of these values.

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 this resource is 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. The default for this resource depends on the locale. In the C locale the default is OK.

Now that some default localized label strings are provided through message catalogs for the children of composite widgets, the labelString resources cannot be set on the child through default resource files. Instead, the resource provided at the parent level must be used.

XmNsymbolPixmap

Specifies the pixmap label to be used as the message symbol.

MessageBox inherits behavior and resources from the superclasses described in the following tables. For a complete description of each resource, refer to the reference page for that superclass.

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

typedef struct
{
        int reason;
        XEvent *event;
} XmAnyCallbackStruct;

reason

Indicates why the callback was invoked

event

Points to the XEvent that triggered the callback

XmMessageBox includes the translations from XmManager.

The XmMessageBox widget has the following additional behavior:

<Key><osfCancel>:

Calls the activate callbacks for the cancel button if it is sensitive.

<Key><osfActivate>:

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.

The bindings for virtual keys are vendor specific. For information about bindings for virtual buttons and keys, see VirtualBindings(3).