BBjInputE::getInsertMode

Description

Returns whether the BBjInputE control is in insert mode.

Syntax

Return Value

Method

boolean

getInsertMode()

Parameters

None.

Return Value

Returns whether the BBjInputE control is in the insert mode (0 = Not in insert mode, 1 = In insert mode).

Remarks

By default, the BBjInputE control is not in insert mode.

Example

REM Determine if an InputE control is in insert mode

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","BBjInputE")

REM Set an InputE control to be in insert mode
myInputE!.setInsertMode(mySysGui!.TRUE)

REM Determine if the InputE control is in insert mode, this will return 1 (TRUE)
INSERT_MODE=myInputE!.getInsertMode()

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.