1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/*
* Copyright (C) 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.hardware.input;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;
import android.view.MotionEvent;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* An event describing a mouse button click interaction originating from a remote device.
*
* @hide
*/
@SystemApi
public final class VirtualMouseButtonEvent implements Parcelable {
/** @hide */
public static final int ACTION_UNKNOWN = -1;
/** Action indicating the mouse button has been pressed. */
public static final int ACTION_BUTTON_PRESS = MotionEvent.ACTION_BUTTON_PRESS;
/** Action indicating the mouse button has been released. */
public static final int ACTION_BUTTON_RELEASE = MotionEvent.ACTION_BUTTON_RELEASE;
/** @hide */
@IntDef(prefix = {"ACTION_"}, value = {
ACTION_UNKNOWN,
ACTION_BUTTON_PRESS,
ACTION_BUTTON_RELEASE,
})
@Retention(RetentionPolicy.SOURCE)
public @interface Action {}
/** @hide */
public static final int BUTTON_UNKNOWN = -1;
/** Action indicating the mouse button involved in this event is in the left position. */
public static final int BUTTON_PRIMARY = MotionEvent.BUTTON_PRIMARY;
/** Action indicating the mouse button involved in this event is in the middle position. */
public static final int BUTTON_TERTIARY = MotionEvent.BUTTON_TERTIARY;
/** Action indicating the mouse button involved in this event is in the right position. */
public static final int BUTTON_SECONDARY = MotionEvent.BUTTON_SECONDARY;
/**
* Action indicating the mouse button involved in this event is intended to go back to the
* previous.
*/
public static final int BUTTON_BACK = MotionEvent.BUTTON_BACK;
/**
* Action indicating the mouse button involved in this event is intended to move forward to the
* next.
*/
public static final int BUTTON_FORWARD = MotionEvent.BUTTON_FORWARD;
/** @hide */
@IntDef(prefix = {"BUTTON_"}, value = {
BUTTON_UNKNOWN,
BUTTON_PRIMARY,
BUTTON_TERTIARY,
BUTTON_SECONDARY,
BUTTON_BACK,
BUTTON_FORWARD,
})
@Retention(RetentionPolicy.SOURCE)
public @interface Button {}
private final @Action int mAction;
private final @Button int mButtonCode;
private VirtualMouseButtonEvent(@Action int action, @Button int buttonCode) {
mAction = action;
mButtonCode = buttonCode;
}
private VirtualMouseButtonEvent(@NonNull Parcel parcel) {
mAction = parcel.readInt();
mButtonCode = parcel.readInt();
}
@Override
public void writeToParcel(@NonNull Parcel parcel, int parcelableFlags) {
parcel.writeInt(mAction);
parcel.writeInt(mButtonCode);
}
@Override
public int describeContents() {
return 0;
}
/**
* Returns the button code associated with this event.
*/
public @Button int getButtonCode() {
return mButtonCode;
}
/**
* Returns the action associated with this event.
*/
public @Action int getAction() {
return mAction;
}
/**
* Builder for {@link VirtualMouseButtonEvent}.
*/
public static final class Builder {
private @Action int mAction = ACTION_UNKNOWN;
private @Button int mButtonCode = -1;
/**
* Creates a {@link VirtualMouseButtonEvent} object with the current builder configuration.
*/
public @NonNull VirtualMouseButtonEvent build() {
if (mAction == ACTION_UNKNOWN || mButtonCode == -1) {
throw new IllegalArgumentException(
"Cannot build virtual mouse button event with unset fields");
}
return new VirtualMouseButtonEvent(mAction, mButtonCode);
}
/**
* Sets the button code of the event.
*
* @return this builder, to allow for chaining of calls
*/
public @NonNull Builder setButtonCode(int buttonCode) {
if (buttonCode != BUTTON_PRIMARY
&& buttonCode != BUTTON_TERTIARY
&& buttonCode != BUTTON_SECONDARY
&& buttonCode != BUTTON_BACK
&& buttonCode != BUTTON_FORWARD) {
throw new IllegalArgumentException("Unsupported mouse button code");
}
mButtonCode = buttonCode;
return this;
}
/**
* Sets the action of the event.
*
* @return this builder, to allow for chaining of calls
*/
public @NonNull Builder setAction(@Action int action) {
if (action != ACTION_BUTTON_PRESS && action != ACTION_BUTTON_RELEASE) {
throw new IllegalArgumentException("Unsupported mouse button action type");
}
mAction = action;
return this;
}
}
public static final @NonNull Parcelable.Creator<VirtualMouseButtonEvent> CREATOR =
new Parcelable.Creator<VirtualMouseButtonEvent>() {
public VirtualMouseButtonEvent createFromParcel(Parcel source) {
return new VirtualMouseButtonEvent(source);
}
public VirtualMouseButtonEvent[] newArray(int size) {
return new VirtualMouseButtonEvent[size];
}
};
}
|
