• 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   * @syscap SystemCapability.MiscServices.InputMethodFramework
34   * @since 9
35   */
36  readonly label?: string;
37
38  /**
39   * The label id of input method subtype.
40   *
41   * @type { ?number }
42   * @syscap SystemCapability.MiscServices.InputMethodFramework
43   * @since 10
44   */
45  readonly labelId?: number;
46
47  /**
48   * The name of input method.
49   *
50   * @type { string }
51   * @syscap SystemCapability.MiscServices.InputMethodFramework
52   * @since 9
53   */
54  readonly name: string;
55
56  /**
57   * The id of input method subtype.
58   *
59   * @type { string }
60   * @syscap SystemCapability.MiscServices.InputMethodFramework
61   * @since 9
62   */
63  readonly id: string;
64
65  /**
66   * The mode of input method subtype.
67   *
68   * @type { ?('upper' | 'lower') }
69   * @syscap SystemCapability.MiscServices.InputMethodFramework
70   * @since 9
71   */
72  readonly mode?: 'upper' | 'lower';
73
74  /**
75   * The locale of input method subtype.
76   *
77   * @type { string }
78   * @syscap SystemCapability.MiscServices.InputMethodFramework
79   * @since 9
80   */
81  readonly locale: string;
82
83  /**
84   * The language of input method subtype.
85   *
86   * @type { string }
87   * @syscap SystemCapability.MiscServices.InputMethodFramework
88   * @since 9
89   */
90  readonly language: string;
91
92  /**
93   * The icon of input method subtype.
94   *
95   * @type { ?string }
96   * @syscap SystemCapability.MiscServices.InputMethodFramework
97   * @since 9
98   */
99  readonly icon?: string;
100
101  /**
102   * The icon id of input method subtype.
103   *
104   * @type { ?number }
105   * @syscap SystemCapability.MiscServices.InputMethodFramework
106   * @since 9
107   */
108  readonly iconId?: number;
109
110  /**
111   * The extra info of input method subtype.
112   *
113   * @type { object }
114   * @syscap SystemCapability.MiscServices.InputMethodFramework
115   * @since 9
116   */
117  /**
118   * The extra info of input method subtype.
119   *
120   * @type { ?object }
121   * @syscap SystemCapability.MiscServices.InputMethodFramework
122   * @since 10
123   */
124  extra?: object;
125}