DwtCommandWindow(3Dwt)

Name

DwtCommandWindow, DwtCommandWindowCreate − Creates a command window widget.

Syntax

Widget DwtCommandWindow(parent_widget, name, prompt,
                        lines, callback, help_callback)
     Widget parent_widget;
     char *name;
     DwtCompString prompt;
     int lines;
     DwtCallbackPtr callback, help_callback;

Widget DwtCommandWindowCreate (parent_widget, name,
                               override_arglist,
                               override_argcount)
     Widget parent_widget;
     char *name;
     ArgList override_arglist;
     int override_argcount;

Arguments

parent_widget
Specifies the parent widget ID.

nameSpecifies the name of the created widget.

promptSpecifies the command line prompt. This argument sets the DwtNprompt attribute associated with DwtCommandWindowCreate.

linesSpecifies the number of command history lines visible in the command window widget. This argument sets the DwtNlines attribute associated with DwtCommandWindowCreate.

callbackSpecifies the callback function or functions called when the user enters a command or changes the contents of a command line. This argument sets the DwtNcommandEnteredCallback and DwtNvalueChangedCallback attributes associated with DwtCommandWindowCreate.

help_callbackSpecifies the callback function or functions called when a help request is made. This argument sets the DwtNhelpCallback common widget attribute.

parent_widget
Specifies the parent widget ID.

nameSpecifies the name of the created widget.

override_arglist
Specifies the application override argument list.

override_argcount
Specifies the number of attributes in the application override argument list (override_arglist).

Description

The DwtCommandWindow and DwtCommandWindowCreate functions create an instance of a command window widget and return its associated widget ID. The command window widget handles command line entry, command line history, and command line recall. When calling DwtCommandWindow, you set the command window widget attributes presented in the formal parameter list. For DwtCommandWindowCreate, however, you specify a list of attribute name/value pairs that represent all the possible command window widget attributes.

Inherited Attributes

Attribute Name	Data Type	Default
Core Attributes
DwtNx	Position	Determined by the geometry manager
DwtNy	Position	Determined by the geometry manager
DwtNwidth	Dimension	zero
DwtNheight	Dimension	zero
DwtNborderWidth	Dimension	One pixel
DwtNborder	Pixel	Default foreground color
DwtNborderPixmap	Pixmap	NULL
DwtNbackground	Pixel	Default background color
DwtNbackgroundPixmap	Pixmap	NULL
DwtNcolormap	Colormap	Default color map
DwtNsensitive	Boolean	True
DwtNancestorSensitive	Boolean	The bitwise AND of the parent widget’s DwtNsensitive and DwtNancestorSensitive attributes
DwtNaccelerators	XtTranslations	NULL
DwtNdepth	int	Depth of the parent window
DwtNtranslations	XtTranslations	NULL
DwtNmappedWhenManaged	Boolean	True
DwtNscreen	Screen *	The parent screen
DwtNdestroyCallback	DwtCallbackPtr	NULL
Dialog Pop-Up Attributes
DwtNforeground	Pixel	Default foreground color
DwtNhighlight	Pixel	Default foreground color
DwtNhighlightPixmap	Pixmap	NULL
DwtNuserData	Opaque *	NULL
DwtNfont	DwtFontList	The default XUI Toolkit font
DwtNhelpCallback	DwtCallbackPtr	NULL
DwtNdirectionRToL	NOT SUPPORTED
DwtNunits	NOT SUPPORTED
DwtNtitle	DwtCompString	Widget name
DwtNstyle	unsigned char	DwtModal
DwtNmapCallback	DwtCallbackPtr	NULL
DwtNunmapCallback	DwtCallbackPtr	NULL
DwtNfocusCallback	DwtCallbackPtr	NULL
DwtNtextMergeTranslations	NOT SUPPORTED
DwtNmarginWidth	Dimension	12 pixels
DwtNmarginHeight	Dimension	10 pixels
DwtNdefaultPosition	Boolean	True This causes the command window to be positioned in the bottom left-hand corner of the parent widget.
DwtNchildOverlap	NOT SUPPORTED
DwtNresize	NOT SUPPORTED
DwtNtakeFocus	Boolean	True for modal dialog box
		False for modeless dialog box
DwtNnoResize	Boolean	True (that is, no window manager resize button)
DwtNautoUnmanage	Boolean	True
DwtNdefaultButton	NOT SUPPORTED
DwtNcancelButton	Widget	NULL
DwtNcancelButton	NOT SUPPORTED

Widget-Specific Attributes

Attribute Name	Data Type	Default
DwtNvalue	char *	NULL
DwtNprompt	DwtCompString	">"
DwtNlines	short	Two lines
DwtNhistory	char *	""
DwtNcommandEnteredCallback	DwtCallbackPtr	NULL
DwtNvalueChangedCallback	DwtCallbackPtr	NULL
DwtNtTranslation	XtTranslations	NULL

DwtNvalueSpecifies the current contents of the command line string. When a command-entered callback is made, this attribute will be the command line that just executed.

DwtNpromptSpecifies the command line prompt.

DwtNlinesSpecifies the number of command history lines visible in the command window widget.

DwtNhistorySpecifies the contents of the command line history. Multiple lines should be separated by a linefeed character (<LF>).

DwtNcommandEnteredCallback
Specifies the callback function or functions called when the user terminated the command line with a carriage return/line feed. For this callback, the reason is DwtCRCommandEntered.

DwtNvalueChangedCallback
Specifies the callback function or functions called when the contents of the command line have changed. For this callback, the reason is DwtCRValueChanged.

DwtNtTranslation
Specifies the translations used for the command line text field.

Return Value

These functions return the ID of the created widget.

Callback Information

The following structure is returned to your callback:

typedef struct {
int reason;
XEvent *event;
int length;
char *value;
} DwtCommandWindowCallbackStruct;

The reason member is set to a constant that represents the reason why this callback was invoked. For this callback, the reason member can be set to:

DwtCRCommandEntered	The user terminated the command line with a carriage return/line feed.
DwtCRValueChanged	The contents of the command line have changed.
DwtCRFocus	The command window widget has received the input focus.
DwtCRHelpRequested	The user selected Help.

The event member is a pointer to the Xlib structure XEvent, which describes the event that generated this callback. This structure is a union of the individual structures declared for each event type. For information on XEvent and event processing, see the Guide to the Xlib Library: C Language Binding. The length member is set to the length of the current command line contents. The value member is set to the current command line contents.

Museum