IInputEvents Interface

This is a callback interface that is used for reporting events of mouse and keyboard input from the ImageViewer, ZoomViewer, DocumentViewer, TextEditor, TextValidator objects to the listeners. This interface is implemented on the client-side. See the detailed implementation advice for your development tool in Working with Connectable Objects.

Note: The mouse and keyboard input events of Text Validator are, in fact, events of Text Editor built into Text Validator. They are used to monitor user input in Text Validator and, if necessary, respond to it. The input events of Text Validator which has been opened using the Check Spelling button of Text Editor, are translated to Text Editor (not to Text Validator).

An object receiving notifications through this interface's methods may do the following inside the methods' implementation:

  • Report information about mouse moving and clicking, key pressing, and scrolling.
  • Cancel operations.

Methods

Name Description
OnChar Called when a keystroke translates to a character. Delivers to the client the character code, repeat count, and some additional information about the keystroke. Allows you to cancel operation.
OnKeyDown Called when a key is pressed while a component has focus. Delivers to the client the key code, repeat count, and modification keys used. Allows you to cancel operation.
OnKeyUp Called when a key is released while a component has focus. Delivers to the client the key code, repeat count, and modification keys used. Allows you to cancel operation.
OnMouseButtonDown Called when the mouse pointer is over a component and a mouse button is pressed. Delivers to the client information on the mouse button which is pressed, and the coordinates of the mouse pointer.
OnMouseButtonUp Called when the mouse pointer is over a component and a mouse button is released. Delivers to the client information on the mouse button which is released, and the coordinates of the mouse pointer.
OnMouseDoubleClick Called when a component is double-clicked. Delivers to the client information on the coordinates of the mouse pointer and modification keys have been used.
OnMouseMove Called when the mouse pointer is moved over a component. Delivers to the client information on the coordinates of the mouse pointer and modification keys have been used.
OnMouseWheel Called when the mouse wheel moves while a component has focus. Delivers to the client information on the coordinates of the mouse pointer, the amount the mouse wheel has been moved, and modification keys have been used.
OnScroll Called when the scroll box has been moved by either a mouse or keyboard action. Delivers to the client the scroll-bar code, scroll-box position, and the number of scrolled lines. Allows you to cancel operation.

See also

Working with Connectable Objects

IImageViewerEvents

IZoomViewerEvents

IDocumentViewerEvents

ITextEditorEvents

ITextValidatorEvents

9/17/2024 3:14:40 PM

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.