• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2022 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @file
18 * @kit IMEKit
19 */
20
21/**
22 * Input method subtype
23 *
24 * @interface InputMethodSubtype
25 * @syscap SystemCapability.MiscServices.InputMethodFramework
26 * @since 9
27 */
28export default interface InputMethodSubtype {
29  /**
30   * The label of input method subtype.
31   *
32   * @type { ?string }
33   * @readonly
34   * @syscap SystemCapability.MiscServices.InputMethodFramework
35   * @since 9
36   */
37  readonly label?: string;
38
39  /**
40   * The label id of input method subtype.
41   *
42   * @type { ?number }
43   * @readonly
44   * @syscap SystemCapability.MiscServices.InputMethodFramework
45   * @since 10
46   */
47  readonly labelId?: number;
48
49  /**
50   * The name of input method.
51   *
52   * @type { string }
53   * @readonly
54   * @syscap SystemCapability.MiscServices.InputMethodFramework
55   * @since 9
56   */
57  readonly name: string;
58
59  /**
60   * The id of input method subtype.
61   *
62   * @type { string }
63   * @readonly
64   * @syscap SystemCapability.MiscServices.InputMethodFramework
65   * @since 9
66   */
67  readonly id: string;
68
69  /**
70   * The mode of input method subtype.
71   *
72   * @type { ?('upper' | 'lower') }
73   * @readonly
74   * @syscap SystemCapability.MiscServices.InputMethodFramework
75   * @since 9
76   */
77  readonly mode?: 'upper' | 'lower';
78
79  /**
80   * The locale of input method subtype.
81   *
82   * @type { string }
83   * @readonly
84   * @syscap SystemCapability.MiscServices.InputMethodFramework
85   * @since 9
86   */
87  readonly locale: string;
88
89  /**
90   * The language of input method subtype.
91   *
92   * @type { string }
93   * @readonly
94   * @syscap SystemCapability.MiscServices.InputMethodFramework
95   * @since 9
96   */
97  readonly language: string;
98
99  /**
100   * The icon of input method subtype.
101   *
102   * @type { ?string }
103   * @readonly
104   * @syscap SystemCapability.MiscServices.InputMethodFramework
105   * @since 9
106   */
107  readonly icon?: string;
108
109  /**
110   * The icon id of input method subtype.
111   *
112   * @type { ?number }
113   * @readonly
114   * @syscap SystemCapability.MiscServices.InputMethodFramework
115   * @since 9
116   */
117  readonly iconId?: number;
118
119  /**
120   * The extra info of input method subtype.
121   *
122   * @type { object }
123   * @syscap SystemCapability.MiscServices.InputMethodFramework
124   * @since 9
125   */
126  /**
127   * The extra info of input method subtype.
128   *
129   * @type { ?object }
130   * @syscap SystemCapability.MiscServices.InputMethodFramework
131   * @since 10
132   */
133  extra?: object;
134}