Blob Blame History Raw
'\" t
...\" Text.sgm /main/17 1996/09/25 15:55:18 cdedoc $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmText" "library call"
.SH "NAME"
\fBXmText\fP \(em The Text widget class
.iX "XmText"
.iX "widget class" "Text"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Text\&.h>
.fi
.SH "DESCRIPTION"
.PP
Text provides a single-line and multiline text editor for customizing both user and
programmatic interfaces\&. It can be used for single-line string entry,
forms entry with verification procedures, and full-window editing\&.
It provides an application with a consistent editing system for
textual data\&. The screen\&'s textual data adjusts to the
application writer\&'s needs\&.
.PP
Text provides separate callback lists to verify
movement of the insert cursor, modification of the text, and
changes in input focus\&. 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 legitimate state change and can signal the widget
whether to continue with the action\&.
.PP
The user interface tailors a new set of translations\&. The default
translations provide key bindings for insert cursor movement, deletion,
insertion, and selection of text\&.
.PP
Text allows the user to select regions of text\&.
Selection is based on the model specified in the \fIInter-Client
Communication Conventions Manual\fP (ICCCM)\&. Text supports primary
and secondary selection\&.
.PP
In some Asian languages, texts are drawn vertically\&. Also, some characters
are displayed with 90-degree clockwise rotation, and other characters are mapped
to vertical glyphs that differ from the normal horizaontal
glyphs\&.
Information about which characters require rotation or
mapping to vertical glyphs is specified in the X Locale Database (NLS
databases) and handled by X library, depending on
\fBXNOrientation\fP \fBXOC\fR values\&.
\fBXmText\fP widget should also handle the vertically aligned
lines as for editing, entering, or selecting texts\&.
.PP
The vertical writing feature of the \fBXmText\fP widget is enabled when the
\fBXmTOP_TO_BOTTOM\fP value is specified for the \fBXmNlayoutDirection\fP
resource of the \fBXmText\fP widget\&. In that case, the horizontal scroll
bar is displayed on the bottom of the \fBXmText\fP widget and the vertical
scroll bar is displayed on the left side\&.
.SS "Mouse Selection"
.PP
The Text widget allows text to be edited, inserted, and selected\&.
The user can cut, copy, and paste text by using the clipboard, primary
transfer, or secondary transfer\&.
Text also provides a Drag and Drop facility that enables the user to
copy or move data within Text or to a different widget\&.
When
keyboard focus policy is set to EXPLICIT, the widget that receives
focus is the destination widget\&. In POINTER mode, any keyboard
or mouse operation (except secondary selection) in an
editable widget establishes that widget as the destination\&.
.PP
If a destination widget becomes insensitive or uneditable, it forfeits
its destination status\&. In EXPLICIT mode, when a widget becomes
insensitive, the focus moves to another widget\&. If that widget
is editable, it becomes the destination widget; otherwise, there
is no destination widget\&. The text of any insensitive Text widget
is stippled, indicating its state to the user\&.
.PP
The insertion cursor, displayed as an I-beam, shows where input is
inserted\&. Input is inserted just before the insertion cursor\&.
.PP
Text uses the \fBXmQTnavigator\fP, \fBXmQTspecifyRenderTable\fP, and
\fBXmQTscrollFrame\fP traits,
and holds the \fBXmQTaccessTextual\fP
and \fBXmQTtransfer\fP traits\&.
The widget checks its parent for the \fBXmQTscrollFrame\fP trait\&. If this
trait does not exist, then the widget has no scrolling\&. If the trait
does exist, and the ScrollFrame widget has not been initialized, the widget
creates two navigators and sets up the scrollbars\&.
.PP
If an application or widget calls the \fBsetValue\fP trait method
of \fBXmQTaccessTextual\fP, then \fBXmText\fP will call
\fBXmTextSetString\fP to set the string value\&.
.SS "Classes"
.PP
Text inherits behavior, resources, and traits from \fBCore\fP and
\fBXmPrimitive\fP\&.
.PP
The class pointer is \fBxmTextWidgetClass\fP\&.
.PP
The class name is \fBXmText\fP\&.
.SS "Data Transfer Behavior"
.PP
Text supports transfer of the primary, secondary, and clipboard
selections and dragging of selected text from the widget\&.
Text can also be the destination for the primary, secondary, and
clipboard selections, and it supports dropping of data being dragged
onto the widget\&.
.PP
When the \fBXmNconvertCallback\fP procedures are called, the
\fBlocation_data\fP member of the \fBXmConvertCallbackStruct\fR member
is NULL if the selected text is being transferred\&.
If the entire text, not the selected text, is being transferred, the
value of this member is the widget ID of the Text widget\&.
.PP
As a source of data, Text supports the following targets and associated
conversions of data to these targets:
.IP "\fIlocale\fP" 10
If the \fIlocale\fP target matches the widget\&'s locale, the widget
transfers the selected text in the encoding of the locale\&.
.IP "\fBCOMPOUND_TEXT\fP" 10
The widget transfers the selected text as type \fBCOMPOUND_TEXT\fP\&.
.IP "\fBSTRING\fP" 10
The widget transfers the selected text as type \fBSTRING\fP\&.
.IP "\fBTEXT\fP" 10
If the selected text is fully convertible to the encoding of the locale,
the widget transfers the selected text in the encoding of the locale\&.
Otherwise, the widget transfers the selected text as type
\fBCOMPOUND_TEXT\fP\&.
.IP "\fBUTF8_STRING\fP" 10
The widget transfers the selected text as type \fBUTF8_STRING\fP\&.
.IP "\fBDELETE\fP" 10
The widget deletes the selected text\&.
.IP "\fB_MOTIF_CLIPBOARD_TARGETS\fP" 10
The widget transfers, as type \fBATOM\fP, a list of the targets to which
the widget can convert data to be placed on the clipboard immediately\&.
If the selected text is fully convertible to \fBSTRING\fP, these include
\fBSTRING\fP; otherwise, they include \fBCOMPOUND_TEXT\fP\&.
.IP "\fB_MOTIF_DEFERRED_CLIPBOARD_TARGETS\fP" 10
The widget transfers, as type \fBATOM\fP, a list of the targets it
supports for delayed transfer for the \fBCLIPBOARD\fP selection\&.
This widget currently supplies no targets for
\fB_MOTIF_DEFERRED_CLIPBOARD_TARGETS\fP\&.
.IP "\fB_MOTIF_EXPORT_TARGETS\fP" 10
The widget transfers, as type \fBATOM\fP, a list of the targets to be
used as the value of the DragContext\&'s \fBXmNexportTargets\fP in a
drag-and-drop transfer\&.
These include \fBCOMPOUND_TEXT\fP, \fBUTF8_STRING\fP,
the encoding of the locale,
\fBSTRING\fP, \fBTEXT\fP, \fBBACKGROUND\fP, and \fBFOREGROUND\fP\&.
.IP "\fB_MOTIF_LOSE_SELECTION\fP" 10
The widget takes the following actions:
.RS
.IP "   \(bu" 6
When losing the \fBPRIMARY\fP selection, it unhighlights the selected
text and calls the \fBXmNlosePrimaryCallback\fP procedures\&.
.IP "   \(bu" 6
When losing the \fBSECONDARY\fP selection, it removes the secondary
selection highlight\&.
.IP "   \(bu" 6
When losing the \fB_MOTIF_DESTINATION\fP selection, if the widget does
not have focus, it changes the cursor to indicate that the widget is no
longer the destination\&.
.RE
.PP
As a source of data, Text also supports the following standard Motif
targets:
.IP "\fBBACKGROUND\fP" 10
The widget transfers \fBXmNbackground\fP as type \fBPIXEL\fP\&.
.IP "\fBCLASS\fP" 10
The widget finds the first shell in the widget hierarchy that has a
\fBWM_CLASS\fP property and transfers the contents as text in the
current locale\&.
.IP "\fBCLIENT_WINDOW\fP" 10
The widget finds the first shell in the widget hierarchy and transfers
its window as type \fBWINDOW\fP\&.
.IP "\fBCOLORMAP\fP" 10
The widget transfers \fBXmNcolormap\fP as type \fBCOLORMAP\fP\&.
.IP "\fBFOREGROUND\fP" 10
The widget transfers \fBXmNforeground\fP as type \fBPIXEL\fP\&.
.IP "\fBNAME\fP" 10
The widget finds the first shell in the widget hierarchy that has a
\fBWM_NAME\fP property and transfers the contents as text in the current
locale\&.
.IP "\fBTARGETS\fP" 10
The widget transfers, as type \fBATOM\fP, a list of the targets it
supports\&.
These include the standard targets in this list\&.
These also include \fBCOMPOUND_TEXT\fP, \fBUTF8_STRING\fP,
the encoding of the locale, \fBSTRING\fP, and \fBTEXT\fP\&.
.IP "\fBTIMESTAMP\fP" 10
The widget transfers the timestamp used to acquire the selection as type
\fBINTEGER\fP\&.
.IP "\fB_MOTIF_RENDER_TABLE\fP" 10
The widget transfers \fBXmNrenderTable\fP if it exists, or else the
default text render table, as type \fBSTRING\fP\&.
.IP "\fB_MOTIF_ENCODING_REGISTRY\fP" 10
The widget transfers its encoding registry as type \fBSTRING\fP\&.
The value is a list of NULL separated items in the
form of tag encoding pairs\&.
This target symbolizes the transfer target for the
Motif Segment Encoding Registry\&.
Widgets and applications can use this Registry to register
text encoding formats for specified render table tags\&.
Applications access this Registry by calling
\fBXmRegisterSegmentEncoding\fP and \fBXmMapSegmentEncoding\fP\&.
.PP
As a destination for data, Text chooses a target and requests conversion
of the selection to that target\&.
If the encoding of the locale is present in the list of available
targets, Text chooses a requested target from the available targets in
the following order of preference:
.IP "   1." 6
The encoding of the locale
.IP "   2." 6
\fBTEXT\fP
.IP "   4." 6
\fBUTF8_STRING\fP
.IP "   3." 6
\fBCOMPOUND_TEXT\fP
.IP "   4." 6
\fBSTRING\fP
.PP
If the encoding of the locale is not present in the list of available
targets, Text chooses a requested target from the available targets in
the following order of preference:
.IP "   4." 6
\fBUTF8_STRING\fP
.IP "   1." 6
\fBCOMPOUND_TEXT\fP
.IP "   2." 6
\fBSTRING\fP
.SS "New Resources"
.PP
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 \fB\&.Xdefaults\fP file, remove the \fBXmN\fP or
\fBXmC\fP prefix and use the remaining letters\&. To specify one of the defined
values for a resource in a \fB\&.Xdefaults\fP file, remove the \fBXm\fP 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 \fBXtSetValues\fP (S),
retrieved by using \fBXtGetValues\fP (G), or is not applicable (N/A)\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmText Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNactivateCallbackXmCCallbackXtCallbackListNULLC
_____
XmNautoShowCursorPositionXmCAutoShowCursorPositionBooleanTrueCSG
_____
XmNcursorPositionXmCCursorPositionXmTextPosition0CSG
_____
XmNcursorPositionVisibleXmCCursorPositionVisibleBooleandynamicCSG
_____
XmNdestinationCallbackXmCCallbackXtCallbackListNULLC
_____
XmNeditableXmCEditableBooleanTrueCSG
_____
XmNeditModeXmCEditModeintXmSINGLE_LINE_EDITCSG
_____
XmNfocusCallbackXmCCallbackXtCallbackListNULLC
_____
XmNgainPrimaryCallbackXmCCallbackXtCallbackListNULLC
_____
XmNlosePrimaryCallbackXmCCallbackXtCallbackListNULLC
_____
XmNlosingFocusCallbackXmCCallbackXtCallbackListNULLC
_____
XmNmarginHeightXmCMarginHeightDimension5CSG
_____
XmNmarginWidthXmCMarginWidthDimension5CSG
_____
XmNmaxLengthXmCMaxLengthintlargest integerCSG
_____
XmNmodifyVerifyCallbackXmCCallbackXtCallbackListNULLC
_____
XmNmodifyVerifyCallbackWcsXmCCallbackXtCallbackListNULLC
_____
XmNmotionVerifyCallbackXmCCallbackXtCallbackListNULLC
_____
XmtotalLinesXmCTotalLinesintdynamicC
_____
XmNsourceXmCSourceXmTextSourceDefault sourceCSG
_____
XmNtopCharacterXmCTopCharacterXmTextPosition0CSG
_____
XmNvalueXmCValueString""CSG
_____
XmNvalueChangedCallbackXmCCallbackXtCallbackListNULLC
_____
XmNvalueWcsXmCvalueWcswchar_t *(wchar_t *)""CSG\u1\d
_____
XmNverifyBellXmCVerifyBellBooleandynamicCSG
.TE
.PP
\u1\d This resource cannot be set in a resource file\&.
.IP "\fBXmNactivateCallback\fP" 10
Specifies the list of callbacks that is called when the user invokes an
event that calls the
activate() action\&.
The type of the structure whose address is passed to this callback is
\fBXmAnyCallbackStruct\fR\&.
The reason sent by the callback is \fBXmCR_ACTIVATE\fP\&.
.IP "\fBXmNautoShowCursorPosition\fP" 10
Ensures that the visible text contains the insert cursor when set
to True\&.
If the insert cursor changes, the contents
of Text may scroll in order to bring the insertion
point into the window\&.
Setting this resource to False, however, does not ensure that Text
will not scroll\&.
.IP "\fBXmNcursorPosition\fP" 10
Indicates 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\&.
The first character position is 0 (zero)\&.
.IP "\fBXmNcursorPositionVisible\fP" 10
If the widget has an \fBXmPrintShell\fP as one of its ancestors, then the
default value is \fBFalse\fP; otherwise, it is \fBTrue\fP\&.
.IP "\fBXmNdestinationCallback\fP" 10
Specifies a list of callbacks called when the widget is the destination
of a transfer operation\&.
The type of the structure whose address is passed to these callbacks is
\fBXmDestinationCallbackStruct\fR\&.
The reason is \fBXmCR_OK\fP\&.
.IP "\fBXmNeditable\fP" 10
When set to True, indicates that the user can edit the text string\&.
Prohibits the user from editing the text when set to False\&.
.IP "" 10
When \fBXmNeditable\fP is used on a widget
it sets the dropsite to \fBXmDROP_SITE_ACTIVE\fP\&.
.IP "\fBXmNeditMode\fP" 10
Specifies the set of keyboard bindings used in Text\&.
The default, \fBXmSINGLE_LINE_EDIT\fP,
provides the set of key bindings to be used in editing
single-line text\&.
\fBXmMULTI_LINE_EDIT\fP provides the set of key bindings to be
used in editing multiline text\&.
.IP "" 10
The results of placing a Text widget inside a ScrolledWindow when the
Text\&'s \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP are undefined\&.
.IP "\fBXmNfocusCallback\fP" 10
Specifies the list of callbacks called
when Text accepts input focus\&. The type of the structure whose
address is passed to this callback is \fBXmAnyCallbackStruct\fR\&.
The reason sent by the callback is \fBXmCR_FOCUS\fP\&.
.IP "\fBXmNgainPrimaryCallback\fP" 10
Specifies the list of callbacks called when an event causes the Text
widget to gain ownership of the primary selection\&.
The reason sent by the callback is \fBXmCR_GAIN_PRIMARY\fP\&.
.IP "\fBXmNlosePrimaryCallback\fP" 10
Specifies the list of callbacks called when an event causes the Text
widget to lose ownership of the primary selection\&.
The reason sent by the callback is \fBXmCR_LOSE_PRIMARY\fP\&.
.IP "\fBXmNlosingFocusCallback\fP" 10
Specifies the list of callbacks called
before Text loses input focus\&.
The type of the structure whose address is passed to this callback is
\fBXmTextVerifyCallbackStruct\fR\&.
The reason sent by the callback is \fBXmCR_LOSING_FOCUS\fP\&.
.IP "\fBXmNmarginHeight\fP" 10
Specifies the distance between the top edge of the widget
window and the text, and between the bottom edge of the widget
window and the text\&.
.IP "\fBXmNmarginWidth\fP" 10
Specifies the distance between the left edge of the widget
window and the text, and between the right edge of the widget
window and the text\&.
.IP "\fBXmNmaxLength\fP" 10
Specifies the maximum length of the text string that can be entered into
text from the keyboard\&. This value must be nonnegative\&.
Strings that are entered by using the \fBXmNvalue\fP resource or the
\fBXmTextSetString\fP function ignore this resource\&.
.IP "\fBXmNmodifyVerifyCallback\fP" 10
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
\fBXmTextVerifyCallbackStruct\fR\&.
The reason sent by the callback is \fBXmCR_MODIFYING_TEXT_VALUE\fP\&.
When multiple Text widgets share the same
source, only the widget that initiates the source change will
generate \fBXmNmodifyVerifyCallback\fP\&.
.IP "" 10
If both \fBXmNmodifyVerifyCallback\fP and \fBXmNmodifyVerifyCallbackWcs\fP
are registered callback lists, the procedure(s) in the
\fBXmNmodifyVerifyCallback\fP list is always executed first; and the
resulting data, which may have been modified, is passed to the
\fBXmNmodifyVerifyCallbackWcs\fP callback routines\&.
.IP "\fBXmNmodifyVerifyCallbackWcs\fP" 10
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 \fBXmTextVerifyCallbackStructWcs\fR\&. The
reason sent by the callback is \fBXmCR_MODIFYING_TEXT_VALUE\fP\&.
When multiple Text widgets share the same
source, only the widget that initiates the source change will
generate the \fBXmNmodifyVerifyCallbackWcs\fP\&.
.IP "" 10
If both \fBXmNmodifyVerifyCallback\fP and \fBXmNmodifyVerifyCallbackWcs\fP
are registered callback lists, the procedure(s) in the
\fBXmNmodifyVerifyCallback\fP list is always executed first; and the
resulting data, which may have been modified, is passed to the
\fBXmNmodifyVerifyCallbackWcs\fP callback routines\&.
.IP "\fBXmNmotionVerifyCallback\fP" 10
Specifies the list of callbacks called
before the insert cursor is moved to a new position\&.
The type of the structure whose address is passed to this callback is
\fBXmTextVerifyCallbackStruct\fR\&.
The reason sent by the callback is \fBXmCR_MOVING_INSERT_CURSOR\fP\&.
It is possible for more than one \fBXmNmotionVerifyCallback\fP to
be generated from a single action\&.
.IP "\fBXmNsource\fP" 10
Specifies the source with which the widget displays text\&.
If no source is specified, the widget creates a default string source\&.
This resource can be used to share text sources between Text widgets\&.
.IP "\fBXmNtopCharacter\fP" 10
Displays the position of text at the top of the window\&.
Position is determined by the number of characters from the
beginning of the text\&.
The first character position is 0 (zero)\&.
.IP "" 10
If the \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP, the line of text
that contains the top character is displayed at the top of the widget
without shifting the text left or right\&.
\fBXtGetValues\fP for \fBXmNtopCharacter\fP returns the position of the
first character in the line that is displayed at the top of the widget\&.
.IP "\fBXmNtotalLines\fP" 10
Indicates the number of lines in the text widget buffer (not necessarily
visible)\&. The initial value 1 means the text buffer is empty\&. The number
of lines reported takes into account the \fBwordWrap\fP policy
(that is, it\&'s not simply the number of newline characters\&.
.IP "\fBXmNvalue\fP" 10
Specifies the string value of the Text widget as a \fBchar*\fP
data value\&.
Moves the cursor to position 0 unless a value of
\fBXmNcursorPosition\fP was explicitly supplied in the argument list\&.
If \fBXmNvalue\fP and \fBXmNvalueWcs\fP are both
defined, the value of \fBXmNvalueWcs\fP supersedes that of
\fBXmNvalue\fP\&. \fBXtGetValues\fP returns a copy of the value of
the internal buffer and \fBXtSetValues\fP copies the string values
into the internal buffer\&.
.IP "\fBXmNvalueChangedCallback\fP" 10
Specifies the list of callbacks called
after text is deleted from or inserted into
Text\&.
The type of the structure whose address is passed to this callback is
\fBXmAnyCallbackStruct\fR\&.
The reason sent by the callback is \fBXmCR_VALUE_CHANGED\fP\&.
When multiple Text widgets share the same
source, only the widget that initiates the source change will
generate the \fBXmNvalueChangedCallback\fP\&. This callback represents a
change in the source in the Text, not in the Text
widget\&. The \fBXmNvalueChangedCallback\fP should occur only in pairs
with an \fBXmNmodifyVerifyCallback\fP, assuming that the \fIdoit\fP
flag in the callback structure of the \fBXmNmodifyVerifyCallback\fP is
not set to False\&.
.IP "\fBXmNvalueWcs\fP" 10
Specifies the string value of the Text widget as a \fBwchar_t*\fP data
value\&.
Moves the cursor to position 0 unless a value of
\fBXmNcursorPosition\fP was explicitly supplied in the argument list\&.
.IP "" 10
This resource cannot be specified in a resource file\&.
.IP "" 10
If \fBXmNvalue\fP and \fBXmNvalueWcs\fP are both defined,
the value of \fBXmNvalueWcs\fP supersedes that of \fBXmNvalue\fP\&.
\fBXtGetValues\fP returns a copy of the value of the internal buffer
encoded as a wide character string\&. \fBXtSetValues\fP copies the
value of the wide character string into the internal buffer\&.
.IP "\fBXmNverifyBell\fP" 10
Specifies whether the bell should sound when the verification returns
without continuing the action\&.
The default depends on the value of the ancestor VendorShell\&'s
\fBXmNaudibleWarning\fP resource\&.
.TS
tab() box;
c s s s s
l l l l l.
\fBXmText Input Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
XmNpendingDeleteXmCPendingDeleteBooleanTrueCSG
XmNselectionArrayXmCSelectionArrayXtPointerdefault arrayCSG
XmNselectionArrayCountXmCSelectionArrayCountint4CSG
XmNselectThresholdXmCSelectThresholdint5CSG
.TE
.IP "\fBXmNpendingDelete\fP" 10
Indicates that pending delete mode is on when the Boolean value is True\&.
Pending deletion is defined as deletion
of the selected text when an insertion is made\&.
.IP "\fBXmNselectionArray\fP" 10
Defines the actions for multiple mouse clicks\&. The value of the
resource is an array of \fBXmTextScanType\fR elements\&.
\fBXmTextScanType\fR is an enumeration indicating possible actions\&.
Each mouse click performed within some time of the previous mouse
click increments the index into this array and performs the defined
action for that index\&. (This "multiclick" time is specified by the
operating environment, and varies among different systems\&. In general,
it is usually set to some fraction of a second\&.) The possible actions
in the order they occur in the default array are as follows:
.RS
.IP "   3." 6
\fBXmSELECT_POSITION\fP, which
resets the insert cursor position\&.
.IP "   4." 6
\fBXmSELECT_WORD\fP, which
selects a word\&.
.IP "   5." 6
\fBXmSELECT_LINE\fP, which
selects a line of text\&. This action sees a line as delimited by
\fIhard\fP newline characters\&. In other words, if the word wrap
feature is on (\fBXmNwordWrap\fP is True), this will ignore the
newlines automatically inserted by the widget\&. This is the default\&.
.IP "   6." 6
\fBXmSELECT_OUT_LINE\fP, which
selects a line of text\&. This action sees a line as delimited by
\fIhard\fP or \fIsoft\fP newline characters\&. In other words, if the
word wrap feature is on (\fBXmNwordWrap\fP is True), the newlines
automatically inserted by the widget will be treated as delimiting
lines\&.
.IP "   7." 6
\fBXmSELECT_ALL\fP, which
selects all of the text\&.
.RE
.IP "\fBXmNselectionArrayCount\fP" 10
Indicates the number of elements in the \fBXmNselectionArray\fP resource\&.
The value must not be negative\&.
.IP "\fBXmNselectThreshold\fP" 10
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 selection\&.
The value must not be negative\&.
This resource also specifies whether a drag should be started and the
number of pixels to start a drag when
\fBBtn2Down\fP and \fBBtn1Down\fP are integrated\&.
.TS
tab() box;
cw(1.3) sw(1.3) sw(1.3) sw(1.3) sw(1.3)
lw(1.3) lw(1.3) lw(1.3) lw(1.3) lw(1.3).
\fBXmText Output Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
XmNblinkRateXmCBlinkRateint500CSG
XmNcolumnsXmCColumnsshortdynamicCSG
XmNcursorPositionVisibleXmCCursorPositionVisibleBooleanTrueCSG
XmNfontListXmCFontListXmFontListdynamicCSG
XmNrenderTableXmCRenderTableXmRenderTabledynamicCSG
XmNresizeHeightXmCResizeHeightBooleanFalseCSG
XmNresizeWidthXmCResizeWidthBooleanFalseCSG
XmNrowsXmCRowsshortdynamicCSG
XmNwordWrapXmCWordWrapBooleanFalseCSG
.TE
.IP "\fBXmNblinkRate\fP" 10
Specifies the blink rate of the text cursor in milliseconds\&.
The time indicated in the blink rate relates to the
time the cursor is visible and the time the
cursor is invisible (that is, the time it takes to blink
the insertion cursor on and off is twice the blink
rate)\&. The cursor does not blink when the blink rate
is set to 0 (zero)\&.
The value must not be negative\&.
.IP "\fBXmNcolumns\fP" 10
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 width as derived from the specified
font\&. If the em-space
value is available,
it is used\&. If not, the width of the numeral "0" is used\&. If this is
not available, the maximum width is used\&.
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 (zero)\&. The default value depends
on the value of the \fBXmNwidth\fP resource\&.
If no width is specified the default is 20\&.
.IP "" 10
When the \fBXmNlayoutDirection\fP resource is \fBXmTOP_TO_BOTTOM\fP, and if the \fBXmText\fP
widget resource \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP, this attribute is
ignored\&. If no width is specified, the default is 1\&.
.IP "\fBXmNcursorPositionVisible\fP" 10
Indicates that the insert cursor position is marked by a text
cursor when the Boolean value is True\&.
.IP "\fBXmNfontList\fP" 10
Specifies the font list to be used for Text\&. The font list is an
obsolete structure and is retained only for compatibility with
earlier releases of Motif\&. Use the render table (\fBXmNrenderTable\fP)
instead of font lists wherever possible\&. If both are specified, the
render table will take precedence\&. If this value is NULL at
initialization, the parent hierarchy of the widget is searched for an
ancestor that holds the \fBXmQTspecifyRenderTable\fP trait\&. If such
an ancestor is found, the font list is initialized to the
\fBXmTEXT_RENDER_TABLE\fP value of the ancestor widget\&. If no such
ancestor is found, the default is implementation dependent\&.
.IP "" 10
Text searches the font list for the first occurrence of a font set
that has \fBXmFONTLIST_DEFAULT_TAG\fP\&. If a default element 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 will
be used\&. Refer to \fBXmFontList\fP(3) for
more information on a font list structure\&.
.IP "\fBXmNrenderTable\fP" 10
Specifies the render table to be used in deriving a font set or font
for rendering text\&. If both a render table and a font list are
specified, the render table will take precedence\&. If the value of
\fBXmNrenderTable\fP is NULL at initialization, the parent hierarchy
of the widget is searched for an ancestor that holds the
\fBXmQTspecifyRenderTable\fP trait\&. If such an ancestor is found, the
font list is initialized to the \fBXmTEXT_RENDER_TABLE\fP value of the
ancestor widget\&. If no such ancestor is found, the default is
implementation dependent\&.
.IP "" 10
Text searches the render table for the first occurrence of a rendition
that has the tag \fB_MOTIF_DEFAULT_LOCALE\fP\&. If a default element is
not found, the first rendition in the table is used\&. Refer to
\fBXmRenderTable\fP(3) for more information on the render table
structure\&.
.IP "\fBXmNresizeHeight\fP" 10
Indicates that Text will
attempt to resize its height to accommodate all the text
contained in the widget when the Boolean value is True\&. If the Boolean value is set to True,
the text is always
displayed, starting from the first position in the source, even if
instructed otherwise\&. This attribute is ignored when the application uses a
Text widget whose parent is a ScrolledWindow and when \fBXmNscrollVertical\fP is True\&.
.IP "" 10
When the \fBXmNlayoutDirection\fP resource is \fBXmTOP_TO_BOTTOM\fP, this resource
indicates that the text attempts to resize its height to accommodate all the
text contained in the widget when the Boolean value is \fBTrue\fP\&. This attribute
is ignored if \fBXmNwordWrap\fP is \fBTrue\fP\&.
.IP "\fBXmNresizeWidth\fP" 10
Indicates that Text attempts to resize its width to accommodate all
the text contained in the widget when the Boolean value is True\&.
This attribute is ignored if
\fBXmNwordWrap\fP is True\&.
.IP "" 10
When the \fBXmNlayoutDirection\fP resource is \fBXmTOP_TO_BOTTOM\fP, this attribute
is still effective even if \fBXmNwordWrap\fP is \fBTrue\fP\&.
Also, this attribute is ignored when the application uses a text widget whose parent is
a \fBScrolledWindow\fP and \fBXmNscrollHorizaontal\fP is \fBTrue\fP\&.
.IP "\fBXmNrows\fP" 10
Specifies the initial height of the text window measured in character
heights\&. This attribute is ignored if the text widget resource
\fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP\&.
The value must be greater than 0 (zero)\&.
The default value depends on the value of the \fBXmNheight\fP resource\&.
If no height is specified, the default is 1\&.
.IP "" 10
When the \fBXmNlayoutDirection\fP resource is \fBXmTOP_TO_BOTTOM\fP, this
attribute is still effective, even if the \fBXmText\fP widget resource
\fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP\&. If no height is specified,
the default is 20\&.
.IP "\fBXmNwordWrap\fP" 10
Indicates that lines are to be broken at word breaks (that is, the text
does not go off the right edge of the window) when the Boolean value is True\&.
Words are defined as a sequence
of characters separated
by whitespace\&. Whitespace is defined as
a space, tab, or newline\&. This attribute is ignored if the text
widget resource \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP\&.
Note that this resource is only valid when the widget is not a
scroll one, or, if the widget is a scroll widget, that the
\fBXmNscrollHorizontal\fP resource is False\&.
.IP "" 10
Indicates that lines are to be broken at word breaks (that is,
when the \fBXmNlayoutDirection\fP resource is \fBXmTOP_TO_BOTTOM\fP, the text does not
go off the bottom edge of the window) when the Boolean value is \fBTrue\fP\&.
.PP
The following resources are used only when text is created in a
ScrolledWindow\&. See the reference page for \fBXmCreateScrolledText\fP\&.
.TS
tab() box;
cw(1.3) sw(1.3) sw(1.3) sw(1.3) sw(1.3)
lw(1.3) lw(1.3) lw(1.3) lw(1.3) lw(1.3).
\fBXmText Scrolling Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
XmNscrollHorizontalXmCScrollBooleanTrueCG
XmNscrollLeftSideXmCScrollSideBooleanFalseCG
XmNscrollTopSideXmCScrollSideBooleanFalseCG
XmNscrollVerticalXmCScrollBooleanTrueCG
.TE
.PP
Note in connection with this table that if the \fBXmNlayoutDirection\fP resource
is \fBXmTOP_TO_BOTTOM\fP, the default is \fBTrue\fP\&.
.IP "\fBXmNscrollHorizontal\fP" 10
Adds a ScrollBar that allows the user to scroll horizontally through
text when the Boolean value is True\&.
This resource is forced to False when the Text widget is placed in
a ScrolledWindow with \fBXmNscrollingPolicy\fP set to
\fBXmAUTOMATIC\fP\&.
.IP "" 10
When the \fBXmNlayoutDirection\fP resource is \fBXmTOP_TO_BOTTOM\fP, this
attribute is ignored if the \fBXmText\fP widget resource \fBXmNeditMode\fP
is \fBXmSINGLE_LINE_EDIT\fP\&.
.IP "\fBXmNscrollLeftSide\fP" 10
Indicates that the vertical ScrollBar should be placed on the left side of
the scrolled text window when the Boolean value is True\&. This attribute
is ignored if \fBXmNscrollVertical\fP is False or the Text resource
\fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP\&.
.IP "" 10
When the \fBXmNlayoutDirection\fP resource is \fBXmTOP_TO_BOTTOM\fP, this
resource is still effective, even if the XmText widget resource
\fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP\&.
.IP "\fBXmNscrollTopSide\fP" 10
Indicates that the horizontal ScrollBar should be placed on the top side of the
scrolled text window when the Boolean value is True\&.
.IP "" 10
When the \fBXmNlayoutDirection\fP resource is \fBXmTOP_TO_BOTTOM\fP, this
attribute is ignored if \fBXmNscrollHorizontal\fP is \fBFalse\fP
or the \fBXmtext\fP resource
\fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP\&.
.IP "\fBXmNscrollVertical\fP" 10
Adds a ScrollBar that allows the user to scroll vertically through text when
the Boolean value is True\&.
This attribute is ignored if the Text resource \fBXmNeditMode\fP is
\fBXmSINGLE_LINE_EDIT\fP\&.
This resource is forced to False when the Text widget is placed in
a ScrolledWindow with \fBXmNscrollingPolicy\fP set to
\fBXmAUTOMATIC\fP\&.
.IP "" 10
When the \fBXmNlayoutDirection\fP resource is \fBXmTOP_TO_BOTTOM\fP, this
resource is still effective, even if the \fBXmText\fP
widget resource \fBXmNeditMode\fP
is \fBXmSINGLE_LINE_EDIT\fP\&.
.SS "Inherited Resources"
.PP
Text inherits behavior and resources from the
superclasses described in the following tables\&.
For a complete description of each resource, refer to the
reference page for that superclass\&.
.TS
tab() box;
cw(1.3) sw(1.3) sw(1.3) sw(1.3) sw(1.3)
lw(1.3) lw(1.3) lw(1.3) lw(1.3) lw(1.3).
\fBXmPrimitive Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
XmNbottomShadowColorXmCBottomShadowColorPixeldynamicCSG
XmNbottomShadowPixmapXmCBottomShadowPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
XmNconvertCallbackXmCCallbackXtCallbackListNULLC
XmNforegroundXmCForegroundPixeldynamicCSG
XmNhelpCallbackXmCCallbackXtCallbackListNULLC
XmNhighlightColorXmCHighlightColorPixeldynamicCSG
XmNhighlightOnEnterXmCHighlightOnEnterBooleanFalseCSG
XmNhighlightPixmapXmCHighlightPixmapPixmapdynamicCSG
XmNhighlightThicknessXmCHighlightThicknessDimension2CSG
XmNlayoutDirectionXmCLayoutDirectionXmDirectiondynamicCG
XmNnavigationTypeXmCNavigationTypeXmNavigationTypeXmTAB_GROUPCSG
XmNpopupHandlerCallbackXmCCallbackXtCallbackListNULLC
XmNshadowThicknessXmCShadowThicknessDimension2CSG
XmNtopShadowColorXmCTopShadowColorPixeldynamicCSG
XmNtopShadowPixmapXmCTopShadowPixmapPixmapdynamicCSG
XmNtraversalOnXmCTraversalOnBooleanTrueCSG
XmNunitTypeXmCUnitTypeunsigned chardynamicCSG
XmNuserDataXmCUserDataXtPointerNULLCSG
.TE
.TS
tab() box;
cw(1.3) sw(1.3) sw(1.3) sw(1.3) sw(1.3)
lw(1.3) lw(1.3) lw(1.3) lw(1.3) lw(1.3).
\fBCore Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
XmNacceleratorsXmCAcceleratorsXtAcceleratorsdynamicCSG
XmNancestorSensitiveXmCSensitiveBooleandynamicG
XmNbackgroundXmCBackgroundPixeldynamicCSG
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
XmNborderColorXmCBorderColorPixelXtDefaultForegroundCSG
XmNborderPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
XmNborderWidthXmCBorderWidthDimension0CSG
XmNcolormapXmCColormapColormapdynamicCG
XmNdepthXmCDepthintdynamicCG
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
XmNheightXmCHeightDimensiondynamicCSG
XmNinitialResourcesPersistentXmCInitialResourcesPersistentBooleanTrueC
XmNmappedWhenManagedXmCMappedWhenManagedBooleanTrueCSG
XmNscreenXmCScreenScreen *dynamicCG
XmNsensitiveXmCSensitiveBooleanTrueCSG
XmNtranslationsXmCTranslationsXtTranslationsdynamicCSG
XmNwidthXmCWidthDimensiondynamicCSG
XmNxXmCPositionPosition0CSG
XmNyXmCPositionPosition0CSG
.TE
.SS "Callback Information"
.PP
A pointer to the following structure is passed to each callback:
.PP
.nf
typedef struct
{
        int \fIreason\fP;
        XEvent \fI* event\fP;
} XmAnyCallbackStruct;
.fi
.IP "\fIreason\fP" 10
Indicates why the callback was invoked
.IP "\fIevent\fP" 10
Points to the \fBXEvent\fP that triggered the callback
.PP
The Text widget defines a new callback structure
for use with verification callbacks\&. Note that
not all fields are relevant for every
callback reason\&. The application must first
look at the \fIreason\fP field and use only the structure
members that are valid for the particular reason\&.
The values \fIstartPos\fP, \fIendPos\fP, and \fItext\fP in the
callback structure \fBXmTextVerifyCallbackStruct\fR may be modified
when the callback is received, and these changes will be reflected as
changes made to the source of the Text widget\&. (For example, all
keystrokes can be converted to spaces or NULL characters when a
password is entered into a Text widget\&.) The application
programmer should not overwrite the \fItext\fP field, but should
attach data to that pointer\&.
.PP
A pointer to the following structure is passed to callbacks for
\fBXmNlosingFocusCallback\fP, \fBXmNmodifyVerifyCallback\fP, and
\fBXmNmotionVerifyCallback\fP:
.PP
.nf
typedef struct
{
        int \fIreason\fP;
        XEvent \fI* event\fP;
        Boolean \fIdoit\fP;
        XmTextPosition \fIcurrInsert, newInsert\fP;
        XmTextPosition \fIstartPos, endPos\fP;
        XmTextBlock \fItext\fP;
} XmTextVerifyCallbackStruct, *XmTextVerifyPtr;
.fi
.IP "\fIreason\fP" 10
Indicates why the callback was invoked\&.
.IP "\fIevent\fP" 10
Points to the \fBXEvent\fP 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\&.
.IP "\fIdoit\fP" 10
Indicates whether the action that invoked the callback is performed\&.
Setting \fIdoit\fP to False negates the action\&.
Note that not all actions may be negated\&. For example,
\fBXmCR_LOSING_FOCUS\fP callbacks may be beyond the control of the
widget if they are produced by mouse clicks\&.
.IP "\fIcurrInsert\fP" 10
Indicates the current position of the insert cursor\&.
.IP "\fInewInsert\fP" 10
Indicates the position at which the user attempts to position the insert
cursor\&.
.IP "\fIstartPos\fP" 10
Indicates the starting position of the text to modify\&. If the callback is
not a modify verification callback, this value is the same as \fIcurrInsert\fP\&.
.IP "\fIendPos\fP" 10
Indicates the ending position of the text to modify\&. If no text is replaced or
deleted, the value is the same as \fIstartPos\fP\&. If the callback is not
a modify verification callback, this value is the same as \fIcurrInsert\fP\&.
.IP "\fItext\fP" 10
Points to a structure of type \fBXmTextBlockRec\fR\&. This structure holds
the textual information to be inserted\&.
.PP
.nf
typedef struct
{
        char *\fIptr\fP;
        int \fIlength\fP;
        XmTextFormat \fIformat\fP;
} XmTextBlockRec, *XmTextBlock;
.fi
.RS
.IP "\fIptr\fP" 10
Points to the text to be inserted\&.
.IP "\fIlength\fP" 10
Specifies the length of the text to be inserted\&.
.IP "\fIformat\fP" 10
Specifies the format of the text,
either \fBXmFMT_8_BIT\fP or \fBXmFMT_16_BIT\fP\&.
.RE
.PP
A pointer to the following structure is passed to callbacks
for \fBXmNmodifyVerifyCallbackWcs\fP\&.
.PP
.nf
typedef struct
{
        int \fIreason\fP;
        XEvent *\fIevent\fP;
        Boolean \fIdoit\fP;
        XmTextPosition \fIcurrInsert, newInsert\fP;
        XmTextPosition \fIstartPos, endPos\fP;
        XmTextBlockWcs \fItext\fP;
} XmTextVerifyCallbackStructWcs, *XmTextVerifyPtrWcs;
.fi
.IP "\fIreason\fP" 10
Indicates why the callback was invoked\&.
.IP "\fIevent\fP" 10
Points to the \fBXEvent\fP 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\&.
.IP "\fIdoit\fP" 10
Indicates whether the action that invoked the callback is performed\&.
Setting \fIdoit\fP to False negates the action\&.
Note that not all actions may be negated\&. For example,
\fBXmCR_LOSING_FOCUS\fP callbacks may be beyond the control of the
widget if they are produced by mouse clicks\&.
.IP "\fIcurrInsert\fP" 10
Indicates the current position of the insert cursor\&.
.IP "\fInewInsert\fP" 10
Indicates the position at which the user attempts to position the insert
cursor\&.
.IP "\fIstartPos\fP" 10
Indicates the starting position of the text to modify\&. If the callback is
not a modify verification callback, this value is the same as \fIcurrInsert\fP\&.
.IP "\fIendPos\fP" 10
Indicates the ending position of the text to modify\&. If no text is replaced or
deleted, the value is the same as \fIstartPos\fP\&. If the callback is not
a modify verification callback, this value is the same as \fIcurrInsert\fP\&.
.IP "\fItext\fP" 10
Points to the following
structure of type \fBXmTextBlockRecWcs\fR\&. This structure holds
the textual information to be inserted\&.
.PP
.nf
typedef struct
{
        wchar_t *\fIwcsptr\fP;
        int \fIlength\fP;
} XmTextBlockRecWcs, *XmTextBlockWcs;
.fi
.RS
.IP "\fIwcsptr\fP" 10
Points to the wide character text to be inserted\&.
.IP "\fIlength\fP" 10
Specifies the number of characters to be inserted\&.
.RE
.PP
The following table describes the reasons for which the individual
verification callback structure fields are valid\&. Note that the
\fIevent\fP field will never be valid for \fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.TS
tab() box;
l l.
\fBReason\fP\fBValid Fields\fP
XmCR_LOSING_FOCUST{
\fIreason, event, doit, currInsert, newInsert, startPos, endPos\fP
T}
XmCR_MODIFYING_TEXT_VALUET{
\fIreason, event, doit, currInsert, newInsert, startPos, endPos, text\fP
T}
XmCR_MOVING_INSERT_CURSOR\fIreason, doit, currInsert, newInsert\fP
.TE
.PP
A pointer to the following callback structure is passed to the
\fBXmNdestinationCallback\fP procedures:
.PP
.nf
typedef struct
{
        int \fIreason\fP;
        XEvent  *\fIevent\fP;
        Atom \fIselection\fP;
        XtEnum \fIoperation\fP;
        int \fIflags\fP;
        XtPointer \fItransfer_id\fP;
        XtPointer \fIdestination_data\fP;
        XtPointer \fIlocation_data\fP;
        Time \fItime\fP;
} XmDestinationCallbackStruct;
.fi
.IP "\fIreason\fP" 10
Indicates why the callback was invoked\&.
.IP "\fIevent\fP" 10
Points to the \fBXEvent\fP that triggered the callback\&.
It can be NULL\&.
.IP "\fIselection\fP" 10
Indicates the selection for which data transfer is being requested\&.
Possible values are \fBCLIPBOARD\fP, \fBPRIMARY\fP, \fBSECONDARY\fP, and
\fB_MOTIF_DROP\fP\&.
.IP "\fIoperation\fP" 10
Indicates the type of transfer operation requested\&.
.RS
.IP "   \(bu" 6
When the selection is \fBPRIMARY\fP or \fBSECONDARY\fP, possible
values are \fBXmMOVE\fP,
\fBXmCOPY\fP, and \fBXmLINK\fP\&.
.IP "   \(bu" 6
When the selection is \fBCLIPBOARD\fP, possible
values are \fBXmCOPY\fP and \fBXmLINK\fP\&.
.IP "   \(bu" 6
When the selection is \fB_MOTIF_DROP\fP, possible values are
\fBXmMOVE\fP, \fBXmCOPY\fP, \fBXmLINK\fP, and \fBXmOTHER\fP\&.
A value of \fBXmOTHER\fP means that the callback procedure must get
further information from the \fBXmDropProcCallbackStruct\fR structure in the
\fIdestination_data\fP member\&.
.RE
.IP "\fIflags\fP" 10
Indicates whether or not the destination widget is also the source of
the data to be transferred\&.
Following are the possible values:
.RS
.IP "\fBXmCONVERTING_NONE\fP" 10
The destination widget is not the source of the data to be transferred\&.
.IP "\fBXmCONVERTING_SAME\fP" 10
The destination widget is the source of the data to be transferred\&.
.RE
.IP "\fBtransfer_id\fP" 10
Serves as a unique ID to identify the transfer transaction\&.
.IP "\fIdestination_data\fP" 10
Contains information about the destination\&.
When the selection is \fB_MOTIF_DROP\fP, the callback procedures are
called by the drop site\&'s \fBXmNdropProc\fP, and \fIdestination_data\fP
is a pointer to the \fBXmDropProcCallbackStruct\fR structure passed to the
\fBXmNdropProc\fP procedure\&.
When the selection is \fBSECONDARY\fP,
\fIdestination_data\fP
is an Atom
representing a target recommmended by the selection owner for use in
converting the selection\&.
Otherwise, \fIdestination_data\fP is NULL\&.
.IP "\fBlocation_data\fP" 10
Contains information about the location where data is to be transferred\&.
The value is always NULL when the selection is \fBCLIPBOARD\fP\&.
If the value is NULL, the data is to be inserted at the widget\&'s cursor
position\&.
Otherwise, the value is a pointer to an \fBXPoint\fP structure
containing the x- and y- coordinates at the location where the data is to
be transferred\&. Once \fBXmTransferDone\fP procedures start to be called,
\fBlocation_data\fP will no longer be stable\&.
.IP "\fItime\fP" 10
Indicates the time when the transfer operation began\&.
.SS "Translations"
.PP
The \fBXmText\fP translations are described in the following list\&.
The actions represent the effective behavior of the associated events,
and they may differ in a right-to-left language environment\&.
.PP
The following key names are listed in the
X standard key event translation table syntax\&.
This format is the one used by Motif to
specify the widget actions corresponding to a given key\&.
A brief overview of the format is provided under
\fBVirtualBindings\fP(3)\&.
For a complete description of the format, please refer to the
X Toolkit Instrinsics Documentation\&.
.IP "\fB\(apc s \(apm \(apa\fP \fB<Btn1Down>\fP:" 10
extend-start()
.IP "\fBc \(aps \(apm \(apa\fP \fB<Btn1Down>\fP:" 10
move-destination()
.IP "\fB\(apc \(aps \(apm \(apa\fP \fB<Btn1Down>\fP:" 10
grab-focus()
.IP "\fB\(apc \(apm \(apa\fP \fB<Btn1Motion>\fP:" 10
extend-adjust()
.IP "\fB\(apc \(apm \(apa\fP \fB<Btn1Up>\fP:" 10
extend-end()
.IP "\fB<Btn2Down>\fP:" 10
process-bdrag()
.IP "\fBm \(apa\fP \fB<Btn2Motion>\fP:" 10
secondary-adjust()
.IP "\fB\(apm a\fP \fB<Btn2Motion>\fP:" 10
secondary-adjust()
.IP "\fBs c <Btn2Up>\fP:" 10
link-to()
.IP "\fB\(aps\fP \fB<Btn2Up>\fP:" 10
copy-to()
.IP "\fB\(apc\fP \fB<Btn2Up>\fP:" 10
move-to()
.IP "\fB:m\fP \fB<Key>\fP\fB<osfPrimaryPaste>\fP:" 10
cut-primary()
.IP "\fB:a\fP \fB<Key>\fP\fB<osfPrimaryPaste>\fP:" 10
cut-primary()
.IP "\fB:\fP\fB<Key>\fP\fB<osfPrimaryPaste>\fP:" 10
copy-primary()
.IP "\fB:m\fP \fB<Key>\fP\fB<osfCut>\fP:" 10
cut-primary()
.IP "\fB:a\fP \fB<Key>\fP\fB<osfCut>\fP:" 10
cut-primary()
.IP "\fB:\fP\fB<Key>\fP\fB<osfCut>\fP:" 10
cut-clipboard()
.IP "\fB:\fP\fB<Key>\fP\fB<osfPaste>\fP:" 10
paste-clipboard()
.IP "\fB:m\fP \fB<Key>\fP\fB<osfCopy>\fP:" 10
copy-primary()
.IP "\fB:a\fP \fB<Key>\fP\fB<osfCopy>\fP:" 10
copy-primary()
.IP "\fB:\fP\fB<Key>\fP\fB<osfCopy>\fP:" 10
copy-clipboard()
.IP "\fB:s c\fP \fB<Key>\fP\fB<osfBeginLine>\fP:" 10
beginning-of-file(\fBextend\fP)
.IP "\fB:c\fP \fB<Key>\fP\fB<osfBeginLine>\fP:" 10
beginning-of-file()
.IP "\fB:s\fP \fB<Key>\fP\fB<osfBeginLine>\fP:" 10
beginning-of-line(\fBextend\fP)
.IP "\fB:\fP\fB<Key>\fP\fB<osfBeginLine>\fP:" 10
beginning-of-line()
.IP "\fB:s c\fP \fB<Key>\fP\fB<osfEndLine>\fP:" 10
end-of-file(\fBextend\fP)
.IP "\fB:c\fP \fB<Key>\fP\fB<osfEndLine>\fP:" 10
end-of-file()
.IP "\fB:s\fP \fB<Key>\fP\fB<osfEndLine>\fP:" 10
end-of-line(\fBextend\fP)
.IP "\fB:\fP\fB<Key>\fP\fB<osfEndLine>\fP:" 10
end-of-line()
.IP "\fB:s\fP \fB<Key>\fP\fB<osfPageLeft>\fP:" 10
page-left(\fBextend\fP) (ignored in vertical
writing)
.IP "\fB:\fP\fB<Key>\fP\fB<osfPageLeft>\fP:" 10
page-left() (next-page() in vertical writing)
.IP "\fB:s c\fP \fB<Key>\fP\fB<osfPageUp>\fP:" 10
page-left(\fBextend\fP)
.IP "\fB:c\fP \fB<Key>\fP\fB<osfPageUp>\fP:" 10
page-left()
.IP "\fB:s\fP \fB<Key>\fP\fB<osfPageUp>\fP:" 10
previous-page(\fBextend\fP) (ignored
in vertical writing)
.IP "\fB:\fP\fB<Key>\fP\fB<osfPageUp>\fP:" 10
previous-page() (page-up() in vertical writing)
.IP "\fB:s\fP \fB<Key>\fP\fB<osfPageRight>\fP:" 10
page-right(\fBextend\fP) (ignored
in vertical writing)
.IP "\fB:\fP\fB<Key>\fP\fB<osfPageRight>\fP:" 10
page-right() (previous-page() in vertical
writing)
.IP "\fBs c\fP \fB<Key>\fP\fB<osfPageDown>\fP:" 10
page-right(\fBextend\fP) (ignored
in vertical writing)
.IP "\fB:c\fP \fB<Key>\fP\fB<osfPageDown>\fP:" 10
page-right()
.IP "\fB:s\fP \fB<Key>\fP\fB<osfPageDown>\fP:" 10
next-page(\fBextend\fP) (ignored in vertical
writing)
.IP "\fB:\fP\fB<Key>\fP\fB<osfPageDown>\fP:" 10
next-page() (page-down() in vertical writing)
.IP "\fB:\fP\fB<Key>\fP\fB<osfClear>\fP:" 10
clear-selection()
.IP "\fB:\fP\fB<Key>\fP\fB<osfBackSpace>\fP:" 10
delete-previous-character()
.IP "\fB:s m\fP \fB<Key>\fP\fB<osfDelete>\fP:" 10
cut-primary()
.IP "\fB:s a\fP \fB<Key>\fP\fB<osfDelete>\fP:" 10
cut-primary()
.IP "\fB:s\fP \fB<Key>\fP\fB<osfDelete>\fP:" 10
cut-clipboard()
.IP "\fB:c\fP \fB<Key>\fP\fB<osfDelete>\fP:" 10
delete-to-end-of-line()
.IP "\fB:\fP\fB<Key>\fP\fB<osfDelete>\fP:" 10
delete-next-character()
.IP "\fB:c m\fP \fB<Key>\fP\fB<osfInsert>\fP:" 10
copy-primary()
.IP "\fB:c a\fP \fB<Key>\fP\fB<osfInsert>\fP:" 10
copy-primary()
.IP "\fB:s\fP \fB<Key>\fP\fB<osfInsert>\fP:" 10
paste-clipboard()
.IP "\fB:c\fP \fB<Key>\fP\fB<osfInsert>\fP:" 10
copy-clipboard()
.IP "\fB:s\fP \fB<Key>\fP\fB<osfSelect>\fP:" 10
key-select()
.IP "\fB:\fP\fB<Key>\fP\fB<osfSelect>\fP:" 10
set-anchor()
.IP "\fB:\fP\fB<Key>\fP\fB<osfSelectAll>\fP:" 10
select-all()
.IP "\fB:\fP\fB<Key>\fP\fB<osfDeselectAll>\fP:" 10
deselect-all()
.IP "\fB:\fP\fB<Key>\fP\fB<osfActivate>\fP:" 10
activate()
.IP "\fB:\fP\fB<Key>\fP\fB<osfAddMode>\fP:" 10
toggle-add-mode()
.IP "\fB:\fP\fB<Key>\fP\fB<osfHelp>\fP:" 10
Help()
.IP "\fB:\fP\fB<Key>\fP\fB<osfCancel>\fP:" 10
process-cancel()
.IP "\fB:s c\fP \fB<Key>\fP\fB<osfLeft>\fP:" 10
backward-word(\fBextend\fP) (
forward-paragraph(\fBextend\fP) in
vertical writing)
.IP "\fB:c\fP \fB<Key>\fP\fB<osfLeft>\fP:" 10
backward-word() (forward-paragraph() in vertical writing)
.IP "\fB:s\fP \fB<Key>\fP\fB<osfLeft>\fP:" 10
key-select(\fBleft\fP)
(process-shift-left() in vertical writing)
.IP "\fB:\fP\fB<Key>\fP\fB<osfLeft>\fP:" 10
backward-character() (process-left()
in vertical writing)
.IP "\fB:s c\fP \fB<Key>\fP\fB<osfRight>\fP:" 10
forward-word(\fBextend\fP)
(backward-paragraph(\fBextend\fP)
in vertical writing)
.IP "\fB:c\fP \fB<Key>\fP\fB<osfRight>\fP:" 10
forward-word() (backward-paragraph()
in vertical writing)
.IP "\fB:s\fP \fB<Key>\fP\fB<osfRight>\fP:" 10
key-select(\fBright\fP)
(process-shift-right in vertical writing)
.IP "\fB:\fP\fB<Key>\fP\fB<osfRight>\fP:" 10
forward-character() (process-right()
in vertical writing)
.IP "\fB:s c\fP \fB<Key>\fP\fB<osfUp>\fP:" 10
backward-paragraph(\fBextend\fP)
(backward-word(\fBextend\fP)
in vertical writing)
.IP "\fB:c\fP \fB<Key>\fP\fB<osfUp>\fP:" 10
backward-paragraph() (backward-word()
in vertical writing)
.IP "\fB:s\fP \fB<Key>\fP\fB<osfUp>\fP:" 10
process-shift-up()
(key-select(\fBup\fP)
in vertical writing)
.IP "\fB:\fP\fB<Key>\fP\fB<osfUp>\fP:" 10
process-up() (backward-character()
in vertical writing)
.IP "\fB:s c\fP \fB<Key>\fP\fB<osfDown>\fP:" 10
forward-paragraph(\fBextend\fP)
(forward-word(\fBextend\fP)
in vertical writing)
.IP "\fB:c\fP \fB<Key>\fP\fB<osfDown>\fP:" 10
forward-paragraph() (forward-word()
in vertical writing)
.IP "\fB:s\fP \fB<Key>\fP\fB<osfDown>\fP:" 10
process-shift-down()
(key-select(\fBdown\fP)
in vertical writing)
.IP "\fB:\fP\fB<Key>\fP\fB<osfDown>\fP:" 10
process-down() (forward-character()
in vertical writing)
.IP "\fBc \(apm \(apa\fP \fB<Key>\fP\fBslash\fP:" 10
select-all()
.IP "\fBc \(apm \(apa\fP \fB<Key>\fP\fBbackslash\fP:" 10
deselect-all()
.IP "\fBs c \(apm \(apa\fP \fB<Key>\fP\fBTab\fP:" 10
prev-tab-group()
.IP "\fB\(aps c \(apm \(apa\fP \fB<Key>\fP\fBTab\fP:" 10
next-tab-group()
.IP "\fBs \(apc \(apm \(apa\fP \fB<Key>\fP\fBTab\fP:" 10
process-tab(\fBPrev\fP)
.IP "\fB\(aps \(apc \(apm \(apa\fP \fB<Key>\fP\fBTab\fP:" 10
process-tab(\fBNext\fP)
.IP "\fB\(aps c \(apm \(apa\fP \fB<Key>\fP\fBReturn\fP:" 10
activate()
.IP "\fB\(aps \(apc \(apm \(apa\fP \fB<Key>\fP\fBReturn\fP:" 10
process-return()
.IP "\fB\(aps c \(apm \(apa\fP \fB<Key>\fP\fBspace\fP:" 10
set-anchor()
.IP "\fBs c \(apm \(apa\fP \fB<Key>\fP\fBspace\fP:" 10
key-select()
.IP "\fBs \(apc \(apm \(apa\fP \fB<Key>\fP\fBspace\fP:" 10
self-insert()
.IP "\fB<Key>\fP:" 10
self-insert()
.PP
The Text button event translations are modified when Display\&'s
\fBXmNenableBtn1Transfer\fP resource does not have a value of
\fBXmOFF\fP (in other words, it is either \fBXmBUTTON2_TRANSFER\fP or
\fBXmBUTTON2_ADJUST\fP)\&. This
option allows the
actions for selection and transfer to be integrated on \fB<Btn1>\fP, and
the actions for extending the selection can be bound to
\fB<Btn2>\fP\&. The actions for \fB<Btn1>\fP that are defined above
still apply when the \fB<Btn1>\fP event occurs over text that is not
selected\&. The following actions apply when the \fB<Btn1>\fP event
occurs over text that is selected:
.IP "\fB<Btn1Down>\fP:" 10
process-bdrag()\&.
.IP "\fB<Shift>\fP\fB<Btn1Down>\fP:" 10
process-bdrag()\&.
.IP "\fB<Ctrl>\fP\fB<Btn1Down>\fP:" 10
process-bdrag()\&.
.IP "\fB<Btn1Down>\fP\fB<Shift>\fP\fB<Btn1Up>\fP:" 10
grab-focus(), \fBextend-end\fP\&.
.IP "\fB<Shift>\fP\fB<Btn1Down>\fP\fB<Shift>\fP\fB<Btn1Up>\fP:" 10
extend-start(), extend-end()\&.
.IP "\fB<Ctrl>\fP\fB<Btn1Down>\fP\fB<Shift>\fP\fB<Btn1Up>\fP:" 10
move-destination()\&.
.PP
When Display\&'s \fBXmNenableBtn1Transfer\fP resource has a value of
\fBXmBUTTON2_ADJUST\fP, the following actions apply:
.IP "\fB<Btn2Down>\fP:" 10
extend-start()\&.
.IP "\fB<Btn2Motion>\fP:" 10
extend-adjust()\&.
.IP "\fB<Btn2Up>\fP:" 10
extend-end()\&.
.SS "Action Routines"
.PP
The \fBXmText\fP action routines are
.IP "activate():" 10
Calls the callbacks for \fBXmNactivateCallback\fP\&.
Passes the event to the parent\&.
.IP "backward-character(\fBextend\fP):" 10
Moves the insertion cursor one character to the left\&.
This action may have different behavior in a right-to-left language
environment\&.
.IP "" 10
If called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The backward-character() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
backward-character() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "" 10
In vertical writing, if \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP and
\fBXmNnavigationType\fP
is \fBXmNONE\fP, traverses to the widget to the left in the tab
group\&. If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP, moves the insertion cursor
to the next line in the same column\&.
.IP "backward-paragraph(\fBextend\fP):" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with no argument,
moves the insertion cursor to the first non-whitespace character following
the first previous blank line or beginning of the text\&.
If the insertion cursor is already at the beginning of a paragraph,
moves the insertion cursor to the beginning of the previous paragraph\&.
.IP "" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The backward-paragraph() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
backward-paragraph() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "backward-word(\fBextend\fP):" 10
If this action 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\&.
This action may have different behavior in a locale other than the C locale\&.
.IP "" 10
If called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The backward-word() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
backward-word() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "beep():" 10
Causes the terminal to beep\&.
The beep() action produces no callbacks\&.
.IP "beginning-of-file(\fBextend\fP):" 10
If this action is called with no argument,
moves the insertion cursor to the beginning of the text\&.
.IP "" 10
If called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The beginning-of-file() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
beginning-of-file() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "beginning-of-line(\fBextend\fP):" 10
If this action is called with no argument,
moves the insertion cursor to the beginning of the line\&.
.IP "" 10
If called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The beginning-of-line() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
beginning-of-line() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "clear-selection():" 10
Clears the current selection by replacing each character except
\fB<Return>\fP with a \fB<space>\fP character\&.
.IP "" 10
The clear-selection() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP and the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP\&.
.IP "copy-clipboard():" 10
If this widget owns the primary selection, this action copies the
selection to the clipboard\&.
This action calls the \fBXmNconvertCallback\fP procedures, possibly
multiple times, for the \fBCLIPBOARD\fP selection\&.
.IP "copy-primary():" 10
Copies the primary selection to just before the insertion cursor\&.
This action calls the \fBXmNdestinationCallback\fP procedures for the
\fBPRIMARY\fP selection and the \fBXmCOPY\fP operation\&.
It calls the selection owner\&'s \fBXmNconvertCallback\fP procedures,
possibly multiple times, for the \fBPRIMARY\fP selection\&.
.IP "" 10
In addition, the copy-primary() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, to the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "copy-to():" 10
If a secondary selection exists, this action copies the secondary
selection to the insertion position of the destination component\&.
If the primary selection is in the destination widget, it will
be deselected\&. Otherwise, there is no effect on the primary selection\&.
.IP "" 10
This action calls the destination\&'s \fBXmNdestinationCallback\fP
procedures for the \fBSECONDARY\fP selection and the
\fBXmCOPY\fP operation\&.
The destination\&'s \fBXmNdestinationCallback\fP procedures or the
destination component itself invokes the selection owner\&'s
\fBXmNconvertCallback\fP procedures, possibly multiple times, for the
\fBSECONDARY\fP selection\&.
.IP "" 10
If no secondary selection exists, this action copies the primary
selection to the pointer position\&.
This action calls the \fBXmNdestinationCallback\fP procedures for the
\fBPRIMARY\fP selection and the \fBXmCOPY\fP operation\&.
It calls the selection owner\&'s \fBXmNconvertCallback\fP procedures,
possibly multiple times, for the \fBPRIMARY\fP selection\&.
.IP "" 10
In addition, the copy-to() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, to the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If there is no secondary selection, the
copy-to() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "cut-clipboard():" 10
If this widget owns the primary selection, this action cuts the
selection to the clipboard\&.
This action calls the \fBXmNconvertCallback\fP procedures, possibly
multiple times, for the \fBCLIPBOARD\fP selection\&.
If the transfer is successful, this action then calls the
\fBXmNconvertCallback\fP procedures for the \fBCLIPBOARD\fP selection
and the \fBDELETE\fP target\&.
.IP "" 10
In addition, the cut-clipboard() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, and the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP\&.
.IP "cut-primary():" 10
Cuts the primary selection and pastes it just before the insertion cursor\&.
This action calls the \fBXmNdestinationCallback\fP procedures for the
\fBPRIMARY\fP selection and the \fBXmMOVE\fP operation\&.
It calls the selection owner\&'s \fBXmNconvertCallback\fP procedures,
possibly multiple times, for the \fBPRIMARY\fP selection\&.
If the transfer is successful, this action then calls the selection
owner\&'s \fBXmNconvertCallback\fP procedures for the \fBPRIMARY\fP
selection and the \fBDELETE\fP target\&.
The cut-primary() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "" 10
In addition, the cut-primary() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP, the \fBXmNmodifyVerifyCallback\fP
procedures with reason value \fBXmCR_MODIFYING_TEXT_VALUE\fP, and the
\fBXmNvalueChangedCallback\fP procedures with reason value
\fBXmCR_VALUE_CHANGED\fP\&.
.IP "delete-next-character():" 10
In normal mode, if there is a nonnull selection, deletes the selection;
otherwise,
deletes the character following the insertion cursor\&.
In add mode, if there is a nonnull selection, the cursor is not disjoint
from the selection, and \fBXmNpendingDelete\fP is set to True,
deletes the selection; otherwise,
deletes the character following the insertion cursor\&.
This may impact the selection\&.
.IP "" 10
The delete-next-character() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, and the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP\&.
.IP "delete-next-word():" 10
In normal mode, if there is a nonnull selection, 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 nonnull selection, the cursor is not disjoint
from the selection, and \fBXmNpendingDelete\fP 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\&.
.IP "" 10
The delete-next-word() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, and the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP\&.
.IP "delete-previous-character():" 10
In normal mode, if there is a nonnull selection, deletes the selection; otherwise,
deletes the character of text immediately preceding the insertion cursor\&.
In add mode, if there is a nonnull selection, the cursor is not disjoint
from the selection, and \fBXmNpendingDelete\fP is set to True,
deletes the selection; otherwise,
deletes the character of text immediately preceding the insertion cursor\&.
This may impact the selection\&.
.IP "" 10
The delete-previous-character() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "delete-previous-word():" 10
In normal mode, if there is a nonnull selection, deletes the
selection; otherwise, deletes the characters preceding the insertion
cursor to the next space, tab or beginning-of-line character\&. In add
mode, if there is a nonnull selection, the cursor is not disjoint from
the selection, and \fBXmNpendingDelete\fP 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 locale other than the C locale\&.
.IP "" 10
The delete-previous-word() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "delete-selection():" 10
Deletes the current selection\&.
.IP "" 10
The delete-selection() action
produces calls to the \fBXmNmodifyVerifyCallback\fP procedures with
reason value \fBXmCR_MODIFYING_TEXT_VALUE\fP, the
\fBXmNvalueChangedCallback\fP procedures with reason value
\fBXmCR_VALUE_CHANGED\fP, and the \fBXmNmotionVerifyCallback\fP
procedures with reason value \fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "delete-to-end-of-line():" 10
In normal mode, if there is a nonnull selection, deletes the selection; otherwise,
deletes the characters following the insertion cursor to the next end of
line character\&.
In add mode, if there is a nonnull selection, the cursor is not disjoint
from the selection, and \fBXmNpendingDelete\fP is set to True,
deletes the selection; otherwise,
deletes the characters following the insertion cursor to the next end
of line character\&.
This may impact the selection\&.
.IP "" 10
The \fBdelete-to-end-of-line()\fP action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, and the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP\&.
.IP "delete-to-start-of-line():" 10
In normal mode, if there is a nonnull selection, deletes the selection; otherwise,
deletes the characters preceding the insertion cursor to the previous
beginning-of-line character\&.
In add mode, if there is a nonnull selection, the cursor is not disjoint
from the selection, and \fBXmNpendingDelete\fP 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\&.
.IP "" 10
The delete-to-start-of-line() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "deselect-all():" 10
Deselects the current selection\&.
The deselect-all() action
produces no callbacks\&.
.IP "end-of-file(\fBextend\fP):" 10
If this action is called with no argument,
moves the insertion cursor to the end of the text\&.
.IP "" 10
If called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The end-of-file() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
end-of-file() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "end-of-line(\fBextend\fP):" 10
If this action is called with no argument,
moves the insertion cursor to the end of the line\&.
If called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The end-of-line() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
end-of-line() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "extend-adjust():" 10
Selects text from the anchor to the pointer position and deselects text
outside that range\&.
Moving the pointer over several lines selects text from the anchor to
the end of each line the pointer moves over and up to the pointer
position on the current line\&.
.IP "" 10
The extend-adjust() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
The extend-adjust() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "extend-end():" 10
Moves the insertion cursor to the position of the pointer\&.
The extend-end() action is used to commit the selection\&. After
this action has been done, process-cancel() will no longer
cancel the selection\&.
.IP "" 10
The extend-end() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
The extend-end() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "extend-start():" 10
Adjusts the anchor using the balance-beam method\&.
Selects text from the anchor to the pointer position and deselects text
outside that range\&.
The extend-start() action may produce no callbacks,
however, the extend-start() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "forward-character(\fBextend\fP):" 10
Moves the insertion cursor one character to the right\&.
This action may have different behavior in a right-to-left language
environment\&.
.IP "" 10
If called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The forward-character() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
forward-character() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "" 10
In vertical writing, if \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP and
\fBXmNnavigationType\fP is \fBXmNONE\fP, traverses to the widget to
the right in the tab group\&. If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP,
moves the insertion cursor to the previous line in the same column\&.
.IP "forward-paragraph(\fBextend\fP):" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP,
and this action is called with no argument,
moves the insertion cursor to the first non-whitespace character
following the next blank line\&.
If the insertion cursor is already at the beginning of a paragraph,
moves the insertion cursor to the beginning of the next paragraph\&.
.IP "" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The forward-paragraph() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
forward-paragraph() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "forward-word(\fBextend\fP):" 10
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 insertion cursor to the end of the next word\&.
This action may have different behavior in a locale other than the C locale\&.
.IP "" 10
If called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The forward-word() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
forward-word() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "grab-focus():" 10
This key binding performs the action defined in the
\fBXmNselectionArray\fP, depending on the number of multiple mouse
clicks\&.
The default selection 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 different behavior in a locale other than the C locale\&.
.IP "" 10
The grab-focus() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "Help():" 10
Calls the callbacks for \fBXmNhelpCallback\fP 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\&.
.IP "insert-string(\fIstring\fP\fB)\fP:" 10
If \fBXmNpendingDelete\fP is True and the cursor is not disjoint from the
current selection, deletes the entire selection\&.
Inserts \fIstring\fP before the insertion cursor\&.
.IP "" 10
The insert-string() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
Note that, in the case of an empty string, no callbacks will be
called, since no modification will have been done\&. However, if the
insertion position is inside the current selection,
\fBinsert-string\fP with an empty string will cause the selection to
be deselected, and the \fBXmNmotionVerifyCallback\fP procedures to be
called with reason value \fBXmCR_MOVING_INSERT_CURSOR\fP,
\fBXmCR_MODIFYING_TEXT_VALUE\fP, and \fBXmCR_VALUE_CHANGED\fP\&.
.IP "key-select(\fBright|left\fP):" 10
If called with an argument of \fIright\fP, moves the insertion cursor
one character to the right and extends the current selection\&.
If called with an argument of \fIleft\fP, moves the insertion cursor
one character to the left and extends the current selection\&.
If called with no argument, extends the current selection\&.
.IP "" 10
Note that after a \fBkey-select\fP action, the selection will still
begin at the original anchor, and will extend to the position
indicated in the action call\&. If this new position is on the opposite
side of the selection anchor from the previous selection boundary, the
original selection will be deselected\&.
.IP "" 10
The key-select() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
The key-select() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "" 10
In vertical writing, if called with the argument \fBleft\fP, and if
\fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP, moves
the insertion cursor to the next line in the same column\&.
In vertical writing, if called with the argument \fBright\fP, and if
\fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP, moves
the insertion cursor to the previous line in the same column\&.)
.IP "kill-next-character():" 10
In normal mode, if there is a nonnull selection,
kills
the selection; otherwise,
kills the character following the insertion cursor and stores the
character in the cut buffer\&.
In add mode, if there is a nonnull selection, the cursor is not disjoint
from the selection, and \fBXmNpendingDelete\fP is set to True,
deletes the selection; otherwise,
kills the character following the insertion cursor and stores the character
in the cut buffer\&.
This may impact the selection\&.
.IP "" 10
The killed text is stored in \fBCUT_BUFFER0\fP\&.
.IP "" 10
The kill-next-character() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "kill-next-word():" 10
In normal mode, if there is a nonnull selection, deletes the
selection; otherwise, kills the characters following the insertion
cursor to the next space, tab or end-of-line character, and stores the
characters in the cut buffer\&. In add mode, if there is a nonnull
selection, the cursor is not disjoint from the selection, and
\fBXmNpendingDelete\fP is set to True, deletes the selection;
otherwise, kills the characters following the insertion cursor to the
next space, tab or end-of-line character, and stores the characters in
the cut buffer\&. This may impact the selection\&. This action may have
different behavior in a locale other than the C locale\&.
.IP "" 10
The killed text is stored in \fBCUT_BUFFER0\fP\&.
.IP "" 10
The kill-next-word() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "kill-previous-character():" 10
In normal mode, if there is a nonnull selection, deletes the selection; otherwise,
kills the character immediately preceding the insertion cursor and stores the
character in the cut buffer\&.
In add mode, if there is a nonnull selection, the cursor is not disjoint
from the selection, and \fBXmNpendingDelete\fP is set to True,
deletes the selection; otherwise,
kills the character immediately preceding the insertion cursor and stores
the character in the cut buffer\&.
This may impact the selection\&.
.IP "" 10
The killed text is stored in \fBCUT_BUFFER0\fP\&.
.IP "" 10
The kill-previous-character() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "kill-previous-word():" 10
In normal mode, if there is a nonnull selection, deletes the
selection; otherwise, kills the characters preceding the insertion
cursor up to the next space, tab or beginning-of-line character, and
stores the characters in the cut buffer\&. In add mode, if there is a
nonnull selection, the cursor is not disjoint from the selection, and
\fBXmNpendingDelete\fP is set to True, deletes the selection;
otherwise, kills the characters preceding the insertion cursor up to
the next space, tab or beginning-of-line character, and stores the
characters in the cut buffer\&. This may impact the selection\&. This
action may have different behavior in a locale other than the C
locale\&.
.IP "" 10
The killed text is stored in \fBCUT_BUFFER0\fP\&.
.IP "" 10
The kill-previous-word() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "kill-selection():" 10
Kills the currently selected text and stores the text in the cut
buffer\&.
.IP "" 10
The killed text is stored in \fBCUT_BUFFER0\fP\&.
.IP "" 10
The kill-selection() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "kill-to-end-of-line():" 10
In normal mode, if there is a nonnull selection, deletes the selection;
otherwise,
kills the characters following the insertion cursor to the next end-of-line
character and stores the characters in the cut buffer\&.
In add mode, if there is a nonnull selection, the cursor is not disjoint
from the selection, and \fBXmNpendingDelete\fP is set to True,
deletes the selection; otherwise,
kills the characters following the insertion cursor to the next end of
line character and stores the characters in the cut buffer\&.
This may impact the selection\&.
.IP "" 10
The killed text is stored in \fBCUT_BUFFER0\fP\&.
.IP "" 10
The kill-to-end-of-line() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, and the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP\&.
In the case where there is a non-null selection to be deleted, this
action may also produce calls to the \fBXmNmotionVerifyCallback\fP
procedures with reason value \fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "kill-to-start-of-line():" 10
In normal mode, if there is a nonnull selection, deletes the selection; otherwise,
kills the characters preceding the insertion cursor to the next
beginning-of-line character and stores the characters in the cut buffer\&.
In add mode, if there is a nonnull selection, the cursor is not disjoint
from the selection, and \fBXmNpendingDelete\fP is set to True,
deletes the selection; otherwise,
kills the characters preceding the insertion cursor to the next
beginning-of-line character and stores the characters in the cut buffer\&.
This may impact the selection\&.
.IP "" 10
The killed text is stored in \fBCUT_BUFFER0\fP\&.
.IP "" 10
The kill-to-start-of-line() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "link-primary():" 10
Places a link to the primary selection just before the insertion cursor\&.
This action calls the \fBXmNdestinationCallback\fP procedures for the
\fBPRIMARY\fP selection and the \fBXmLINK\fP operation\&.
The Text widget itself performs no transfers; the
\fBXmNdestinationCallback\fP procedures are responsible for inserting
the link to the primary selection and for taking any related actions\&.
.IP "link-to():" 10
If a secondary selection exists, this action places a link to the
secondary selection at the insertion position of the destination
component\&.
This action calls the destination\&'s \fBXmNdestinationCallback\fP
procedures for the \fBSECONDARY\fP selection and the
\fBXmLINK\fP operation\&.
.IP "" 10
If no secondary selection exists, this action places a link to the
primary selection at the pointer position\&.
This action calls the \fBXmNdestinationCallback\fP procedures for the
\fBPRIMARY\fP selection and the \fBXmLINK\fP operation\&.
.IP "" 10
The Text widget itself performs no transfers; the
\fBXmNdestinationCallback\fP procedures are responsible for inserting
the link to the primary or secondary selection and for taking any
related actions\&.
.IP "move-destination():" 10
Moves the insertion cursor to the pointer position without changing any
existing current selection\&.
If there is
a
current selection, sets the widget as the destination widget\&.
This also moves the widget focus to match the insertion cursor\&.
.IP "" 10
The move-destination() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "move-to():" 10
If a secondary selection exists, this action moves the secondary
selection to the insertion position of the destination component\&.
If the secondary selection is in the destination widget, and the
secondary selection and the primary selection overlap, the result
is undefined\&.
This action calls the destination\&'s \fBXmNdestinationCallback\fP
procedures for the \fBSECONDARY\fP selection and the
\fBXmMOVE\fP operation\&.
The destination\&'s \fBXmNdestinationCallback\fP procedures or the
destination component itself invokes the selection owner\&'s
\fBXmNconvertCallback\fP procedures, possibly multiple times, for the
\fBSECONDARY\fP selection\&.
If the transfer is successful, this action then calls the selection
owner\&'s \fBXmNconvertCallback\fP procedures for the \fBSECONDARY\fP
selection and the \fBDELETE\fP target\&.
.IP "" 10
If no secondary selection exists, this action moves the primary
selection to the pointer position\&.
This action calls the \fBXmNdestinationCallback\fP procedures for the
\fBPRIMARY\fP selection and the \fBXmMOVE\fP operation\&.
It calls the selection owner\&'s \fBXmNconvertCallback\fP procedures,
possibly multiple times, for the \fBPRIMARY\fP selection\&.
If the transfer is successful, this action then calls the selection
owner\&'s \fBXmNconvertCallback\fP procedures for the \fBPRIMARY\fP
selection and the \fBDELETE\fP target\&.
.IP "" 10
The move-to() action produces calls to the \fBXmNmodifyVerifyCallback\fP
procedures with reason value \fBXmCR_MODIFYING_TEXT_VALUE\fP, the
\fBXmNvalueChangedCallback\fP procedures with reason value
\fBXmCR_VALUE_CHANGED\fP, and the \fBXmNmotionVerifyCallback\fP
procedures with reason value \fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If there is no secondary selection, the
move-to() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "newline():" 10
If \fBXmNpendingDelete\fP is True and the cursor is not disjoint from the
current selection, deletes the entire selection\&.
Inserts a newline before the insertion cursor\&.
.IP "" 10
The newline() action produces calls to the \fBXmNmodifyVerifyCallback\fP
procedures with reason value \fBXmCR_MODIFYING_TEXT_VALUE\fP, the
\fBXmNvalueChangedCallback\fP procedures with reason value
\fBXmCR_VALUE_CHANGED\fP, and the \fBXmNmotionVerifyCallback\fP
procedures with reason value \fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "newline-and-backup():" 10
If \fBXmNpendingDelete\fP is True and the cursor is not disjoint from the
current selection, deletes the entire selection\&.
Inserts a newline just before the insertion cursor and repositions the insertion cursor to the end of the
line before the newline\&.
.IP "" 10
The newline-and-backup() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, and the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP\&.
.IP "newline-and-indent():" 10
If \fBXmNpendingDelete\fP is True and the cursor is not disjoint from the
current selection, deletes the entire selection\&.
Inserts a newline and then the same number of whitespace characters as
at the beginning of the previous line\&.
.IP "" 10
The newline-and-indent() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "next-line():" 10
Moves the insertion cursor to the next line\&.
.IP "" 10
The next-line() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "next-page(\fBextend\fP):" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with no argument,
moves the insertion cursor forward one page\&.
.IP "" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with an argument of \fIextend\fP,
it moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The next-page() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
next-page() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "" 10
In vertical writing, scrolls the viewing window down one page
of text\&.
.IP "next-tab-group():" 10
Traverses to the next tab group\&.
.IP "" 10
The next-tab-group() action produces no callbacks, unless it
results in the widget losing focus, in which case, the
\fBXmNlosingFocusCallback\fP procedures are called with reason value
\fBXmCR_LOSING_FOCUS\fP\&.
.IP "page-left(\fBextend\fP):" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with no argument,
moves the insertion cursor back one page\&.
.IP "" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with an argument of \fIextend\fP,
it moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The page-left() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
page-left() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "page-right(\fBextend\fP):" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with no argument,
moves the insertion cursor forward one page\&.
.IP "" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with an argument of \fIextend\fP,
it moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The page-right() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
page-right() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "paste-clipboard():" 10
Pastes the contents of the clipboard before the insertion cursor\&.
This action calls the \fBXmNdestinationCallback\fP procedures for the
\fBCLIPBOARD\fP selection and the \fBXmCOPY\fP operation\&.
.IP "" 10
The paste-clipboard() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "prev-tab-group():" 10
Traverses to the previous tab group\&.
.IP "" 10
The prev-tab-group() action produces no callbacks, unless it
results in the widget losing focus, in which case, the
\fBXmNlosingFocusCallback\fP procedures are called with reason value
\fBXmCR_LOSING_FOCUS\fP\&.
.IP "previous-line():" 10
Moves the insertion cursor to the previous line\&.
.IP "" 10
The previous-line() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "previous-page(\fBextend\fP):" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with no argument,
moves the insertion cursor back one page\&.
.IP "" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with an argument of \fIextend\fP,
it moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The previous-page() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
If called with the \fIextend\fP argument, the
previous-page() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "" 10
In vertical writing, if called without an argument, scrolls the viewing window up one page
of text\&.
.IP "process-bdrag()" 10
If the pointer is within the selection, this action starts a drag
operation for the selection\&.
This action sets the \fBXmNconvertProc\fP of the DragContext to a
function that calls the \fBXmNconvertCallback\fP procedures, possibly
multiple times, for the \fB_MOTIF_DROP\fP selection\&.
.IP "" 10
If no selection exists or the pointer is outside the selection, this
action prepares to start a secondary selection at the pointer position\&.
.PP
.RS
\fBNote:  
.IP "" 10
Note that when dragging a secondary selection to a different widget,
focus will shift momentarily to the second widget, and then back to
the original widget\&. This will generate callbacks to the
\fBXmNlosingFocusCallback\fP procedures as focus is lost (by each
widget) as well as callbacks to the \fBXmNfocusCallback\fP procedures
as focus is regained\&.
.RE
.IP "process-cancel():" 10
Cancels the current extend-adjust(), secondary-adjust()
or process-bdrag()
operation and leaves the selection state as it was before the operation;
otherwise, and if the parent is a manager, passes the event to the
parent\&.
.IP "process-down(\fBextend\fP):" 10
If \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP, and
\fBXmNnavigationType\fP is \fBXmNONE\fP,
traverses to the widget below the current one in the tab group\&.
.IP "" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
In this case, the action will produce the \fBXmNlosingFocusCallback\fP
callbacks with reason value \fBXmCR_LOSING_FOCUS\fP\&.
.IP "" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP,
moves the insertion cursor down one line\&.
.IP "" 10
The process-down() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "" 10
In vertical writing, moves the insertion cursor
one character down\&.
.IP "process-home():" 10
Moves the insertion cursor to the beginning of the line\&.
.IP "" 10
The process-home() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "process-return():" 10
If \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP,
calls the callbacks for \fBXmNactivateCallback\fP,
and if the parent is a manager, passes the event to the parent\&.
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP,
inserts a newline\&.
.IP "" 10
The process-return() action during single-line edit produces calls to the
\fBXmNactivateCallback\fP procedures with reason value
\fBXmCR_ACTIVATE\fP\&. During multi-line editing, the
process-return() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "process-shift-down():" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP,
moves the insertion cursor down one
line and selects\&. If \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP,
this action behaves like process-up() in \fBXmSINGLE_LINE_EDIT\fP\&.
Refer to the process-up() action\&.
.IP "" 10
The process-shift-down() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "" 10
In vertical writing, if called with the argument
\fBup\fP, moves the insertion cursor one character
up and extends the current selection\&. If called with
the argument \fBdown\fP, moves the insertion cursor
one character down and extends the current selection\&.
.IP "process-shift-up():" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP,
moves the insertion cursor up one
line and selects\&. If \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP,
this action behaves like process-up() in \fBXmSINGLE_LINE_EDIT\fP\&.
Refer to the process-up() action\&.
.IP "" 10
The process-shift-up() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "" 10
In vertical writing, if called with the argument
\fBup\fP, moves the insertion cursor one character
up and extends the current selection\&. If called with
the argument \fBdown\fP, moves the insertion cursor
one character down and extends the current selection\&.
.IP "process-tab(\fBPrev|Next\fP):" 10
If \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP, traverses to the
next tab group if the direction argument is \fBNext\fP, or to the previous
tab group if the direction is \fBPrev\fP\&. If \fBXmNeditMode\fP is
\fBXmMULTI_LINE_EDIT\fP, and the direction is \fBNext\fP, the action
inserts a tab\&. The \fBPrev\fP direction has no effect with
\fBXmMULTI_LINE_EDIT\fP\&.
In the Text widget, there is a preset tab stop at every eighth columns\&.
.IP "" 10
The process-tab() action under multi-line editing produces calls
to the \fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&. Under single-line editing, the action
produces no callbacks, unless it results in the widget losing focus,
in which case, the \fBXmNlosingFocusCallback\fP procedures are called
with reason value \fBXmCR_LOSING_FOCUS\fP\&.
.IP "process-up(\fBextend\fP):" 10
If \fBXmNeditMode\fP is \fBXmSINGLE_LINE_EDIT\fP and
\fBXmNnavigationType\fP is \fBXmNONE\fP,
traverses to the widget above the current one in the tab group\&.
.IP "" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP,
moves the insertion cursor up one line\&.
.IP "" 10
If \fBXmNeditMode\fP is \fBXmMULTI_LINE_EDIT\fP and this action is
called with an argument of \fIextend\fP, moves the insertion cursor as
in the case of no argument and extends the current selection\&.
.IP "" 10
The process-up() action under multi-line editing produces calls
to the \fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&. Under single-line editing, the action
produces no callbacks unless it results in the widget losing focus, in
which case, the \fBXmNlosingFocusCallback\fP procedures are called
with reason value \fBXmCR_LOSING_FOCUS\fP\&.
.IP "" 10
In vertical writing, moves the insertion cursor one character
up\&.
.IP "redraw-display():" 10
Redraws the contents of the text window\&.
.IP "" 10
The redraw-display() action produces no callbacks\&.
.IP "scroll-cursor-vertically(\fIpercentage\fP\fB)\fP:" 10
Scrolls the line containing the insertion cursor vertically
to an intermediate position in the visible window based on an
input percentage\&. A value of 0 indicates the top of the window;
a value of 100, the bottom of the window\&. If this action is called
with no argument, the line containing the insertion cursor is scrolled
vertically to a new position designated by the \fIy\fP position
of the event passed to the routine\&.
.IP "" 10
The \fBscroll-cursor-vertically\fP action produces no callbacks\&.
.IP "scroll-one-line-down():" 10
Scrolls the text area down one line\&.
.IP "" 10
The scroll-one-line-down() action produces no callbacks\&.
.IP "scroll-one-line-up():" 10
Scrolls the text area up one line\&.
.IP "" 10
The scroll-one-line-up() action produces no callbacks\&.
.IP "secondary-adjust():" 10
Extends the secondary selection to the pointer position\&.
.IP "" 10
The secondary-adjust() action produces no callbacks\&.
.IP "secondary-notify():" 10
Copies the secondary selection to the insertion cursor of the
destination widget\&.
.IP "" 10
The secondary-notify() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, and the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP\&.
.IP "secondary-start():" 10
Marks the beginning of a secondary selection\&.
.IP "" 10
The secondary-start() action produces no callbacks\&.
.IP "select-adjust():" 10
Moves the current selection\&.
The amount of text selected depends on the number of mouse clicks, as
specified by the \fBXmNselectionArray\fP resource\&.
.IP "" 10
The select-adjust() action may produce no callbacks,
however, it may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
See callback description for more information\&.
.IP "select-all():" 10
Selects all text\&.
.IP "" 10
The select-all() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
.IP "select-end():" 10
Moves the current selection\&.
The amount of text selected depends on the number of mouse clicks, as
specified by the \fBXmNselectionArray\fP resource\&.
.IP "" 10
The select-end() action produces no callbacks\&.
.IP "select-start():" 10
Marks the beginning of a new selection region\&.
.IP "" 10
The select-start() action may produce calls to the
\fBXmNgainPrimaryCallback\fP procedures\&.
.IP "self-insert():" 10
If \fBXmNpendingDelete\fP is True and the cursor is not disjoint from the
current selection, deletes the entire selection\&.
Inserts the character associated with the key pressed
at the insertion cursor\&.
.IP "" 10
The self-insert() action produces calls to the
\fBXmNmodifyVerifyCallback\fP procedures with reason value
\fBXmCR_MODIFYING_TEXT_VALUE\fP, the \fBXmNvalueChangedCallback\fP
procedures with reason value \fBXmCR_VALUE_CHANGED\fP, and the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.IP "set-anchor():" 10
Resets the anchor point for extended selections\&.
Resets the destination of secondary selection actions\&.
.IP "" 10
The set-anchor() action produces no callbacks\&.
.IP "set-insertion-point():" 10
Sets the insertion position to the position of the mouse pointer\&.
.IP "" 10
The set-insertion-point() action produces calls to the
\fBXmNmotionVerifyCallback\fP procedures with reason value
\fBXmCR_MOVING_INSERT_CURSOR\fP\&. Note that if the mouse pointer is
already over the position of the insertion cursor, the cursor will not
be moved, and no callbacks will be produced\&.
.IP "set-selection-hint():" 10
Sets the text source and location of the current selection\&.
.IP "" 10
The set-selection-hint() action produces no callbacks\&.
.IP "toggle-add-mode():" 10
Toggles the state of Add Mode\&.
.IP "" 10
The toggle-add-mode() action produces no callbacks\&.
.IP "toggle-overstrike():" 10
Toggles the state of the text insertion mode\&. By default,
characters typed into the Text widget are inserted at
the position of the insertion cursor\&. In overstrike
mode, characters entered into the Text 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\&.
.IP "" 10
The following traversal actions generate no callbacks unless they
result in the loss of focus by the widget in question, as when
\fBXmNnavigationType\fP is \fBXmNONE\fP\&. In this case,
they produce calls to the \fBXmNlosingFocusCallback\fP procedures,
with reason value \fBXmCR_FOCUS_MOVED\fP\&.
.IP "traverse-home():" 10
Traverses to the first widget in the tab group\&.
.IP "traverse-next():" 10
Traverses to the next widget in the tab group\&.
.IP "traverse-prev():" 10
Traverses to the previous widget in the tab group\&.
.IP "unkill():" 10
Restores last killed text to the position of the insertion
cursor (or whatever is currently in the \fBCUT_BUFFER0\fP)\&.
The inserted text appears before the insertion cursor\&.
.IP "" 10
The unkill() action produces calls to the \fBXmNmodifyVerifyCallback\fP
procedures with reason value \fBXmCR_MODIFYING_TEXT_VALUE\fP, the
\fBXmNvalueChangedCallback\fP procedures with reason value
\fBXmCR_VALUE_CHANGED\fP, and the \fBXmNmotionVerifyCallback\fP
procedures with reason value \fBXmCR_MOVING_INSERT_CURSOR\fP\&.
.SS "Additional Behavior"
.PP
This widget has the following additional behavior:
.IP "\fB<FocusIn>\fP:" 10
Draws the insertion cursor as solid and starts blinking the cursor\&.
.IP "\fB<FocusOut>\fP:" 10
Displays the insertion cursor as a stippled I-beam unless it is the
destination widget
and stops the cursor from blinking\&.
.SS "Virtual Bindings"
.PP
The bindings for virtual keys are vendor specific\&.
For information about bindings for virtual buttons and keys, see
\fBVirtualBindings\fP(3)\&.
.SH "RELATED"
.PP
\fBCore\fP(3),
\fBXmCreateScrolledText\fP(3),
\fBXmCreateText\fP(3),
\fBXmFontList\fP(3),
\fBXmFontListAppendEntry\fP(3),
\fBXmPrimitive\fP(3),
\fBXmTextClearSelection\fP(3),
\fBXmTextCopy\fP(3),
\fBXmTextCopyLink\fP(3),
\fBXmTextCut\fP(3),
\fBXmTextEnableRedisplay\fP(3),
\fBXmTextDisableRedisplay\fP(3),
\fBXmTextField\fP(3),
\fBXmTextFindString\fP(3),
\fBXmTextFindStringWcs\fP(3),
\fBXmTextGetBaseline\fP(3),
\fBXmTextGetEditable\fP(3),
\fBXmTextGetInsertionPosition\fP(3),
\fBXmTextGetLastPosition\fP(3),
\fBXmTextGetMaxLength\fP(3),
\fBXmTextGetSelection\fP(3),
\fBXmTextGetSelectionWcs\fP(3),
\fBXmTextGetSelectionPosition\fP(3),
\fBXmTextGetSource\fP(3),
\fBXmTextGetString\fP(3),
\fBXmTextGetStringWcs\fP(3),
\fBXmTextGetSubstring\fP(3),
\fBXmTextGetSubstringWcs\fP(3),
\fBXmTextGetTopCharacter\fP(3),
\fBXmTextInsert\fP(3),
\fBXmTextInsertWcs\fP(3),
\fBXmTextPaste\fP(3),
\fBXmTextPasteLink\fP(3),
\fBXmTextPosToXY\fP(3),
\fBXmTextPosition\fP(3),
\fBXmTextRemove\fP(3),
\fBXmTextReplace\fP(3),
\fBXmTextReplaceWcs\fP(3),
\fBXmTextScroll\fP(3),
\fBXmTextSetAddMode\fP(3),
\fBXmTextSetEditable\fP(3),
\fBXmTextSetHighlight\fP(3),
\fBXmTextSetInsertionPosition\fP(3),
\fBXmTextSetMaxLength\fP(3),
\fBXmTextSetSelection\fP(3),
\fBXmTextSetSource\fP(3),
\fBXmTextSetString\fP(3),
\fBXmTextSetStringWcs\fP(3),
\fBXmTextSetTopCharacter\fP(3),
\fBXmTextShowPosition\fP(3),
\fBXmTextXYToPos\fP(3),
\fBXmVaCreateText\fP(3), and
\fBXmVaCreateManagedText\fP(3)\&.