Provided by: libmotif-dev_2.3.4-10_amd64 bug

NAME

       XmTextField — The TextField class

SYNOPSIS

       #include <Xm/Xm.h>

DESCRIPTION

       The  TextField  widget  provides  a  single  line  text editor for customizing both user and programmatic
       interfaces. It is used for single-line string entry, and forms entry with  verification  procedures.   It
       provides an application with a consistent editing system for textual data.

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

       The  user  interface  tailors  a  new set of actions.  The key bindings have been added for insert cursor
       movement, deletion, insertion, and selection of text.

       TextField allows the user to select regions of text.  Selection is based on the model  specified  in  the
       Inter-Client  Communication  Conventions  Manual  (ICCCM).   TextField  supports  primary  and  secondary
       selection.

       TextField uses the XmQTnavigator, XmQTspecifyRenderTable,  and  XmQTscrollFrame  traits,  and  holds  the
       XmQTaccessTextual XmQTtransfer traits.

       If  an  application or widget calls the setValue trait method of XmQTaccessTextual, then XmTextField will
       call XmTextFieldSetString to set the string value.

   Data Transfer Behavior
       TextField supports transfer of the primary, secondary, and clipboard selections and dragging of  selected
       text  from  the  widget.  TextField can also be the destination for the primary, secondary, and clipboard
       selections, and it supports dropping of data being dragged onto the widget.

       When   the   XmNconvertCallback   procedures   are   called,   the   location_data    member    of    the
       XmConvertCallbackStruct  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  TextField
       widget.

       As a source of data, TextField supports the following targets and associated conversions of data to these
       targets:

       UTF8_STRING
                 The widget transfers the selected text as type UTF8_STRING.

       locale    If the locale target matches the widget's locale, the widget transfers the selected text in the
                 encoding of the locale.

       COMPOUND_TEXT
                 The widget transfers the selected text as type COMPOUND_TEXT.

       STRING    The widget transfers the selected text as type STRING.

       TEXT      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 COMPOUND_TEXT.

       DELETE    The widget deletes the selected text.

       _MOTIF_CLIPBOARD_TARGETS
                 The  widget transfers, as type ATOM, a list of the targets to which the widget can convert data
                 to be placed on the clipboard immediately.  These include the following targets:

                    •  UTF8_STRINGCOMPOUND_TEXT

                    •  The encoding of the locale, if the selected text is fully convertible to the encoding  of
                       the locale

                    •  STRING, if the selected text is fully convertible to STRING

       _MOTIF_EXPORT_TARGETS
                 The  widget  transfers,  as  type  ATOM,  a  list of the targets to be used as the value of the
                 DragContext's XmNexportTargets in a drag-and-drop transfer.  These include  COMPOUND_TEXT,  the
                 encoding of the locale, STRING, TEXT, UTF8_STRING, BACKGROUND, and FOREGROUND.

       _MOTIF_LOSE_SELECTION
                 The widget takes the following actions:

                    •  When  losing  the  PRIMARY  selection,  it  unhighlights  the selected text and calls the
                       XmNlosePrimaryCallback procedures.

                    •  When losing the SECONDARY selection, it removes the secondary selection highlight.

                    •  When losing the _MOTIF_DESTINATION selection, if  the  widget  does  not  have  focus  it
                       changes the cursor to indicate that the widget is no longer the destination.

       As a source of data, TextField also supports the following standard Motif targets:

       BACKGROUND
                 The widget transfers XmNbackground as type PIXEL.

       CLASS     The  widget  finds  the  first  shell  in the widget hierarchy that has a WM_CLASS property and
                 transfers the contents as text in the current locale.

       CLIENT_WINDOW
                 The widget finds the first shell in the widget hierarchy  and  transfers  its  window  as  type
                 WINDOW.

       COLORMAP  The widget transfers XmNcolormap as type COLORMAP.

       FOREGROUND
                 The widget transfers XmNforeground as type PIXEL.

       NAME      The  widget  finds  the  first  shell  in  the widget hierarchy that has a WM_NAME property and
                 transfers the contents as text in the current locale.

       TARGETS   The widget transfers, as type ATOM, a list of the  targets  it  supports.   These  include  the
                 standard  targets  in this list.  These also include COMPOUND_TEXT, the encoding of the locale,
                 STRING, TEXT and UTF8_STRING.

       TIMESTAMP The widget transfers the timestamp used to acquire the selection as type INTEGER.

       _MOTIF_RENDER_TABLE
                 The widget transfers XmNrenderTable if it exists, or else the default  text  render  table,  as
                 type STRING.

       _MOTIF_ENCODING_REGISTRY
                 The  widget  transfers  its  encoding  registry  as  type  STRING.  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 XmRegisterSegmentEncoding and XmMapSegmentEncoding.

       As  a  destination  for data, TextField 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, TextField  chooses  a
       requested target from the available targets in the following order of preference:

          1. TEXT

          1. UTF8_STRING

          2. COMPOUND_TEXT

          3. The encoding of the locale

          4. STRING

       If  the  encoding  of  the  locale  is  not present in the list of available targets, TextField chooses a
       requested target from the available targets in the following order of preference:

          1. UTF8_STRING

          1. COMPOUND_TEXT

          2. STRING

   Classes
       TextField widget inherits behavior, resources, and traits from Core and Primitive.

       The class pointer is xmTextFieldWidgetClass.

       The class name is XmTextField.

   New Resources
       The following table defines a set of widget resources  used  by  the  programmer  to  specify  data.  The
       programmer  can also set the resource values for the inherited classes to set attributes for this widget.
       To reference a resource by name or by class in a .Xdefaults file, remove the XmN or XmC  prefix  and  use
       the  remaining  letters. To specify one of the defined values for a resource in a .Xdefaults file, remove
       the Xm prefix and use the remaining letters (in  either  lower  case  or  upper  case,  but  include  any
       underscores  between words).  The codes in the access column indicate if the given resource can be set at
       creation time (C), set by using XtSetValues (S), retrieved by using XtGetValues (G), or is not applicable
       (N/A).

       ┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
