BBjInputE::getPassEnter

Description

Returns whether the BBjInputE control passes the ENTER key notification to the top-level window.

Syntax

Return Value	Method
boolean	getPassEnter()

Parameters

None.

Return Value

Returns whether the ENTER key is passed to the top-level window (0 = Not passed, 1 = Passed).

Remarks

By default, the ENTER key is not passed.

Example

rem 'Determine if an InputE control is to pass the ENTER key notification to a top level window

rem 'Obtain the instance of the BBjAPI object
let myAPI! = BBjAPI()

rem 'Open the SysGui device
SYSGUI = UNT
OPEN (SYSGUI) "X0"

rem 'Obtain the instance of the BBjSysGui object
let mySysGui! = myAPI!.getSysGui()

rem 'Set addWindow param values
X = 10
Y = 10
WIDTH = 200
HEIGHT = 200
TITLE$="BBj Window"

rem 'Set the current context
mySysGui!.setContext(0)

rem 'Create a window
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)

rem 'Add an INPUTE control that accepts only alphabetic characters and converts
rem 'all to upper case, limiting input to 10 characters, and inserting
rem 'the value "STANDARD" when the user hits the restore key (normally ESCAPE)
myInputE! = myWindow!.addInputE(101,50,100,90,30,$0804$,"AAAAAAAAAA","",1,"STANDARD","")

rem 'Set an InputE control to pass the ENTER key notification to a top level window
myInputE!.setPassEnter(mySysGui!.TRUE)

rem 'Determine if an InputE control is to pass the ENTER key notification to
rem 'a top level window, this will return true (1)
PASS_ENTER = myInputE!.getPassEnter()

rem 'Register the CALLBACK routines
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

rem 'Process Events
process_events

rem 'Callback routine called when the user closes the application window
APP_CLOSE:
release