BBjListBox::getMultipleSelection

Description

Returns whether multiple item selection is allowed in the BBjListBox control.

Syntax

Return Value	Method
`boolean`	getMultipleSelection()

Parameters

None.

Return Value

Returns whether multiple item selection is allowed (0 = Not Allowed, 1 = Allowed).

Remarks

By default, multiple item selection is not allowed.

When multiple item selection is allowed, a mouse left click with no keyboard modifier selects the clicked item and deselects any previously clicked items.

Mouse left click with CMD key pressed (macOS) or CTRL key pressed (Windows) selects the clicked item without deselecting previously clicked items.

Mouse left click with SHIFT key pressed selects the entire range between the previously clicked item through the current clicked item.

Example

rem 'Determine if a list box control allows for multiple item selection

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 list box control to the window
myListBox! = myWindow!.addListBox(101,50,100,90,60,"",$0000$)

rem 'Add items into the list box
FOR I = 1 TO 4
    ITEM$="ITEM " + STR(I)
    myListBox!.addItem(ITEM$)
NEXT I

rem 'Set the list box control to allow for multiple item selection
myListBox!.setMultipleSelection(mySysGui!.TRUE)

rem 'Determine if the list box control allows for multiple item selection
rem 'this will return true (1)
MULTI_SEL = myListBox!.getMultipleSelection()

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