POINTER_FLAGS enumeration

  • Article

[This documentation is preliminary and is subject to change.]

Lists the pointer flags that may appear in the pointerFlags field of the POINTER_INFO structure.

Syntax

typedef enum tagPOINTER_FLAGS {
  POINTER_FLAG_NONE           = 0x00000000,
  POINTER_FLAG_NEW            = 0x00000001,
  POINTER_FLAG_INRANGE        = 0x00000002,
  POINTER_FLAG_INCONTACT      = 0x00000004,
  POINTER_FLAG_FIRSTBUTTON    = 0x00000010,
  POINTER_FLAG_SECONDBUTTON   = 0x00000020,
  POINTER_FLAG_THIRDBUTTON    = 0x00000040,
  POINTER_FLAG_OTHERBUTTON    = 0x00000080,
  POINTER_FLAG_PRIMARY        = 0x00000100,
  POINTER_FLAG_CONFIDENCE     = 0x00000200,
  POINTER_FLAG_CANCELLED      = 0x00000400,
  POINTER_FLAG_DOWN           = 0x00010000,
  POINTER_FLAG_UPDATE         = 0x00020000,
  POINTER_FLAG_UP             = 0x00040000,
  POINTER_FLAG_WHEEL          = 0x00080000,
  POINTER_FLAG_HWHEEL         = 0x00100000 
} POINTER_FLAGS;

Constants

  • POINTER_FLAG_NONE
    Default

  • POINTER_FLAG_NEW
    Indicates the arrival of a new pointer.

  • POINTER_FLAG_INRANGE
    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 (POINTER_FLAG_UPDATE is set) or when a pointer in contact with a window surface leaves detection range (POINTER_FLAG_UP is set).

  • POINTER_FLAG_INCONTACT
    Indicates that this pointer is in contact with the window surface. When this flag is not set, it indicates a hovering pointer.

  • POINTER_FLAG_FIRSTBUTTON
    Indicates a primary action, analogous to a mouse left 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 mouse left button is down.

  • POINTER_FLAG_SECONDBUTTON
    Indicates a secondary action, analogous to a mouse right 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 mouse right button is down.

  • POINTER_FLAG_THIRDBUTTON
    Indicates a secondary action, analogous to a mouse right 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 middle button is down.

  • POINTER_FLAG_OTHERBUTTON
    Indicates actions of one or more buttons beyond those listed above, dependent on the pointer type. Applications that wish to respond to these actions must retrieve information specific to the pointer type to determine which 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.

  • POINTER_FLAG_PRIMARY
    Indicates that this pointer has been designated as primary. A primary pointer may 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 WM_POINTERACTIVATE message.

  • POINTER_FLAG_CONFIDENCE
    Confidence is a suggestion from the source device about whether the pointer represents an intended or accidental interaction, which is especially relevant for PT_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.

  • POINTER_FLAG_CANCELLED
    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.

  • POINTER_FLAG_DOWN
    Indicates that this pointer just transitioned to a “down” state; that is, it made contact with the window surface.

  • POINTER_FLAG_UPDATE
    Indicates that this information provides a simple update that does not include pointer state changes.

  • POINTER_FLAG_UP
    Indicates that this pointer just transitioned to an “up” state; that is, it broke contact with the window surface.

  • POINTER_FLAG_WHEEL
    Indicates input associated with a pointer wheel. For mouse pointers, this is equivalent to the action of the mouse scroll wheel (WM_MOUSEWHEEL).

  • POINTER_FLAG_HWHEEL
    Indicates input associated with a pointer h-wheel. For mouse pointers, this is equivalent to the action of the mouse horizontal scroll wheel (WM_MOUSEHWHEEL).

Requirements

Minimum supported client

 Windows Developer Preview

Minimum supported server

 Windows Server Developer Preview

Header

 Winuser.h (include Windows.h)

 

 

Build date: 9/14/2011