• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# oh_axis_type.h
2
3<!--Kit: Input Kit-->
4<!--Subsystem: MultimodalInput-->
5<!--Owner: @zhaoxueyuan-->
6<!--Designer: @hanruofei-->
7<!--Tester: @Lyuxin-->
8<!--Adviser: @Brilliantry_Rui-->
9
10## Overview
11
12Defines the axis event structures and enumerations.
13
14**File to include**: <multimodalinput/oh_axis_type.h>
15
16**Library**: libohinput.so
17
18**System capability**: SystemCapability.MultimodalInput.Input.Core
19
20**Since**: 12
21
22**Related module**: [input](capi-input.md)
23
24## Summary
25
26### Enums
27
28| **Name**| typedef Keyword| Description|
29| -- | -- | -- |
30| [InputEvent_AxisType](#inputevent_axistype) | InputEvent_AxisType | Provides axis types of the input device.|
31| [InputEvent_AxisEventType](#inputevent_axiseventtype) | InputEvent_AxisEventType | Provides event types of the input device.|
32| [InputEvent_AxisAction](#inputevent_axisaction) | InputEvent_AxisAction | Provides actions of the input device.|
33
34## Enum Description
35
36### InputEvent_AxisType
37
38```
39enum InputEvent_AxisType
40```
41
42**Description**
43
44Defines the axis type of an input device.
45
46**Since**: 12
47
48| Enum| Description            |
49| -- |----------------|
50| AXIS_TYPE_UNKNOWN | Unknown axis type, which is usually used as the initial value.|
51| AXIS_TYPE_SCROLL_VERTICAL | Vertical scroll axis. When you scroll the mouse wheel or slide with one or two fingers on the touchpad, the status of the vertical scroll axis changes.              |
52| AXIS_TYPE_SCROLL_HORIZONTAL | Horizontal scroll axis. When you scroll the mouse wheel or slide with two fingers on the touchpad, the status of the horizontal scroll axis changes.              |
53| AXIS_TYPE_PINCH | Pinch axis, which is used to describe a two-finger pinch gesture on the touchpad.              |
54| AXIS_TYPE_ROTATE | Rotation axis, which is used to describe a two-finger rotation gesture on the touchpad.              |
55
56### InputEvent_AxisEventType
57
58```
59enum InputEvent_AxisEventType
60```
61
62**Description**
63
64Event type of the input device.
65
66**Since**: 12
67
68| Enum| Description|
69| -- | -- |
70| AXIS_EVENT_TYPE_PINCH = 1 | Two-finger pinch event. The value can be **AXIS_TYPE_PINCH** or **AXIS_TYPE_ROTATE**.		<br>**Since**: 12|
71| AXIS_EVENT_TYPE_SCROLL = 2 | Scroll axis event. The value can be **AXIS_TYPE_SCROLL_VERTICAL** and **AXIS_TYPE_SCROLL_HORIZONTAL**. For mouse wheel events, the value can only be **AXIS_TYPE_SCROLL_VERTICAL**.		<br>**Since**: 12|
72
73### InputEvent_AxisAction
74
75```
76enum InputEvent_AxisAction
77```
78
79**Description**
80
81Action of the input device.
82
83**Since**: 12
84
85| Enum| Description|
86| -- | -- |
87| AXIS_ACTION_CANCEL = 0 | Cancellation of an axis input event.|
88| AXIS_ACTION_BEGIN | Start of an axis input event.|
89| AXIS_ACTION_UPDATE | Update of an axis input event.|
90| AXIS_ACTION_END | End of an axis input event.|
91