Title:   Internal form events
Status:  Obsolete
Created: 2002-07-17

Requests generated by the User (via the UI)
===========================================


requestKeyPress
---------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestReplaceValue
-------------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestCursorLeft
-----------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestCursorRight
------------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestCursorEnd
----------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestCursorHome
-----------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestBackSpace
----------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestDelete
-------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a




requestSELECTALL
----------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestSELECTTOHOME
-------------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestSELECTTOEND
------------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestSELECTLEFT
-----------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestSELECTRIGHT
------------------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestCOPY
-----------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestCUT
----------

  Description:
     This event signals to the current entry's input handler to

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



requestPASTE
------------

  Description:
     Created when the user requests the Clipboard Paste feature.

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments:
     Also see "clipboardGet"






Requests generated internally
=============================


ClipboardGet
------------

  Description:
     This event signals to the current entry's input handler to
     enter edit mode.

  Input Parameters: n/a

  Return Parameters: n/a

  Returns:
     The current text of the clipboard, or None if clipboard is empty.

  Comments: n/a



ClipboardSet
------------

  Description:
     This event requests (from the UI) that the clipboard contents
     be replaced.

  Input Parameters:
     text         The text to place on the clipboard

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



BeginEditMode
-------------

  Description:
     This event signals to the current entry's input handler to
     enter edit mode.

  Input Parameters: n/a

  Return Parameters: n/a

  Returns: n/a

  Comments: n/a



EndEditMode
-----------

  Description:
     This event signals to the current entry's input handler to
     leave edit mode.  If event._error__ is set, then the input
     was not valid and, therefore, the entry is still in edit
     mode.

  Input Parameters: n/a

  Return Parameters:
     modified     If set to true, then the field was modified
                  sometime after the beginEditMode event.

  Returns:
     Final value of field

  Comments: n/a

