Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1
The list of the topics, classes, interfaces, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Back to WinPointerEventsMBS class.
WinPointerEventsMBS.Gesture(info as WinGestureInfoMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
Return true, if you processed the message, else false.
WinPointerEventsMBS.GestureNotify
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
When the GestureNotify event is received, the application can use SetGestureConfig to specify the gestures to receive.
WinPointerEventsMBS.PointerDeviceChange(Change as Integer, Param as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
This message contains information regarding the scaling of the display mode.
See kDeviceChange* constants.
WinPointerEventsMBS.PointerDeviceInRange(Param1 as Integer, Param2 as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
This message contains information regarding the device and its proximity.
If the application processes this message, it should return true, else false.
WinPointerEventsMBS.PointerDeviceOutOfRange(Param1 as Integer, Param2 as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
This message contains information regarding the device and its proximity.
If the application processes this message, it should return true, else false.
WinPointerEventsMBS.PointerDown(PointerID as Integer, Flags as Integer, X as Integer, Y as Integer, info as WinPointerInfoMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
This input message targets the window over which the pointer makes contact, and the pointer is implicitly captured to the window so that the window continues to receive input for the pointer until it breaks contact.
We provide pointer ID, flags, X and Y.
BitwiseAnd(flags, WinPointerInfoMBS.kFlagNew) <> 0 | A flag that indicates whether this message represents the first input generated by a new pointer. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagInRange) <> 0 | A flag that indicates whether this message was generated by a pointer during its lifetime. This flag is not set on messages that indicate that the pointer has left detection range |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagInContact) <> 0 | A flag that indicates whether this message was generated by a pointer that is in contact with the window surface. This flag is not set on messages that indicate a hovering pointer. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagPrimary) <> 0 | Indicates that this pointer has been designated as primary. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagFirstButton) <> 0 | A flag that indicates whether there is a primary action. This is analogous to a mouse left button down. A touch pointer will have this set when it is in contact with the digitizer surface. A pen pointer will have this set when it is in contact with the digitizer surface with no buttons pressed. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagSecondButton) <> 0 | A flag that indicates whether there is a secondary action. This is analogous to a mouse right button down. A pen pointer will have this set when it is in contact with the digitizer surface with the pen barrel button pressed. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagThirdButton) <> 0 | A flag that indicates whether there are one or more tertiary actions based on the pointer type; applications that wish to respond to tertiary actions must retrieve information specific to the pointer type to determine which tertiary buttons are pressed. For example, an application can determine the buttons states of a pen by calling GetPointerPenInfo and examining the flags that specify button states. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagFourthButton) <> 0 | A flag that indicates whether the specified pointer took fourth action. Applications that wish to respond to fourth actions must retrieve information specific to the pointer type to determine if the first extended mouse (XButton1) button is pressed. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagFifthButton) <> 0 | A flag that indicates whether the specified pointer took fifth action. Applications that wish to respond to fifth actions must retrieve information specific to the pointer type to determine if the second extended mouse (XButton2) button is pressed. |
WinPointerEventsMBS.PointerEnter(PointerID as Integer, Flags as Integer, X as Integer, Y as Integer, info as WinPointerInfoMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
We provide Pointer ID, Flags, X and Y.
BitwiseAnd(flags, WinPointerInfoMBS.kFlagNew) <> 0 | Indicates whether this message is the first message generated by a new pointer entering detection range (hover). |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagInRange) <> 0 | Indicates whether this message was generated by a pointer that has not left detection range. This flag is always set for PointerEnter messages. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagInContact) <> 0 | A flag that indicates whether this message was generated by a pointer that is in contact. This flag is not set for a pointer in detection range (hover). |
Action | Flags Set | Notifications Sent To |
A new pointer enters detection range (hover). | kFlagNew and kFlagInRange | Window over which the pointer enters detection range. |
A hovering pointer crosses within the window boundaries. | kFlagInRange | Window within which the pointer has crossed. |
WinPointerEventsMBS.PointerHWheel(PointerID as Integer, Delta as Integer, X as Integer, Y as Integer, info as WinPointerInfoMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
We provide, the pointer ID, the delta and x/y coordinate.
Info object provides pointer details.
To retrieve the wheel scroll units, use the inputData filed of the WinPointerInfoMBS object. This field contains a signed value and is expressed in a multiple of WHEEL_DELTA (120). A positive value indicates a rotation forward and a negative value indicates a rotation backward.
Note that the wheel inputs may be delivered even if the mouse cursor is located outside of application’s window. The wheel messages are delivered in a way very similar to the keyboard inputs. The focus window of the foregournd message queue receives the wheel messages.
WinPointerEventsMBS.PointerLeave(PointerID as Integer, Flags as Integer, X as Integer, Y as Integer, info as WinPointerInfoMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
We provide the pointer ID, Flags, X and Y values.
BitwiseAnd(flags, WinPointerInfoMBS.kFlagInRange) <> 0 | Indicates whether this message was generated by a pointer that has not left detection range. This flag is not set when the pointer leaves the detection range of the window. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagInContact) <> 0 | A flag that indicates whether this message was generated by a pointer that is in contact. This flag is not set for a pointer in detection range (hover). |
Action | Flags Set | Notifications Sent To |
A hovering pointer crosses window boundaries. | BitwiseAnd(flags, WinPointerInfoMBS.kFlagInRange) <> 0 | Window outside of whose boundary the pointer moved. |
A pointer goes out of detection range. | N/A | Window for which the pointer leaves detection range. |
WinPointerEventsMBS.PointerUp(PointerID as Integer, Flags as Integer, X as Integer, Y as Integer, info as WinPointerInfoMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
This input message targets the window over which the pointer makes contact and the pointer is, at that point, implicitly captured to the window so that the window continues to receive input messages including the WM_POINTERUP notification for the pointer until it breaks contact.
We provide pointer ID, flags, X and Y.
BitwiseAnd(flags, WinPointerInfoMBS.kFlagNew) <> 0 | A flag that indicates whether this message represents the first input generated by a new pointer. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagInRange) <> 0 | A flag that indicates whether this message was generated by a pointer during its lifetime. This flag is not set on messages that indicate that the pointer has left detection range |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagInContact) <> 0 | A flag that indicates whether this message was generated by a pointer that is in contact with the window surface. This flag is not set on messages that indicate a hovering pointer. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagPrimary) <> 0 | Indicates that this pointer has been designated as primary. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagFirstButton) <> 0 | A flag that indicates whether there is a primary action. This is analogous to a mouse left button down. A touch pointer will have this set when it is in contact with the digitizer surface. A pen pointer will have this set when it is in contact with the digitizer surface with no buttons pressed. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagSecondButton) <> 0 | A flag that indicates whether there is a secondary action. This is analogous to a mouse right button down. A pen pointer will have this set when it is in contact with the digitizer surface with the pen barrel button pressed. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagThirdButton) <> 0 | A flag that indicates whether there are one or more tertiary actions based on the pointer type; applications that wish to respond to tertiary actions must retrieve information specific to the pointer type to determine which tertiary buttons are pressed. For example, an application can determine the buttons states of a pen by calling GetPointerPenInfo and examining the flags that specify button states. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagFourthButton) <> 0 | A flag that indicates whether the specified pointer took fourth action. Applications that wish to respond to fourth actions must retrieve information specific to the pointer type to determine if the first extended mouse (XButton1) button is pressed. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagFifthButton) <> 0 | A flag that indicates whether the specified pointer took fifth action. Applications that wish to respond to fifth actions must retrieve information specific to the pointer type to determine if the second extended mouse (XButton2) button is pressed. |
WinPointerEventsMBS.PointerUpdate(PointerID as Integer, Flags as Integer, X as Integer, Y as Integer, info as WinPointerInfoMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
While the pointer is hovering, the message targets whichever window the pointer happens to be over. While the pointer is in contact with the surface, the pointer is implicitly captured to the window over which the pointer made contact and that window continues to receive input for the pointer until it breaks contact.
We provide pointer ID, flags, X and Y.
BitwiseAnd(flags, WinPointerInfoMBS.kFlagNew) <> 0 | A flag that indicates whether this message represents the first input generated by a new pointer. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagInRange) <> 0 | A flag that indicates whether this message was generated by a pointer during its lifetime. This flag is not set on messages that indicate that the pointer has left detection range |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagInContact) <> 0 | A flag that indicates whether this message was generated by a pointer that is in contact with the window surface. This flag is not set on messages that indicate a hovering pointer. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagPrimary) <> 0 | Indicates that this pointer has been designated as primary. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagFirstButton) <> 0 | A flag that indicates whether there is a primary action. This is analogous to a mouse left button down. A touch pointer will have this set when it is in contact with the digitizer surface. A pen pointer will have this set when it is in contact with the digitizer surface with no buttons pressed. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagSecondButton) <> 0 | A flag that indicates whether there is a secondary action. This is analogous to a mouse right button down. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagThirdButton) <> 0 | A flag that indicates whether there are one or more tertiary actions based on the pointer type; applications that wish to respond to tertiary actions must retrieve information specific to the pointer type to determine which tertiary buttons are pressed. For example, an application can determine the buttons states of a pen by calling GetPointerPenInfo and examining the flags that specify button states. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagFourthButton) <> 0 | A flag that indicates whether the specified pointer took fourth action. Applications that wish to respond to fourth actions must retrieve information specific to the pointer type to determine if the first extended mouse (XButton1) button is pressed. |
BitwiseAnd(flags, WinPointerInfoMBS.kFlagFifthButton) <> 0 | A flag that indicates whether the specified pointer took fifth action. Applications that wish to respond to fifth actions must retrieve information specific to the pointer type to determine if the second extended mouse (XButton2) button is pressed. |
WinPointerEventsMBS.PointerWheel(PointerID as Integer, Delta as Integer, X as Integer, Y as Integer, info as WinPointerInfoMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
event | Windows | MBS Win Plugin | 16.2 | ❌ No | ✅ Yes | ❌ No | ❌ No |
We provide, the pointer ID, the delta and x/y coordinate.
Info object provides pointer details.
To retrieve the wheel scroll units, use the inputData filed of the WinPointerInfoMBS object. This field contains a signed value and is expressed in a multiple of WHEEL_DELTA (120). A positive value indicates a rotation forward and a negative value indicates a rotation backward.
Note that the wheel inputs may be delivered even if the mouse cursor is located outside of application’s window. The wheel messages are delivered in a way very similar to the keyboard inputs. The focus window of the foregournd message queue receives the wheel messages.
The items on this page are in the following plugins: MBS Win Plugin.