BBjEditBox::getPassHomeDelete

Description

Returns whether the HOME and DEL key notifications are being sent to the top-level window.

Syntax

Return Value

Method

boolean

getPassHomeDelete()

Parameters

None.

Return Value

Returns whether the HOME and DEL key notifications are being sent to the top-level window.

0 = Not passed

1 = Passed

Remarks

By default, the HOME and DEL key notification is not passed.

Example

REM Determine if an edit box is passing the HOME and DEL key notifications to a 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 a edit box on the window
myEditBox! = myWindow!.addEditBox(101,50,100,90,30,"Edit Box")

REM Set the edit box to pass the HOME and DEL key notifications to the window
myEditBox!.setPassHomeDelete(mySysGui!.TRUE)

REM Determine if the edit box is passing the HOME and DEL key notifications
REM to the window, this will return 1 (true)
PASS_HOME_DELETE=myEditBox!.getPassHomeDelete()

REM Register the CALLBACK routines
CALLBACK(ON_KEYPRESS,KEY_PRESSED,mySysGui!.getContext())
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

REM Process Events
PROCESS_EVENTS

REM Callback routine called when a key is pressed in the window
KEY_PRESSED:
REM Display a message that a key press event was received
MESSAGE$="Key press event"
LET X=MSGBOX(MESSAGE$)
RETURN

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.