--

RELATED

       Core(3),     XmCreateTextField(3),     XmFontList(3),      XmFontListAppendEntry(3),      XmPrimitive(3),
       XmTextFieldClearSelection(3),      XmTextFieldCopy(3),     XmTextFieldCopyLink(3),     XmTextFieldCut(3),
       XmTextFieldGetBaseline(3),         XmTextFieldGetEditable(3),         XmTextFieldGetInsertionPosition(3),
       XmTextFieldGetLastPosition(3),           XmTextFieldGetMaxLength(3),          XmTextFieldGetSelection(3),
       XmTextFieldGetSelectionPosition(3),        XmTextFieldGetSelectionWcs(3),        XmTextFieldGetString(3),
       XmTextFieldGetStringWcs(3),           XmTextFieldGetSubstring(3),          XmTextFieldGetSubstringWcs(3),
       XmTextFieldInsert(3),     XmTextFieldInsertWcs(3),     XmTextFieldPaste(3),      XmTextFieldPasteLink(3),
       XmTextFieldPosToXY(3),     XmTextFieldRemove(3),     XmTextFieldReplace(3),     XmTextFieldReplaceWcs(3),
       XmTextFieldSetAddMode(3),             XmTextFieldSetEditable(3),              XmTextFieldSetHighlight(3),
       XmTextFieldSetInsertionPosition(3),        XmTextFieldSetMaxLength(3),        XmTextFieldSetSelection(3),
       XmTextFieldSetString(3), XmTextFieldSetStringWcs(3),  XmTextFieldShowPosition(3),  XmTextFieldXYToPos(3),
       XmVaCreateTextField(3), and XmVaCreateManagedTextField(3).

                                                                                                  XmTextField(3)