Manual Page Result
0
Command: XmTextField | Section: 3 | Source: Digital UNIX | File: XmTextField.3X.gz
XmTextField(3X) XmTextField(3X)
NAME
XmTextField - The TextField class
SYNOPSIS
#include <Xm/TextF.h>
DESCRIPTION
TextField widget provides a single line text editor for customizing
both user and programmatic interfaces. It is used for single-line
string entry, and forms entry with verification procedures. It provides
an application with a consistent editing system for textual data.
TextField widget provides separate callback lists to verify movement of
the insert cursor, modification of the text, and changes in input fo-
cus. Each of these callbacks provides the verification function with
the widget instance, the event that caused the callback, and a data
structure specific to the verification type. From this information the
function can verify if the application considers this to be a legiti-
mate state change and can signal the widget whether to continue with
the action.
The user interface tailors a new set of actions. The key bindings have
been added for insert cursor movement, deletion, insertion, and selec-
tion of text.
TextField allows the user to select regions of text. Selection is based
on the model specified in the Inter-Client Communication Conventions
Manual (ICCCM). TextField supports primary and secondary selection.
Classes
TextField widget inherits behavior and resources from Core and Primi-
tive classes.
The class pointer is xmTextFieldWidgetClass.
The class name is XmTextField.
New Resources
The following table defines a set of widget resources used by the pro-
grammer to specify data. The programmer can also set the resource val-
ues 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 lower case or upper
case, but include any underscores between words). The codes in the ac-
cess 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).
XmTextFieldResource Set
Class: XmCCallback Default: NULL Type: XtCallbackList Access: C Class:
XmCBlinkRate Default: 500 Type: int Access: CSG Class: XmCColumns De-
fault: dynamic Type: short Access: CSG Class: XmCCursorPosition De-
fault: 0 Type: XmTextPosition Access: CSG Class: XmCCursorPositionVis-
ible Default: True Type: Boolean Access: CSG Class: XmCEditable De-
fault: True Type: Boolean Access: CSG Class: XmCCallback Default: NULL
Type: XtCallbackList Access: C Class: XmCFontList Default: dynamic
Type: XmFontList Access: CSG Class: XmCCallback Default: NULL Type:
XtCallbackList Access: C Class: XmCCallback Default: NULL Type:
XtCallbackList Access: C Class: XmCCallback Default: NULL Type:
XtCallbackList Access: C Class: XmCMarginHeight Default: 5 Type: Di-
mension Access: CSG Class: XmCMarginWidth Default: 5 Type: Dimension
Access: CSG Class: XmCMaxLength Default: largest integer Type: int Ac-
cess: CSG Class: XmCCallback Default: NULL Type: XtCallbackList Ac-
cess: C Class: XmCCallback Default: NULL Type: XtCallbackList Access:
C Class: XmCCallback Default: NULL Type: XtCallbackList Access: C
Class: XmCPendingDelete Default: True Type: Boolean Access: CSG Class:
XmCResizeWidth Default: False Type: Boolean Access: CSG Class: XmCSe-
lectionArray Default: default array Type: XtPointer Access: CSG Class:
XmCSelectionArrayCount Default: 3 Type: int Access: CSG Class: XmCSe-
lectThreshold Default: 5 Type: int Access: CSG Class: XmCValue De-
fault: "" Type: String Access: CSG Class: XmCCallback Default: NULL
Type: XtCallbackList Access: C Class: XmCValueWcs Default: (wchar_t
*)"" Type: wchar_t * Access: CSG* Class: XmCVerifyBell Default: dy-
namic Type: Boolean Access: CSG
* This resource cannot be specified in a resource file. Specifies the
list of callbacks that is called when the user invokes an event that
calls the Activate() function. The type of the structure whose address
is passed to this callback is XmAnyCallbackStruct. The reason sent by
the callback is XmCR_ACTIVATE. Specifies the blink rate of the text
cursor in milliseconds. The time indicated in the blink rate relates
to the length of time the cursor is visible and the time the cursor is
invisible (i.e., the time it will take to blink the insertion cursor on
and off will be 2 times the blink rate). The cursor will not blink
when the blink rate is set to zero. The value must not be negative.
Specifies the initial width of the text window as an integer number of
characters. The width equals the number of characters specified by
this resource multiplied by the maximum character width of the associ-
ated font. For proportionate fonts, the actual number of characters
that fit on a given line may be greater than the value specified. The
value must be greater than 0. The default value depends on the value of
the XmNwidth resource. If no width is specified the default is 20. In-
dicates the position in the text where the current insert cursor is to
be located. Position is determined by the number of characters from
the beginning of the text. Indicates that the insert cursor position
is marked by a blinking text cursor when the Boolean is True. Indi-
cates that the user can edit the text string when set to True. A false
value will prohibit the user from editing the text. Specifies the list
of callbacks called when TextField accepts input focus. The type of
the structure whose address is passed to this callback is XmAnyCall-
backStruct. The reason sent by the callback is XmCR_FOCUS. Specifies
the font list to be used for TextField. If this value is NULL at ini-
tialization, it is initialized by looking up the parent hierarchy of
the widget for an ancestor that is a subclass of the XmBulletinBoard or
VendorShell widget class. If such an ancestor is found, the font list
is initialized to the XmNtextFontList of the ancestor widget. If no
such ancestor is found, the default is implementation dependent. Refer
to XmFontList(3X) for more information on a font list structure.
TextField searches the font list for the first occurrence of a
font set that has a XmFONTLIST_DEFAULT_TAG. If a default ele-
ment is not found, the first font set in the font list is used.
If the list contains no font sets, the first font in the font
list is used. Specifies the list of callbacks that are called
when the user invokes an event that cause the text widget to
gain ownership of the primary selection. The callback reason for
this callback is XmCR_GAIN_PRIMARY. Specifies the list of call-
backs that are called when the user invokes an event that cause
the text widget to lose ownership of the primary selection. The
callback reason for this callback is XmCR_LOSE_PRIMARY. Speci-
fies the list of callbacks that is called before TextField wid-
get loses input focus. The type of the structure whose address
is passed to this callback is XmTextVerifyCallbackStruct. The
reason sent by the callback is XmCR_LOSING_FOCUS. Specifies the
distance between the top edge of the widget window and the text,
and the bottom edge of the widget window and the text. Speci-
fies the distance between the left edge of the widget window and
the text, and the right edge of the widget window and the text.
Specifies the maximum length of the text string that can be en-
tered into text from the keyboard. This value must be non-nega-
tive. Strings that are entered using the XmNvalue resource or
the XmTextFieldSetString() function ignore this resource. Spec-
ifies the list of callbacks that is called before text is
deleted from or inserted into TextField. The type of the struc-
ture whose address is passed to this callback is XmTextVerify-
CallbackStruct. The reason sent by the callback is XmCR_MODIFY-
ING_TEXT_VALUE. When multiple TextField widgets share the same
source, only the widget that initiates the source change will
generate the XmNmodifyVerifyCallback.
If both XmNmodifyVerifyCallback and XmNmodifyVerifyCallbackWcs
are registered callback lists, the procedure(s) in the XmNmodi-
fyVerifyCallback list are always executed first; and the result-
ing data, which may have been modified, is passed to the XmNmod-
ifyVerifyCallbackWcs callback routines. Specifies the list of
callbacks called before text is deleted from or inserted into
Text. The type of the structure whose address is passed to this
callback is XmTextVerifyCallbackStructWcs. The reason sent by
the callback is XmCR_MODIFYING_TEXT_VALUE. When multiple
TextField widgets share the same source, only the widget that
initiates the source change will generate the XmNmodifyVerify-
CallbackWcs.
If both XmNmodifyVerifyCallback and XmNmodifyVerifyCallbackWcs
are registered callback lists, the procedure(s) in the XmNmodi-
fyVerifyCallback list are always executed first; and the result-
ing data, which may have been modified, is passed to the XmNmod-
ifyVerifyCallbackWcs callback routines. Specifies the list of
callbacks that is called before the insert cursor is moved to a
new position. The type of the structure whose address is passed
to this callback is XmTextVerifyCallbackStruct. The reason sent
by the callback is XmCR_MOVING_INSERT_CURSOR. It is possible
more than one XmNmotionVerifyCallbacks to be generated from a
single action. Indicates that pending delete mode is on when
the Boolean is True. Pending deletion is defined as deletion of
the selected text when an insertion is made. Indicates that
TextField widget will attempt to resize its width to accommodate
all the text contained in the widget when Boolean is True. De-
fines the actions for multiple-mouse clicks. Each mouse click
performed within a half of a second of the previous mouse click
will increment the index into this array and perform the defined
action for that index. The possible actions are: XmSELECT_POSI-
TION--resets the insert cursor position. XmSELECT_WORD--selects
a word. XmSELECT_LINE--selects a line of text. Specifies the
number of actions that are defined in the XmNselectionArray re-
source. The value must not be negative. Specifies the number of
pixels of motion that is required to select the next character
when selection is performed using the click-drag mode of selec-
tion. The value must not be negative. Specifies the string
value of the TextField widget as a char* data value. If XmNvalue
and XmNvalueWcs are both defined, the value of XmNvalueWcs su-
persedes that of XmNvalue. XtGetValues returns a copy of the
value of the internal buffer and XtSetValues copies the string
values into the internal buffer. Specifies the list of call-
backs that is called after text is deleted from or inserted into
TextField. The type of the structure whose address is passed to
this callback is XmAnyCallbackStruct. The reason sent by the
callback is XmCR_VALUE_CHANGED. When multiple TextField widgets
share the same source, only the widget that initiates the source
change will generate the XmNvalueChangedCallback. This callback
represents a change in the source in the TextField, not in the
TextField widget. The XmNvalueChangedCallback should occur only
in pairs with a XmNmodifyVerifyCallback, assuming that the doit
flag in the callback structure of the XmNmodifyVerifyCallback is
not set to False. Specifies the string value of the TextField
widget as a wchar_t* data value. This resource cannot be speci-
fied in a resource file.
If XmNvalue and XmNvalueWcs are both defined, the value of XmN-
valueWcs supersedes that of XmNvalue. XtGetValues returns a copy
of the value of the internal buffer encoded as a wide character
string. XtSetValues copies the value of the wide character
string into the internal buffer. Specifies whether a bell will
sound when an action is reversed during a verification callback.
The default depends on the value of the ancestor VendorShell's
XmNaudibleWarning resource.
Inherited Resources
TextField widget inherits behavior and resources from the following su-
perclasses. For a complete description of these resources, refer to the
man page for that superclass.
XmPrimitive Resource Set
Class: XmCBottomShadowColor Default: dynamic Type: Pixel Access: CSG
Class: XmCBottomShadowPixmap Default: XmUNSPECIFIED_PIXMAP Type:
Pixmap Access: CSG Class: XmCForeground Default: dynamic Type: Pixel
Access: CSG Class: XmCCallback Default: NULL Type: XtCallbackList Ac-
cess: C Class: XmCHighlightColor Default: dynamic Type: Pixel Access:
CSG Class: XmCHighlightOnEnter Default: False Type: Boolean Access:
CSG Class: XmCHighlightPixmap Default: dynamic Type: Pixmap Access:
CSG Class: XmCHighlightThickness Default: 2 Type: Dimension Access:
CSG Class: XmCNavigationType Default: XmTAB_GROUP Type: XmNavigation-
Type Access: CSG Class: XmCShadowThickness Default: 2 Type: Dimension
Access: CSG Class: XmCTopShadowColor Default: dynamic Type: Pixel Ac-
cess: CSG Class: XmCTopShadowPixmap Default: dynamic Type: Pixmap Ac-
cess: CSG Class: XmCTraversalOn Default: True Type: Boolean Access:
CSG Class: XmCUnitType Default: dynamic Type: unsigned char Access:
CSG Class: XmCUserData Default: NULL Type: XtPointer Access: CSG
Core Resource Set
Class: XmCAccelerators Default: dynamic Type: XtAccelerators Access:
CSG Class: XmCSensitive Default: dynamic Type: Boolean Access: G
Class: XmCBackground Default: dynamic Type: Pixel Access: CSG Class:
XmCPixmap Default: XmUNSPECIFIED_PIXMAP Type: Pixmap Access: CSG
Class: XmCBorderColor Default: XtDefaultForeground Type: Pixel Access:
CSG Class: XmCPixmap Default: XmUNSPECIFIED_PIXMAP Type: Pixmap Ac-
cess: CSG Class: XmCBorderWidth Default: 0 Type: Dimension Access: CSG
Class: XmCColormap Default: dynamic Type: Colormap Access: CG Class:
XmCDepth Default: dynamic Type: int Access: CG Class: XmCCallback De-
fault: NULL Type: XtCallbackList Access: C Class: XmCHeight Default:
dynamic Type: Dimension Access: CSG Class: XmCInitialResourcesPersis-
tent Default: True Type: Boolean Access: C Class: XmCMappedWhenManaged
Default: True Type: Boolean Access: CSG Class: XmCScreen Default: dy-
namic Type: Screen * Access: CG Class: XmCSensitive Default: True
Type: Boolean Access: CSG Class: XmCTranslations Default: dynamic
Type: XtTranslations Access: CSG Class: XmCWidth Default: dynamic
Type: Dimension Access: CSG Class: XmCPosition Default: 0 Type: Posi-
tion Access: CSG Class: XmCPosition Default: 0 Type: Position Access:
CSG
Callback Information
A pointer to the following structure is passed to each callback: type-
def struct {
int reason;
XEvent * event; } XmAnyCallbackStruct;
Indicates why the callback was invoked. Points to the XEvent that
triggered the callback.
The TextField widget defines a new callback structure for use with ver-
ification callbacks. Note that not all of the fields are relevant for
every callback reason. The application must first look at the reason
field and use only the structure members that are valid for the partic-
ular reason. The values startPos, endPos, and text in the callback
structure XmTextVerifyCallbackStruct may be modified upon receiving the
callback, and these changes will be reflected as the change made to the
source of the TextField widget. (For example, all keystrokes can be
converted to spaces or NULL characters when a password is entered into
a TextField widget.) The application programmer should not overwrite
the text field, but should attach data to that pointer.
A pointer to the following structure is passed to the callbacks for
XmNlosingFocusCallback, XmNmodifyVerifyCallback, and XmNmotionVerify-
Callback. typedef struct {
int reason;
XEvent *event;
Boolean doit;
XmTextPosition currInsert, newInsert;
XmTextPosition startPos, endPos;
XmTextBlock text; } XmTextVerifyCallbackStruct, *XmTextVerifyPtr;
Indicates why the callback was invoked. Points to the XEvent that
triggered the callback. It can be NULL. For example, changes made to
the Text widget programmatically do not have an event that can be
passed to the associated callback. Indicates whether that action that
invoked the callback will be performed. Setting doit to False negates
the action. Indicates the current position of the insert cursor. In-
dicates the position at which the user attempts to position the insert
cursor. Indicates the starting position of the text to modify. If the
callback is not a modify verification callback, this value is the same
as currInsert. Indicates the ending position of the text to modify.
If no text is replaced or deleted, then the value is the same as start-
Pos. If the callback is not a modify verification callback, this value
is the same as currInsert. Points to a structure of type XmTextBlock-
Rec.
This structure holds the textual information to be inserted.
typedef struct {
char *ptr;
int length;
XmTextFormat format } XmTextBlockRec, *XmTextBlock;
Is the text to be inserted. ptr points to a temporary storage space
that is reused after the callback is finished. Therefore, if an appli-
cation needs to save the text to be inserted, it should copy the text
into its own data space. Specifies the length of the text to be in-
serted. Specifies the format of the text, either XmFMT_8_BIT or
XmFMT_16_BIT.
A pointer to the following structure is passed to callbacks for XmNmod-
ifyVerifyCallbackWcs. typedef struct {
int reason;
XEvent *event;
Boolean doit;
XmTextPosition currInsert, newInsert;
XmTextPosition startPos, endPos;
XmWcsTextBlock text; } XmTextVerifyCallbackStructWcs, *XmTextVerifyP-
trWcs;
Indicates why the callback was invoked. Points to the XEvent that
triggered the callback. It can be NULL. For example, changes made to
the Text widget programmatically do not have an event that can be
passed to the associated callback. Indicates whether the action that
invoked the callback is performed. Setting doit to False negates the
action. Indicates the current position of the insert cursor. Indi-
cates the position at which the user attempts to position the insert
cursor. Indicates the starting position of the text to modify. If the
callback is not a modify verification callback, this value is the same
as currInsert. Indicates the ending position of the text to modify.
If no text is replaced or deleted, the value is the same as startPos.
If the callback is not a modify verification callback, this value is
the same as currInsert. Points to a structure of type XmTextBlock-
RecWcs.
This structure holds the textual information to be inserted.
typedef struct {
wchar_t *wcsptr;
int length; } XmTextBlockRecWcs, *XmTextBlockWcs;
Points to the wide character text to be inserted. Specifies the number
of characters to be inserted.
The following table describes the reasons for which the individual ver-
ification callback structure fields are valid:
l lw(3.7i). _ Reason Valid Fields _ XmCR_LOSING_FOCUS reason,
event, doit XmCR_MODIFYING_TEXT_VALUE T{ reason, event, doit, cur-
rInsert, newInsert, startPos, endPos, text T} XmCR_MOVING_INSERT_CUR-
SOR T{ reason, event, doit, currInsert, newInsert T} _
Translations
XmTextField includes translations from XmPrimitive. The XmTextField
translations are listed below. These translations may not directly cor-
respond to a translation table. The actions represent the effective be-
havior of the associated events, and they may differ in a right-to-left
language environment. BSelect Press: grab-focus() BSelect Motion:ex-
tend-adjust() BSelect Release:extend-end() BExtend Press: extend-
start() BExtend Motion:extend-adjust() BExtend Release:extend-end()
BToggle Press: move-destination() BDrag Press: process-bdrag() BDrag
Motion: secondary-adjust() BDrag Release: copy-to() MCtrl BDrag
Press:process-bdrag() MCtrl BDrag Motion:secondary-adjust() MCtrl BDrag
Release:copy-to() MShift BDrag Press:process-bdrag() MShift BDrag Mo-
tion:secondary-adjust() MShift BDrag Release:move-to() MAlt BDrag
Press:process-bdrag() MAlt BDrag Motion:secondary-adjust() MAlt BDrag
Release:copy-to() MAlt MCtrl BDrag Release:copy-to() MAlt MShift BDrag
Release:move-to() KUp: traverse-prev() KDown: tra-
verse-next() KLeft: backward-character() MShift KLeft: key-se-
lect(left) MCtrl KLeft: backward-word() MShift MCtrl KLeft:backward-
word(extend) KRight: forward-character() MShift KRight: key-se-
lect(right) MCtrl KRight: forward-word() MShift MCtrl KRight:forward-
word(extend) KPageLeft: page-left() KPageRight: page-right()
KBeginLine: beginning-of-line() MShift KBeginLine:beginning-of-
line(extend) KEndLine: end-of-line() MShift KEndLine:end-of-
line(extend) KNextField: next-tab-group() KPrevField: prev-tab-
group() KActivate: activate() KDelete: delete-next-charac-
ter() KBackSpace: delete-previous-character() KAddMode: toggle-
add-mode() KSpace: self-insert() MShift KSpace: self-insert()
KSelect: set-anchor() KExtend: key-select() MAny KCancel:
process-cancel() KClear: clear-selection() KSelectAll: se-
lect-all() KDeselectAll: deselect-all() KCut: cut-clipboard()
KCopy: copy-clipboard() KPaste: paste-clipboard() KPri-
maryCut: cut-primary() KPrimaryCopy: copy-primary() KPrimaryPaste:
copy-primary() KHelp: Help() KAny: self-insert()
Action Routines
The XmText action routines are described below: Calls the callbacks for
XmNactivateCallback. If the parent is a manager, passes the event to
the parent. Moves the insertion cursor one character to the left. For
other effects, see the description of navigation operations in the
"Keyboard Selection" section in XmText(3X). This action may have dif-
ferent behavior in a right-to-left language environment. If this ac-
tion is called with no argument, moves the insertion cursor to the
first non-whitespace character after the first whitespace character to
the left or after the beginning of the line. If the insertion cursor is
already at the beginning of a word, moves the insertion cursor to the
beginning of the previous word. For other effects, see the description
of navigation operations in the "Keyboard Selection" section in Xm-
Text(3X). This action may have different behavior in a locale other
than the C locale.
If called with an argument of extend, moves the insertion cursor
as in the case of no argument and extends the current selection.
For other effects, see the description of shifted navigation op-
erations in the "Keyboard Selection" section in XmText(3X). If
this action is called with no argument, moves the insertion cur-
sor to the beginning of the line. For other effects, see the de-
scription of navigation operations in the "Keyboard Selection"
section in XmText(3X).
If called with an argument of extend, moves the insertion cursor
as in the case of no argument and extends the current selection.
For other effects, see the description of shifted navigation op-
erations in the "Keyboard Selection" section in XmText(3X).
Clears the current selection by replacing each character except
<Return> with a <space> character. Copies the current selection
to the clipboard. Copies the primary selection to just before
the insertion cursor. If a secondary selection exists, copies
the secondary selection to just before the insertion cursor. If
no secondary selection exists, copies the primary selection to
the pointer location. Cuts the current selection to the clip-
board. Cuts the primary selection to just before the insertion
cursor. In normal mode if there is a non-null selection,
deletes the selection, otherwise deletes the character following
the insertion cursor. In add mode if there is a non-null selec-
tion, the cursor is not disjoint from the selection and XmNpend-
ingDelete is set to True, deletes the selection, otherwise
deletes the character following the insertion cursor. This may
impact the selection. In normal mode if there is a non-null se-
lection, deletes the selection, otherwise deletes the characters
following the insertion cursor to the next space, tab or end of
line character. In add mode if there is a non-null selection,
the cursor is not disjoint from the selection and XmNpend-
ingDelete is set to True, deletes the selection, otherwise
deletes the characters following the insertion cursor to the
next space, tab or end of line character. This may impact the
selection. This action may have different behavior in a locale
other than the C locale. In normal mode if there is a non-null
selection, deletes the selection, otherwise deletes the charac-
ter of text immediately preceding the insertion cursor. In add
mode if there is a non-null selection, the cursor is not dis-
joint from the selection and XmNpendingDelete is set to True,
deletes the selection, otherwise deletes the character of text
immediately preceding the insertion cursor. This may impact the
selection. In normal mode if there is a non-null selection,
deletes the selection, otherwise deletes the characters preced-
ing the insertion cursor to the next space, tab or beginning of
the line character. In add mode if there is a non-null selec-
tion, the cursor is not disjoint from the selection and XmNpend-
ingDelete is set to True, deletes the selection, otherwise
deletes the characters preceding the insertion cursor to the
next space, tab or beginning of line character. This may impact
the selection. This action may have different behavior in a lo-
cale other than the C locale. Deletes the current selection.
In normal mode if there is a non-null selection, deletes the se-
lection, otherwise deletes the characters following the inser-
tion cursor to the next end of line character. In add mode if
there is a non-null selection, the cursor is not disjoint from
the selection and XmNpendingDelete is set to True, deletes the
selection, otherwise deletes the characters following the inser-
tion cursor to the next end of line character. This may impact
the selection. In normal mode if there is a non-null selection,
deletes the selection, otherwise deletes the characters preced-
ing the insertion cursor to the previous beginning of line char-
acter. In add mode if there is a non-null selection, the cursor
is not disjoint from the selection and XmNpendingDelete is set
to True, deletes the selection, otherwise deletes the characters
preceding the insertion cursor to the previous beginning of line
character. This may impact the selection. Deselects the current
selection. If this action is called with no argument, moves the
insertion cursor to the end of the line. For other effects, see
the description of navigation operations in the "Keyboard Selec-
tion" section in XmText(3X). If called with an argument of ex-
tend, moves the insertion cursor as in the case of no argument
and extends the current selection. For other effects, see the
description of shifted navigation operations in the "Keyboard
Selection" section in XmText(3X). Selects text from the anchor
to the pointer position and deselects text outside that range.
Moves the insertion cursor to the position of the pointer. Ad-
justs the anchor using the balance-beam method. Selects text
from the anchor to the pointer position and deselects text out-
side that range. Moves the insertion cursor one character to
the right. For other effects, see the description of navigation
operations in the "Keyboard Selection" section in XmText(3X).
This action may have different behavior in a right-to-left lan-
guage environment. If this action is called with no argument,
moves the insertion cursor to the first whitespace character or
end of line following the next non-whitespace character. If the
insertion cursor is already at the end of a word, moves the in-
sertion cursor to the end of the next word. For other effects,
see the description of navigation operations in the "Keyboard
Selection" section in XmText(3X). This action may have different
behavior in a locale other than the C locale. If called with an
argument of extend, moves the insertion cursor as in the case of
no argument and extends the current selection. For other ef-
fects, see the description of shifted navigation operations in
the "Keyboard Selection" section in XmText(3X). This key bind-
ing performs the action defined in the XmNselectionArray, de-
pending on the number of multiple mouse clicks. The default se-
lection array ordering is one click to move the insertion cursor
to the pointer position, two clicks to select a word, three
clicks to select a line of text, and four clicks to select all
text. A single click also deselects any selected text and sets
the anchor at the pointer position. This action may have differ-
ent behavior in a locale other than the C locale. Calls the
callbacks for XmNhelpCallback if any exist. If there are no help
callbacks for this widget, this action calls the help callbacks
for the nearest ancestor that has them. If called with an argu-
ment of right, moves the insertion cursor one character to the
right and extends the current selection. If called with an ar-
gument of left, moves the insertion cursor one character to the
left and extends the current selection. If called with no argu-
ment, extends the current selection. For other effects, see the
description of shifted navigation operations and KExtend in the
"Keyboard Selection" section in XmText(3X). Moves the insertion
cursor to the pointer position without changing any existing
current selection. If there is no current selection, sets the
widget as the destination widget. If a secondary selection ex-
ists, cuts the secondary selection to just before the insertion
cursor. If no secondary selection exists, cuts the primary se-
lection to the pointer location. Traverses to the next tab
group. Scrolls the viewing window left one page of text.
Scrolls the viewing window right one page of text. Pastes the
contents of the clipboard before the insertion cursor. Tra-
verses to the previous tab group. The result of this action is
determined by several factors: position of the location cursor,
movement of the location cursor, and the interval between a
BDrag press and release.
This action copies the current selection to the insertion cursor
if text is selected, the location cursor is disjoint from the
selection, and no motion is detected within a given time inter-
val.
It performs a secondary selection and copies the selection to
the position where the text was last edited if the cursor is
disjoint from a current selection (if one exists), the time in-
terval is exceeded, and movement of the location cursor is de-
tected.
The action drags the current selection if the location cursor is
positioned on the selection, the time interval is exceeded, and
movement of the location cursor is detected. This action cre-
ates a DragContext object whose XmNexportTargets resource value
includes target types of COMPOUND_TEXT, STRING, and TEXT. Can-
cels the current extend-adjust(), secondary-adjust() or process-
bdrag operation and leaves the selection state as it was before
the operation, otherwise, and the parent is a manager, it passes
the event to the parent. Extends the secondary selection to the
pointer position. Marks the beginning of a secondary selection.
Selects all text. If XmNpendingDelete is True and the cursor is
not disjoint from the current selection, deletes the entire se-
lection. Inserts the character associated with the key pressed
before the insertion cursor. Resets the anchor point for ex-
tended selections. Resets the destination of secondary selec-
tion actions. Toggles the state of Add Mode. Toggles the state
of the text insertion mode. By default, characters typed into
the TextField widget are inserted before the position of the in-
sertion cursor. In overstrike mode, characters entered into the
TextField widget replace the characters that directly follow the
insertion cursor. In overstrike mode, when the end of a line is
reached, characters are appended to the end of the line. Tra-
verses to the first widget in the tab group. Traverses to the
next widget in the tab group. Traverses to the previous widget
in the tab group.
Additional Behavior
This widget has the additional behavior described below: Draws the in-
sertion cursor as solid and starts blinking the cursor. Displays the
insertion cursor as a stippled I-beam unless it is the destination wid-
get.
Virtual Bindings
The bindings for virtual keys are vendor specific. The following table
lists the TextField-specific bindings of virtual keys to actual key
event descriptions in 1/Motif:
l s l l. _ Virtual Key Bindings Valid Fields Virtual Key Actual
Key Events _ KExtend Ctrl Shift<Key>space Shift<Key>osfSelect
KSelect Ctrl<Key>space <Key>osfSelect _
For information about bindings for virtual buttons and keys, see Virtu-
alBindings(3X).
SEE ALSO
Core(3X), XmCreateTextField(3X), XmFontList(3X), XmFontListAppendEn-
try(3X), XmPrimitive(3X), XmTextFieldClearSelection(3X), XmTextField-
Copy(3X), XmTextFieldCut(3X), XmTextFieldGetBaseline(3X), XmTextField-
GetEditable(3X), XmTextFieldGetInsertionPosition(3X), XmTextFieldGet-
LastPosition(3X), XmTextFieldGetMaxLength(3X), XmTextFieldGetSelec-
tion(3X), XmTextFieldGetSelectionPosition(3X), *LXmTextFieldGetSelec-
tionWcs(3X), XmTextFieldGetString(3X), XmTextFieldGetStringWcs(3X), Xm-
TextFieldGetSubstring(3X), XmTextFieldGetSubstringWcs(3X), XmTextField-
Insert(3X), XmTextFieldInsertWcs(3X), XmTextFieldPaste(3X), Xm-
TextFieldPosToXY(3X), XmTextFieldRemove(3X), XmTextFieldReplace(3X),
XmTextFieldReplaceWcs(3X), XmTextFieldSetAddMode(3X), XmTextFieldSetEd-
itable(3X), XmTextFieldSetHighlight(3X), XmTextFieldSetInsertionPosi-
tion(3X), XmTextFieldSetMaxLength(3X), XmTextFieldSetSelection(3X), Xm-
TextFieldSetString(3X), XmTextFieldSetStringWcs(3X), XmTextFieldShowPo-
sition(3X), XmTextFieldXYToPos(3X)
XmTextField(3X)