Developer Guide and Reference

ID 767251
Date 10/31/2024
Public
Document Table of Contents

UNREGISTERMOUSEEVENT

QuickWin Function: Removes the callback routine registered for a specified window by an earlier call to REGISTERMOUSEEVENT. This routine is only available for Windows.

Module

USE IFQWIN

result = UNREGISTERMOUSEEVENT (unit,mouseevents)

unit

(Input) INTEGER(8). Unit number of the window whose callback routine on mouse events is to be unregistered.

mouseevents

(Input) INTEGER(4). One or more mouse events handled by the callback routine to be unregistered. Symbolic constants (defined in IFQWIN.F90) for the possible mouse events are:

  • MOUSE$LBUTTONDOWN - Left mouse button down

  • MOUSE$LBUTTONUP - Left mouse button up

  • MOUSE$LBUTTONDBLCLK - Left mouse button double-click

  • MOUSE$RBUTTONDOWN - Right mouse button down

  • MOUSE$RBUTTONUP - Right mouse button up

  • MOUSE$RBUTTONDBLCLK - Right mouse button double-click

  • MOUSE$MOVE - Mouse moved

Results

The result type is INTEGER(4). The result is zero or a positive integer if successful; otherwise, a negative integer that can be one of the following:

  • MOUSE$BADUNIT - The unit specified is not open, or is not associated with a QuickWin window.

  • MOUSE$BADEVENT - The event specified is not supported.

Once you call UNREGISTERMOUSEEVENT, QuickWin no longer calls the callback routine specified earlier for the window when mouse events occur. Calling UNREGISTERMOUSEEVENT when no callback routine is registered for the window has no effect.