1 /*
2  * Copyright (C) 2018 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.internal.inputmethod;
18 
19 import static java.lang.annotation.RetentionPolicy.SOURCE;
20 
21 import android.annotation.IntDef;
22 
23 import java.lang.annotation.Retention;
24 
25 /**
26  * Describes additional info in
27  * {@link com.android.internal.view.IInputMethodManager#startInputOrWindowGainedFocus}.
28  */
29 @Retention(SOURCE)
30 @IntDef(flag = true, value = {
31         StartInputFlags.VIEW_HAS_FOCUS,
32         StartInputFlags.IS_TEXT_EDITOR,
33         StartInputFlags.INITIAL_CONNECTION,
34         StartInputFlags.WINDOW_GAINED_FOCUS,
35 })
36 public @interface StartInputFlags {
37     /**
38      * There is a focused view in the focused window.
39      */
40     int VIEW_HAS_FOCUS = 1;
41 
42     /**
43      * The focused view is a text editor.
44      */
45     int IS_TEXT_EDITOR = 1 << 1;
46 
47     /**
48      * An internal concept to distinguish "start" and "restart". This concept doesn't look well
49      * documented hence we probably need to revisit this though.
50      */
51     int INITIAL_CONNECTION = 1 << 2;
52 
53     /**
54      * The start input happens when the window gained focus to call
55      * {@code android.view.inputmethod.InputMethodManager#startInputAsyncOnWindowFocusGain}.
56      */
57     int WINDOW_GAINED_FOCUS = 1 << 3;
58 }
59