include/ddk/ntddmou.h

   1 /*
   2  * ntddmou.h
   3  *
   4  * Mouse device IOCTL interface.
   5  *
   6  * This file is part of the w32api package.
   7  *
   8  * Contributors:
   9  *   Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
  10  *
  11  * THIS SOFTWARE IS NOT COPYRIGHTED
  12  *
  13  * This source code is offered for use in the public domain. You may
  14  * use, modify or distribute it freely.
  15  *
  16  * This code is distributed in the hope that it will be useful but
  17  * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  18  * DISCLAIMED. This includes but is not limited to warranties of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20  *
  21  */
  22
  23 #ifndef __NTDDMOU_H
  24 #define __NTDDMOU_H
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 #define DD_MOUSE_DEVICE_NAME              "\\Device\\PointerClass"
  31 #define DD_MOUSE_DEVICE_NAME_U            L"\\Device\\PointerClass"
  32
  33 #define IOCTL_MOUSE_QUERY_ATTRIBUTES \
  34   CTL_CODE(FILE_DEVICE_MOUSE, 0, METHOD_BUFFERED, FILE_ANY_ACCESS)
  35
  36 DEFINE_GUID(GUID_DEVINTERFACE_MOUSE, \
  37   0x378de44c, 0x56ef, 0x11d1, 0xbc, 0x8c, 0x00, 0xa0, 0xc9, 0x14, 0x05, 0xdd);
  38
  39 #define MOUSE_ERROR_VALUE_BASE            20000
  40
  41 /* MOUSE_INPUT_DATA.ButtonFlags constants */
  42 #define MOUSE_LEFT_BUTTON_DOWN            0x0001
  43 #define MOUSE_LEFT_BUTTON_UP              0x0002
  44 #define MOUSE_RIGHT_BUTTON_DOWN           0x0004
  45 #define MOUSE_RIGHT_BUTTON_UP             0x0008
  46 #define MOUSE_MIDDLE_BUTTON_DOWN          0x0010
  47 #define MOUSE_MIDDLE_BUTTON_UP            0x0020
  48 #define MOUSE_BUTTON_4_DOWN               0x0040
  49 #define MOUSE_BUTTON_4_UP                 0x0080
  50 #define MOUSE_BUTTON_5_DOWN               0x0100
  51 #define MOUSE_BUTTON_5_UP                 0x0200
  52 #define MOUSE_WHEEL                       0x0400
  53
  54 #define MOUSE_BUTTON_1_DOWN               MOUSE_LEFT_BUTTON_DOWN
  55 #define MOUSE_BUTTON_1_UP                 MOUSE_LEFT_BUTTON_UP
  56 #define MOUSE_BUTTON_2_DOWN               MOUSE_RIGHT_BUTTON_DOWN
  57 #define MOUSE_BUTTON_2_UP                 MOUSE_RIGHT_BUTTON_UP
  58 #define MOUSE_BUTTON_3_DOWN               MOUSE_MIDDLE_BUTTON_DOWN
  59 #define MOUSE_BUTTON_3_UP                 MOUSE_MIDDLE_BUTTON_UP
  60
  61 /* MOUSE_INPUT_DATA.Flags constants */
  62 #define MOUSE_MOVE_RELATIVE               0
  63 #define MOUSE_MOVE_ABSOLUTE               1
  64 #define MOUSE_VIRTUAL_DESKTOP             0x02
  65 #define MOUSE_ATTRIBUTES_CHANGED          0x04
  66
  67 typedef struct _MOUSE_INPUT_DATA {
  68         USHORT  UnitId;
  69         USHORT  Flags;
  70         _ANONYMOUS_UNION union {
  71                 ULONG Buttons;
  72                 _ANONYMOUS_STRUCT struct  {
  73                         USHORT  ButtonFlags;
  74                         USHORT  ButtonData;
  75                 } DUMMYSTRUCTNAME;
  76         } DUMMYUNIONNAME;
  77         ULONG  RawButtons;
  78         LONG  LastX;
  79         LONG  LastY;
  80         ULONG  ExtraInformation;
  81 } MOUSE_INPUT_DATA, *PMOUSE_INPUT_DATA;
  82
  83 typedef struct _MOUSE_UNIT_ID_PARAMETER {
  84   USHORT  UnitId;
  85 } MOUSE_UNIT_ID_PARAMETER, *PMOUSE_UNIT_ID_PARAMETER;
  86
  87 /* MOUSE_ATTRIBUTES.MouseIdentifier constants */
  88 #define MOUSE_INPORT_HARDWARE             0x0001
  89 #define MOUSE_I8042_HARDWARE              0x0002
  90 #define MOUSE_SERIAL_HARDWARE             0x0004
  91 #define BALLPOINT_I8042_HARDWARE          0x0008
  92 #define BALLPOINT_SERIAL_HARDWARE         0x0010
  93 #define WHEELMOUSE_I8042_HARDWARE         0x0020
  94 #define WHEELMOUSE_SERIAL_HARDWARE        0x0040
  95 #define MOUSE_HID_HARDWARE                0x0080
  96 #define WHEELMOUSE_HID_HARDWARE           0x0100
  97
  98 typedef struct _MOUSE_ATTRIBUTES {
  99   USHORT  MouseIdentifier;
 100   USHORT  NumberOfButtons;
 101   USHORT  SampleRate;
 102   ULONG  InputDataQueueLength;
 103 } MOUSE_ATTRIBUTES, *PMOUSE_ATTRIBUTES;
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif
 108
 109 #endif /* __NTDDMOU_H */