XbaeInput - Man Page

XbaeInput inherits behavior and resources from the Core, XmPrimitive, and XmText widget classes.
The class pointer is xbaeInputWidgetClass.
The class name is XbaeInput.

The following table lists the new resources defined by XbaeInput. The codes in the Access column indicate whether the given resource can be set at creation time (C), or set by using XtSetValues (S), or retrieved by using XtGetValues (G).

This resource has not been implemented.

XmNalignment

This resource has not been implemented!

Specifies the alignment of the text when being edited and displayed. Possible values are XmALIGNMENT_BEGINNINGand XmALIGNMENT_END. If XmNalignment is set to XmALIGNMENT_END, the text will be right justified. If left as the default of XmALIGNMENT_BEGINNING, the text will be left justified.

XmNautoFill

The XmNautoFill resource, when set to True, attempts to automatically insert a literal if a non literal is hit in an allowed literal position.  For example, if the XmNpattern resource was set up to accept a date in dd/mm/yyyy format and the user typed "18041999" The resulting string would appear as "18/04/1999". The default value is False, where the user would have to type the literal.

XmNconvertCase

Tells the XbaeInput widget what should be done to alphabetic characters if the requires a lowercase or uppercase letter.  If the XmNconvertCase is set to True (default), then the character is automatically converted to the correct case.  If set to False, then the user must type the character in the correct case in order for it to be accepted.  See the Example Patterns section towards the end of this document for some examples.

overwriteMode

Whether the widget accepts characters in insert mode or overwrite mode is controlled by the resource.  Setting this resource calls the XmText toggle-overwrite() action routine, so the Motif toolkit being used must also support this routine.

XmNpattern

The XmNpattern resource specifies what can be typed into the XbaeInput widget.  If set to the default value of NULL any character may be entered.  The XmNpattern can be set to a string containing the following characters.

a	alphabetic characters only
b	both - either digit or character
c	any character at all
d	digits only
U	upperchase character only
L	lowercase character only
[	start of optional sequence
]	end of optional sequence
\\	escapes the next character
|	next char is an alternative to previous. May be chained.

The following table lists the resources which XbaeInput inherits from it's superclasses XmText, XmPrimitive and Core. For a complete description of each resource, refer to the man page for that superclass. The codes in the "Access" column indicate whether the given resource can be set at creation time (C), or set by using XtSetValues (S), or retrieved by using XtGetValues (G).

XmNvalidateCallback

Callbacks on the XmNvalidateCallback list are called when the edits to the XbaeInput widget are activated or a losing focus event occurs. Each callback function is passed the following structure:

typedef struct
{
	int	reason;
	XEvent	*event;
	String	pattern;
	String	value;
	Boolean	doit;
} XbaeInputValidateCallbackStruct;

reason

Set to XmCR_ACTIVATE if the user caused the callback to be invoked by activating the changes in the cell or XmCR_LOSING_FOCUS if the callback was called due to a losing focus event.

event

The event pointer that triggered the callback.

pattern

A pointer to the pattern for the XbaeInput widget or NULL if one does not exist.  This value is provided as a convenience to the callback.

value

The value as it appears in the cell at the time of the callback being invoked.

doit

Indicates whether or not the value is valid.  By setting doit to False the value will not be accepted.

This callback provides the application of checking the validity of the value entered into the XbaeInput widget.  Checking the validity of a date may be one such instance. If the value is verified as valid, all values of the callback may be left unchanged.  If the pointer to the value is changed, the new value will be displayed in the cell and storage for the old value deallocated by the XbaeInput widget.  The new value's memory is owned by the application and it is up to the application to use XtFree to deallocate it.

If the value is not considered valid, the doit flag should be set to False, forcing the user to make changes before the value can be accepted.

XbaeInput inherits translations from XmText. Some versions of Motif do not have the  

translation installed by default.  If this is the case, XbaeInput automatically registers this translation.

XbaeInput does not define any new type converters other than the standard type converters registered by Xt and Motif.

The following external entry points to XbaeInput class methods are defined:

XbaeCreateInput()

d[d]/d[d]/dd[dd]

A date that would accept 1/1/99, 12/1/99, 1/12/1999, 01/01/2000, etc.

U[L][L][L][L][L], U[L][L][L][L][L]

"Surname, Firstname" combination, automatically forcing correct case and allowing between 1 and 6 characters per name.

UU-dd[d][d]

A flight number consisting of two uppercase letters and 2 to 4 numbers

(ddd) ddd-dddd

An American style phone number

UdU[-]dUd

A Canadian postcode with optional dash.

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