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 true (1)
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