Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

WinPointerInfoMBS class

Type Topic Plugin Version macOS Windows Linux Console & Web iOS
class Windows MBS Win Plugin 16.2 No Yes No Yes, Windows only No
Function: The class for pointer input details.
Notes: This is an abstract class. You can't create an instance, but you can get one from various plugin functions.

Feedback, Comments & Corrections

Flag Constants

Constant Value Description
kFlagCanceled &h8000 Indicates that the pointer is departing in an abnormal manner, such as when the system receives invalid input for the pointer or when a device with active pointers departs abruptly. If the application receiving the input is in a position to do so, it should treat the interaction as not completed and reverse any effects of the concerned pointer.
kFlagCaptureChanged &h200000 Indicates that this pointer was captured by (associated with) another element and the original element has lost capture.
kFlagConfidence &h4000 Confidence is a suggestion from the source device about whether the pointer represents an intended or accidental interaction, which is especially relevant for touch pointers where an accidental interaction (such as with the palm of the hand) can trigger input. The presence of this flag indicates that the source device has high confidence that this input is part of an intended interaction.
kFlagDown &h10000 Indicates that this pointer transitioned to a down state; that is, it made contact with the digitizer surface.
kFlagFifthButton &h100 Analogous to a second extended mouse (XButton2) button down.
A touch pointer does not use this flag.
A pen pointer does not use this flag.
A mouse pointer has this flag set when the second extended mouse (XBUTTON2) button is down.
kFlagFirstButton &h10 Indicates a primary action, analogous to a left mouse button down.
A touch pointer has this flag set when it is in contact with the digitizer surface.
A pen pointer has this flag set when it is in contact with the digitizer surface with no buttons pressed.
A mouse pointer has this flag set when the left mouse button is down.
kFlagFourthButton &h80 Analogous to a first extended mouse (XButton1) button down.
A touch pointer does not use this flag.
A pen pointer does not use this flag.
A mouse pointer has this flag set when the first extended mouse (XBUTTON1) button is down.
kFlagHasTransform &h400000 Indicates that this pointer has an associated transform.
kFlagHWheel &h100000 Indicates input associated with a pointer h-wheel. For mouse pointers, this is equivalent to the action of the mouse horizontal scroll wheel.
kFlagInContact 4 Indicates that this pointer is in contact with the digitizer surface.
When this flag is not set, it indicates a hovering pointer.
kFlagInRange 2 Indicates that this pointer continues to exist. When this flag is not set, it indicates the pointer has left detection range.
This flag is typically not set only when a hovering pointer leaves detection range (kFlagUpdate is set) or when a pointer in contact with a window surface leaves detection range (kFlagUp is set).
kFlagNew 1 Indicates the arrival of a new pointer.
kFlagNone 0 Default
kFlagPrimary &h2000 Indicates that this pointer has been designated as the primary pointer. A primary pointer is a single pointer that can perform actions beyond those available to non-primary pointers. For example, when a primary pointer makes contact with a window’s surface, it may provide the window an opportunity to activate by sending it a PointerActivate event.
The primary pointer is identified from all current user interactions on the system (mouse, touch, pen, and so on). As such, the primary pointer might not be associated with your app. The first contact in a multi-touch interaction is set as the primary pointer. Once a primary pointer is identified, all contacts must be lifted before a new contact can be identified as a primary pointer. For apps that don't process pointer input, only the primary pointer's events are promoted to mouse events.
kFlagSecondButton &h20 Indicates a secondary action, analogous to a right mouse button down.
A touch pointer does not use this flag.
A pen pointer has this flag set when it is in contact with the digitizer surface with the pen barrel button pressed.
A mouse pointer has this flag set when the right mouse button is down.
kFlagThirdButton &h40 Analogous to a mouse wheel button down.
A touch pointer does not use this flag.
A pen pointer does not use this flag.
A mouse pointer has this flag set when the mouse wheel button is down.
kFlagUp &h40000 Indicates that this pointer transitioned to an up state; that is, contact with the digitizer surface ended.
kFlagUpdate &h20000 Indicates that this is a simple update that does not include pointer state changes.
kFlagWheel &h80000 Indicates input associated with a pointer wheel. For mouse pointers, this is equivalent to the action of the mouse scroll wheel.

Pointer Types

Constant Value Description
kTypeMouse 4 Mouse pointer type.
kTypePen 3 Pen pointer type.
kTypePointer 1 Generic pointer type.
This type never appears in pointer messages or pointer data. Some data query functions allow the caller to restrict the query to specific pointer type. The kTypePointer type can be used in these functions to specify that the query is to include pointers of all types
kTypeTouch 2 Touch pointer type.
kTypeTouchpad 5 Touchpad pointer type (Windows 8.1 and later).

This class has no sub classes.

Some events for this class:

Some examples which use this class:


The items on this page are in the following plugins: MBS Win Plugin.


WinPointerEventsMBS   -   WinSparkleMBS




Links
MBS Xojo Plugins