%UWNDEVENTS_METHOD

Perform window event processing

WTSupported in traditional Synergy on Windows

 

 

 

function UWNDEVENTS_METHOD,^val
 {reserved1}            ,a
 {reserved2}            ,a
 ^val(window_id)        ,i
 ^val(event)            ,i
 [arguments]            ,type

Return value

False when a mouse click is not passed to the target window on a mouse click event; otherwise returns true. (n)

Arguments

{reserved1}
{reserved2}

Reserved for internal use. (a)

window_id

The ID of the window receiving the event. This must be declared as ^VAL(window_id). (i)

event

The ID of the event that occurred. This must be declared as ^VAL(event). (i)

D_EVENT_LEFT_CLICK = Left mouse button event.

D_EVENT_MIDDLE_CLICK = Middle mouse button event.

D_EVENT_RIGHT_CLICK = Right mouse button event.

D_EVENT_LEFT_DBLCLK = Double‑click left mouse button event.

D_EVENT_MIDDLE_DBLCLK = Double‑click middle mouse button event.

D_EVENT_RIGHT_DBLCLK = Double‑click right mouse button event.

D_EVENT_MOVE = Move window event.

D_EVENT_SIZE = Size window event.

D_EVENT_MINIMIZE = Minimize window event.

D_EVENT_MAXIMIZE = Maximize window event.

D_EVENT_RESTORE = Restore window event.

D_EVENT_SCROLL = Scroll window event.

D_EVENT_CLOSE = Close window event.

arguments

One or more arguments specific to event. The MINIMIZE, MAXIMIZE, RESTORE, and CLOSE events have no additional arguments.

^VAL (arg_5)

Position in x‑direction (column in cells).

^VAL (arg_6)

Position in y‑direction (row in cells).

^VAL (arg_7)

Position in x‑direction (column in pixels).

^VAL (arg_8)

Position in y‑direction (row in pixels).

^VAL (arg_9)

Additional mouse click information. See the Additional mouse click information for arg_9 table for options.

^VAL (arg_5)

Position in x‑direction (column in cells).

^VAL (arg_6)

Position in y‑direction (row in cells).

^VAL (arg_7)

Position in x‑direction (column in pixels).

^VAL (arg_8)

Position in y‑direction (row in pixels).

^VAL (arg_5)

Width of logical window (number of columns).

^VAL (arg_6)

Height of logical window (number of rows) or the number of visible list items when using a list.

^VAL (arg_7)

Width of client area (number of pixels).

^VAL (arg_8)

Height of client area (number of pixels).

^VAL (arg_5)

Display area position in x‑direction (column in cells).

^VAL (arg_6)

Display area position in y‑direction (row in cells) or item number of the display area position when using a list.

^VAL (arg_7)

Offset between window position and display area position in x‑direction (number of pixels).

^VAL (arg_8)

Offset between window position and display area position in y‑direction (number of pixels). Always 0 when using a list.

Discussion

%UWNDEVENTS_METHOD is a function that you write and name. You do not call it. Instead UI Toolkit will call it when a mouse event that you have assigned to the method occurs.

To suppress a mouse click from being passed through to the target window, return a value of false for the %UWNDEVENTS_METHOD; otherwise always return true.

Important

It is vital that the argument types be declared exactly as documented. Incorrect definition of arguments to your event method routine will cause undefined results.

When using a list with any of the CLICK and DBLCLK events, arg_5 returns the column number clicked, and arg_6 returns the row number clicked. For ActiveX Toolkit lists, the row number specifies the item’s position in the currently loaded rows, both visible rows and those that don’t fit in the window. For standard Toolkit lists, the row number specifies the item’s position in the currently visible set of rows. However, note the following:

See also