MOUSECAPTURE Grid Notify Event

Description

A mouse capture event has taken place.

Event Template

context:u(2),code:i(1),id:u(2),objtype:i(2),msg:i(4),wparam:i(4),lparam:i(4),col:i(4),row:i(4),textcolor:c(3),backcolor:c(3),alignment:u(1),style:i(4),imgidx:i(4),x:i(2),y:I(2),w:u(2),h:u(2), ptx:i(2),pty:i(2),buf:c(1*)

Significant Field

Description

context

Context in which the event occurred.

code

17

id

ID of the resource that caused the event.

objtype

Type of resource that caused the event.

msg

Event code number.

wparam

Extended key status flag, which identifies the status of the Shift and Ctrl keys:

  • Bit $01$ set = Ctrl pressed.

  • Bit $02$ set = Shift pressed.

lparam

Mouse button position:

  • 1 = Button pressed.

  • 0 = Button released.

col

Number of the column containing the clicked cell.

row

Number of the row containing the clicked cell.

x, y,w,h

Rectangle containing the clicked cell.

ptx,pty

Point within the cell that was clicked.

This event is returned 10 times per second while a mouse button is held down but must be enabled via Set Mouse Capture Mode - GRID SENDMSG() Function 64. Once the mouse button is released, Set Mouse Capture mode is automatically set to False (0), which disables the message.

See Also

NOTICE() Function - Get SYSGUI Notice String

NOTICETPL() Function - Get Notice String Template

BBjGridMouseDragEvent

BBjGridMouseMoveEvent