DwtDisplayCSMessage(3Dwt)

Name

DwtDisplayCSMessage − Displays a compound-string message.

Syntax

Widget DwtDisplayCSMessage(parent_widget, name,
                           default_position, x, y,
                           style, message_vector,
                           widget_id convert_proc,
                           ok_callback, help_callback)
     Widget parent_widget;
     char *name;
     int default_position;
     int x, y;
     int style;
     int *message_vector;
     Widget *widget;
     int (*convert_proc)();
     DwtCallbackPtr ok_callback;
     DwtCallbackPtr help_callback;

Arguments

parent_widget
Specifies the parent widget ID.

nameSpecifies the name of the created widget.

default_position
Specifies a boolean value that, when True, indicates that DwtNx and DwtNy are to be ignored forcing the widget to be centered in the parent window.

xSpecifies the placement, in pixels, of the left side of the widget window relative to the inner upper left corner of the parent window.

ySpecifies, in pixels, the placement of the upper left corner of the widget window relative to the inner upper left corner of the parent window.

styleSpecifies the style of the message box widget. You can pass DwtModal (modal) or DwtModeless (modeless).

message_vector
Specifies the message argument vector identifying the message identifier and associated information.

The first longword contains the number of longwords in the message blocks to follow. The first longword in each message block contains a pointer to the compound-string. The next word consists of the FAO parameter count. The final n longwords in the message block are the FAO parameters.

widget_idThis argument contains the widget ID of an already-existing message box widget. If this argument is nonzero, a new message box is not created. An XtSetValues will be performed on this widget to change the text of the message to match this new message. This is an input/output argument. That is, the function fills in widget_id after you call it.

convert_procSpecifies a pointer to a function that is executed after the message is formatted but before it is displayed.

A pointer to the formatted compound-string is passed to the function as a parameter. This parameter is a NULL-terminated character string.

ok_callbackSpecifies the callback function or functions called when the user clicks on the Acknowledged push button. For this callback, the reason is DwtCRYes.

help_callbackSpecifies the callback function or functions called when a help request is made.

Description

The DwtDisplayCSMessage function accepts an array of compound-strings, formats them, and creates a message box.

If the function returns a zero, the message is not appended to the messages to be displayed.

Return Values

Upon completion, DwtDisplayCSMessage returns to the calling program the ID of the created message box widget.