BBjInputD::getPassEnter

Description

In BBj 4.0 and higher, this method returns whether the BBjInputD control passes the ENTER key 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 InputD 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$,$00010002$)

REM Add an InputD control that uses the current default mask, inserting
REM today's date when the user hits the restore key (normally ESCAPE)
myInputD! = myWindow!.addInputD(101,50,100,90,30,$080c$,"",$$,0,0)

REM Set an InputD control to pass the ENTER key notification to a top level window
myInputD!.setPassEnter(mySysGui!.TRUE)

REM Determine if an InputD control is to pass the ENTER key notification to
REM a top level window; this will return 1 (TRUE)
print "Pass Enter is",myInputD!.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
RETURN

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.