xref: /reactos/sdk/include/psdk/ntddmou.h (revision c2c66aff)
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 #pragma once
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 #define DD_MOUSE_DEVICE_NAME              "\\Device\\PointerClass"
30 #define DD_MOUSE_DEVICE_NAME_U            L"\\Device\\PointerClass"
31 
32 #define IOCTL_MOUSE_QUERY_ATTRIBUTES \
33   CTL_CODE(FILE_DEVICE_MOUSE, 0, METHOD_BUFFERED, FILE_ANY_ACCESS)
34 
35 #define IOCTL_MOUSE_INSERT_DATA \
36   CTL_CODE(FILE_DEVICE_MOUSE, 1, METHOD_BUFFERED, FILE_ANY_ACCESS)
37 
38 DEFINE_GUID(GUID_DEVINTERFACE_MOUSE, \
39   0x378de44c, 0x56ef, 0x11d1, 0xbc, 0x8c, 0x00, 0xa0, 0xc9, 0x14, 0x05, 0xdd);
40 
41 #define GUID_CLASS_MOUSE GUID_DEVINTERFACE_MOUSE /* Obsolete */
42 
43 #define MOUSE_ERROR_VALUE_BASE            20000
44 
45 /* MOUSE_INPUT_DATA.ButtonFlags constants */
46 #define MOUSE_LEFT_BUTTON_DOWN            0x0001
47 #define MOUSE_LEFT_BUTTON_UP              0x0002
48 #define MOUSE_RIGHT_BUTTON_DOWN           0x0004
49 #define MOUSE_RIGHT_BUTTON_UP             0x0008
50 #define MOUSE_MIDDLE_BUTTON_DOWN          0x0010
51 #define MOUSE_MIDDLE_BUTTON_UP            0x0020
52 #define MOUSE_BUTTON_4_DOWN               0x0040
53 #define MOUSE_BUTTON_4_UP                 0x0080
54 #define MOUSE_BUTTON_5_DOWN               0x0100
55 #define MOUSE_BUTTON_5_UP                 0x0200
56 #define MOUSE_WHEEL                       0x0400
57 #define MOUSE_HWHEEL                      0x0800
58 
59 #define MOUSE_BUTTON_1_DOWN               MOUSE_LEFT_BUTTON_DOWN
60 #define MOUSE_BUTTON_1_UP                 MOUSE_LEFT_BUTTON_UP
61 #define MOUSE_BUTTON_2_DOWN               MOUSE_RIGHT_BUTTON_DOWN
62 #define MOUSE_BUTTON_2_UP                 MOUSE_RIGHT_BUTTON_UP
63 #define MOUSE_BUTTON_3_DOWN               MOUSE_MIDDLE_BUTTON_DOWN
64 #define MOUSE_BUTTON_3_UP                 MOUSE_MIDDLE_BUTTON_UP
65 
66 /* MOUSE_INPUT_DATA.Flags constants */
67 #define MOUSE_MOVE_RELATIVE               0
68 #define MOUSE_MOVE_ABSOLUTE               1
69 #define MOUSE_VIRTUAL_DESKTOP             0x02
70 #define MOUSE_ATTRIBUTES_CHANGED          0x04
71 #if(_WIN32_WINNT >= 0x0600)
72 #define MOUSE_MOVE_NOCOALESCE             0x08
73 #endif
74 #define MOUSE_TERMSRV_SRC_SHADOW          0x100
75 
76 typedef struct _MOUSE_INPUT_DATA {
77   USHORT UnitId;
78   USHORT Flags;
79   __MINGW_EXTENSION union {
80     ULONG Buttons;
81     __MINGW_EXTENSION struct {
82       USHORT ButtonFlags;
83       USHORT ButtonData;
84     } DUMMYSTRUCTNAME;
85   } DUMMYUNIONNAME;
86   ULONG RawButtons;
87   LONG LastX;
88   LONG LastY;
89   ULONG ExtraInformation;
90 } MOUSE_INPUT_DATA, *PMOUSE_INPUT_DATA;
91 
92 typedef struct _MOUSE_UNIT_ID_PARAMETER {
93   USHORT UnitId;
94 } MOUSE_UNIT_ID_PARAMETER, *PMOUSE_UNIT_ID_PARAMETER;
95 
96 /* MOUSE_ATTRIBUTES.MouseIdentifier constants */
97 #define MOUSE_INPORT_HARDWARE             0x0001
98 #define MOUSE_I8042_HARDWARE              0x0002
99 #define MOUSE_SERIAL_HARDWARE             0x0004
100 #define BALLPOINT_I8042_HARDWARE          0x0008
101 #define BALLPOINT_SERIAL_HARDWARE         0x0010
102 #define WHEELMOUSE_I8042_HARDWARE         0x0020
103 #define WHEELMOUSE_SERIAL_HARDWARE        0x0040
104 #define MOUSE_HID_HARDWARE                0x0080
105 #define WHEELMOUSE_HID_HARDWARE           0x0100
106 #define HORIZONTAL_WHEEL_PRESENT          0x8000
107 
108 typedef struct _MOUSE_ATTRIBUTES {
109   USHORT MouseIdentifier;
110   USHORT NumberOfButtons;
111   USHORT SampleRate;
112   ULONG InputDataQueueLength;
113 } MOUSE_ATTRIBUTES, *PMOUSE_ATTRIBUTES;
114 
115 #ifdef __cplusplus
116 }
117 #endif
118