DXmDisplayCSMessage(3X) DXmDisplayCSMessage(3X)
NAME
DXmDisplayCSMessage - Displays a compound string message.
SYNOPSIS
Widget DXmDisplayCSMessage(
Widget parent_widget,
char *name,
Boolean default_position,
Position x,
Position y,
unsigned char style,
int *message_vector,
Widget *widget,
int *convert_proc,
XtCallbackList ok_callback,
XtCallbackList help_callback );
PARAMETERS
The identifier (widget ID) for the parent widget of the created widget. The name of the created widget. When True, the x and y positions
of the widget window are ignored in favor of the default, which centers the message box in the window of the parent widget. The placement,
in pixels, of the left side of the message box relative to the inner upper-left corner of the parent window. The placement, in pixels, of
the upper side of the message box relative to the inner upper-left corner of the parent window. The style of the dialog box widget used
for the message box. The predefined values for this resource are as follows:
-----------------------------------------------------------
Value Description
-----------------------------------------------------------
XmDIALOG_FULL_APPLICATION_MODAL Used for dialogs that
must be responded to
before other interac-
tions in the same
application
XmDIALOG_MODELESS Modeless type dialog
box
XmDIALOG_PRIMARY_APPLICATION_MODAL Used when dialogs
must be responded to
before other interac-
tions in ancestors of
the widget
XmDIALOG_SYSTEM_MODAL Modal type dialog box
-----------------------------------------------------------
The default is XmDIALOG_MODELESS. The message argument vector specifying the compound strings and associated information.
The first longword contains the number of longwords in the message blocks to follow. The first longword in each message block con-
tains a pointer to the compound string. The next word consists of the formatted ASCII output (FAO) parameter count. The remaining
longwords in the message block are the FAO parameters.
In addition to the standard FAO system service flags, the compound string message routine will accept the new FAO directive "!CS".
When used, this directive will insert a compound string itself. The identifier (widget ID) of an already existing message box wid-
get. The Intrinsic routine XtSetValues is called on this widget to change the text of the message to match the new message. (Note,
however, that this call to XtSetValues does not set default_position, x, y, or style for the existing message box widget.) If this
parameter is 0, a new message box widget is created. A pointer to a routine that is executed after the message is formatted but
before it is displayed. A pointer to the formatted string is passed to the routine as a parameter.
The parameter is a null-terminated character string. A callback descriptor data structure. The callback is executed when the user
clicks on the Acknowledged button. The reason is XmCR_OK. A callback descriptor data structure. The callback is executed when the
user requests help. The reason returned is XmCR_HELP.
DESCRIPTION
The DXmDisplayCSMessage routine accepts an array of compound strings, formats them, and, if necessary, creates a message box. A return of
0 (Null) indicates that the message box could not be created.
RETURN VALUES
The identifier (widget ID) of the message box widget.
DXmDisplayCSMessage(3X)