Tribblix: manual page: XmDataField.3

XmDataField(library call) XmDataField(library call)

NAME

XmDataField -- The DataField widget class

SYNOPSIS

#include <Xm/DataF.h>

DESCRIPTION

The DataField widget is a Data Presentation widget that handles
display and entry of data as text. The DataField widget is a
subclass of the XmTextField widget intended for data entry
applications. In addition to all of the normal XmTextField
functionality, it supports regular expression-based parsing and
acceptance/rejection of its input through the XmNpicture resource,
and right justification through the XmNalignment resource.

The DataField widget provides added capability by supporting several
types of validation: a DataField widget containing an invalid value
will not give-up focus; the user must enter a correct value before
proceeding to another field.

Classes

DataField inherits behavior, resources, and traits from Core,
XmPrimitive, and XmTextField.

The class pointer is xmDataFieldWidgetClass.

The class name is XmDataField.

New Resources

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).

+-----------------------------------------------------------------------------------------+
| XmDataField Resource Set |
|Name | Class | Type | Default | Access |
+------------------------+--------------+----------------+-----------------------+--------+
|XmNalignment | XmCAlignment | unsigned char | XmALIGNMENT_BEGINNING | CSG |
+------------------------+--------------+----------------+-----------------------+--------+
|XmNautoFill | XmCAutoFill | Boolean | True | CSG |
+------------------------+--------------+----------------+-----------------------+--------+
|XmNpicture | XmCPicture | String | NULL | CSG |
+------------------------+--------------+----------------+-----------------------+--------+
|XmNpictureErrorCallback | XmCCallback | XtCallbackList | NULL | C |
+------------------------+--------------+----------------+-----------------------+--------+
|XmNvalidateCallback | XmCCallback | XtCallbackList | NULL | C |
+------------------------+--------------+----------------+-----------------------+--------+
+------------------------+--------------+----------------+-----------------------+--------+
XmNalignment
When set to XmALIGNMENT_END, the widget aligns all its text
with the right hand side of the input area.

XmNautoFill
When set to True, the widget "auto-fills" its contents when
it can determine that the next character in the string must
be a particular literal. For instance, the picture
"###-####" automatically inserts a '-' character after
receiving three numeric digits as input.

XmNpicture
Specifies a picture for data entry in the widget. A picture
acts as a template that formats the value you enter in a
field. An example would be the US Phone Number picture:
(###)###-####. The picture is used to convert characters
entered into the field to a formatted value.

Character interpretations

The following lists and defines the characters you can use
in a picture, and how the DataField widget interprets them.

# Any numeric digit

? Case insensitive letter

& Uppercase letter (forces lowercase to uppercase)

@ Case insensitive character

! Uppercase character

; Interpret the following character literally

* Repeat the following character some number of times

[] Characters within brackets are optional

{} Characters within braces are grouped

, Alternative values

Other characters are interpreted literally.

Set XmNpicture to NULL to disable regular expression
processing. The DataField widget is cleared whenever
the XmNpicture resource is changed.

XmNpictureErrorCallback
Specifies a list of callbacks to be called when the
XmDataField widget determines that data is being entered
that does not match the format specified by the XmNpicture
resource.

XmNvalidateCallback
Specifies a list of callbacks to be called when data has
been entered in the XmDataField widget and the user has
moved out of the XmDataField widget (usually by pressing
the Tab key). The callbacks can reject the movement of
focus.

Inherited Resources

Translations

XmDataField inherits translations from XmTextField.

Callback Routines
A pointer to the following structure is passed to the list of
routines for the XmNvalidateCallback:
typedef struct _XmDataFieldCallbackStruct {
Widget w; /* The XmDataField */
String text; /* Proposed string */
Boolean accept; /* Accept return value, for validation */
} XmDataFieldCallbackStruct;

Core(3), XmCreateDataField(3), XmPrimitive(3),
XmTextFieldSetString(3), XmTextFieldSetStringWcs(3),
XmVaCreateDataField(3), and XmVaCreateManagedDataField(3).

VERSION

This manual page documents the XmDataField widget shipped in Motif
version 2.2