NAME

       XbaeInput - The Input widget class.

SYNOPSIS

       #include <Xbae/Input.h>

DESCRIPTION

       XbaeInput is a text input field that provides generic customised data entry and formatting
       for strings.  It does this by using a clever  XmNmodifyVerifyCallback  that  is  installed
       when the XmNpattern resource is set.  The XmNpattern value may include optional characters
       and literals which will be discussed later in this document.

       The XbaeInput widget is  ideal  for  restricting  data  input  to  a  digit,  alphanumeric
       character  or an alphabetic character.  If XmNconvertCase is set, the widget automatically
       changes an inserted character to uppercase or lowercase. Literal characters  can  also  be
       included in the XmNpattern that can be automatically inserted as the user types by setting
       the XmNautofill resource to True. Optional literals cannot be auto inserted, however.

       Unlike the XmText field from which this widget is subclassed, the toggle-overwrite  action
       is  bound  to  the  osfInsert  key.   The  XmNoverwriteMode  is also provided to allow the
       resource to be changed programmatically.

       When the XbaeInput widget loses focus or is activated in the same way as the XmText  field
       would  be,  callbacks on the XmNvalidateCallback list are invoked, allowing the programmer
       to validate the data as well as reformatting the existing string.

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

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

       ┌─────────────────────────────────────────────────────────────────────────────────────────┐
       │                                XbaeInput Resource Set                                   │
       ├─────────────────────┬───────────────┬────────────────┬────────────────────────┬─────────┤
       │Name                 │ Class         │ Type           │ Default                │ Access  │
       ├─────────────────────┼───────────────┼────────────────┼────────────────────────┼─────────┤
       │XmNalignment         │ XmCAlignment  │ unsigned char  │ XmALIGNMENT_BEGINNING  │ CSG     │
       ├─────────────────────┼───────────────┼────────────────┼────────────────────────┼─────────┤
       │XmNautoFill          │ XmCBoolean    │ Boolean        │ False                  │ CSG     │
       ├─────────────────────┼───────────────┼────────────────┼────────────────────────┼─────────┤
       │XmNconvertCase       │ XmCBoolean    │ Boolean        │ True                   │ CSG     │
       ├─────────────────────┼───────────────┼────────────────┼────────────────────────┼─────────┤
       │XmNoverwriteMode     │ XmCBoolean    │ Boolean        │ False                  │ CSG     │
       ├─────────────────────┼───────────────┼────────────────┼────────────────────────┼─────────┤
       │XmNpattern           │ XmCString     │ String         │ NULL                   │ CSG     │
       ├─────────────────────┼───────────────┼────────────────┼────────────────────────┼─────────┤
       │XmNvalidateCallback  │ XmCCallback   │ Callback       │ NULL                   │ CSG     │
--

AUTHOR

       Andrew Lister (lister@db.com)

RELEASE

       This document describes XbaeInput from Xbae Version 4.9.

SEE ALSO

       Core(3X), XmPrimitive(3X), XmText(3X)

Notice of Limitation

       The  Author, previous and current maintainers of the Xbae widgets (collectively 'authors')
       provide this information solely to  professionals  who  have  the  appropriate  degree  of
       experience  to understand and interpret its contents in accordance with generally accepted
       engineering or other professional standards and applicable regulations. No recommendations
       as to products or vendors is made or should be implied.

       While  the  information  contained  herein  has  been  prepared  from sources deemed to be
       reliable, the authors reserve the right to revise the information without notice, but have
       no  obligation  to  do  so.  Unless  the recipient has been expressly granted a license by
       Bellcore under separate applicable written agreement with Bellcore, no license,  expressed
       or  implied,  is  granted  under  any  patents,  copyrights or other intellectual property
       rights. Use of the information is at your discretion and shall not be deemed an inducement
       by  Bellcore  to  infringe  any  existing  or  later-issued  patent,  copyrights  or other
       intellectual property right.

       THE AUTHORS MAKE NO REPRESENTATIONS AND EXTENDS NO WARRANTIES, EXPRESS  OR  IMPLIED,  WITH
       RESPECT  TO  THE  INFORMATION,  INCLUDING,  BUT  NOT LIMITED TO, THE IMPLIED WARRANTIES OF
       MERCHANTABILITY  AND  FITNESS  FOR  ANY  PARTICULAR  PURPOSE,  AND  THE  WARRANTY  AGAINST
       INFRINGEMENT OF PATENTS OR OTHER INTELLECTUAL PROPERTY RIGHTS. THE INFORMATION IS PROVIDED
       ``AS IS'', AND IN NO EVENT SHALL THE AUTHORS OR ANY OF ITS AFFILIATES BE  LIABLE  FOR  ANY
       DAMAGES,  INCLUDING ANY LOST PROFITS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES RELATING
       TO THE INFORMATION.

       Copyright 1999 Andrew Lister.  All Rights Reserved.
       Copyright 1999-2002 LessTif Developers

       The above no warranty extends to all additions and contributions.  No contributor shall be
       held  liable;  this  work is provided ``as is''.  If this is a problem for you, then don't
       use this software.