Description
This method returns an indication of whether the Ctrl key was pressed at the time this BBjToolButtonPushEvent was generated.
Syntax
|
Return Value
|
Method
|
|
boolean
|
isControlDown()
|
Parameters
None.
Return Value
Returns 1 if the Ctrl key was pressed, otherwise it returns 0.
Example
rem ' BBjToolButtonPushEvent Sample
rem '
rem ' Click the tool button (hold Shift/Ctrl/Alt to see flags change).
rem ' The button is toggleable, so isSelected() reflects its on/off state.
rem ' To have the right mouse button fire this event, set the !COMPAT key
rem ' RCLICKTOOLBUTTON, e.g. x$ = STBL("!COMPAT", "RCLICKTOOLBUTTON=TRUE")
declare BBjSysGui sysGui!
declare BBjWindow window!
declare BBjToolButton toolButton!
declare BBjAPI api!
declare auto BBjToolButtonPushEvent event!
api! = BBjAPI()
sysGui! = api!.openSysGui("X0")
window! = sysGui!.addWindow(50, 50, 420, 160, "BBjToolButtonPushEvent Sample")
window!.setCallback(window!.ON_CLOSE, "eoj")
toolButton! = window!.addToolButton(101, 150, 55, 120, 45, "Click Me")
toolButton!.setToggleable(1)
toolButton!.setCallback(toolButton!.ON_TOOL_BUTTON_PUSH, "onToolButtonPush")
process_events
onToolButtonPush:
rem ' Retrieve the BBjToolButtonPushEvent that triggered this callback
event! = api!.getLastEvent()
rem ' getMouseButton() returns LEFT, MIDDLE, or RIGHT
button$ = "Unknown"
if (event!.getMouseButton() = event!.LEFT) then button$ = "Left"
if (event!.getMouseButton() = event!.MIDDLE) then button$ = "Middle"
if (event!.getMouseButton() = event!.RIGHT) then button$ = "Right"
rem ' Read the remaining event properties into a report
report$ = "Mouse button: " + button$ + $0A$
report$ = report$ + "getX(): " + str(event!.getX()) + $0A$
report$ = report$ + "getY(): " + str(event!.getY()) + $0A$
report$ = report$ + "isSelected(): " + str(event!.isSelected()) + $0A$
report$ = report$ + "isShiftDown(): " + str(event!.isShiftDown()) + $0A$
report$ = report$ + "isControlDown(): " + str(event!.isControlDown()) + $0A$
report$ = report$ + "isAltDown(): " + str(event!.isAltDown()) + $0A$
report$ = report$ + "isCmdDown(): " + str(event!.isCmdDown())
x = msgbox(report$, 0, "Tool Button Pushed")
return
eoj:
release
|
See Also
BBjAPI
BBj Object Syntax
BBj Object Diagram for an illustration of the relationship between BBjObjects.