BBjToolButton::isToggleable

Description

Returns whether the BBjToolButton is toggleable.

Syntax

Return Value

Method

boolean

isToggleable()

Parameters

None.

Return Value

Returns whether the tool button is toggleable (0 = Not toggleable, 1 = Toggleable).

Remarks

By default, the tool button is not toggleable.

Example

rem 'Determine if a tool button is toggleable

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 tool button on the window
myToolButton! = myWindow!.addToolButton(101,50,100,90,30,"Tool Button")

rem 'Set the tool button to be toggleable
myToolButton!.setToggleable(mySysGui!.TRUE)

rem 'Determine if the tool button is toggleable, this will return true (1)
TOGGLEABLE = myToolButton!.isToggleable()

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

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

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