• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2023 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 * Define pattern options of keyboard.
23 *
24 * @interface PatternOptions
25 * @syscap SystemCapability.MiscServices.InputMethodFramework
26 * @since 11
27 */
28export interface PatternOptions {
29  /**
30   * The default selected pattern, The defaultSelected will default to 0 if left blank
31   *
32   * @type { number }
33   * @syscap SystemCapability.MiscServices.InputMethodFramework
34   * @since 11
35   */
36  defaultSelected?: number;
37  /**
38   * the patterns of input method.
39   *
40   * @type { Array<Pattern> }
41   * @syscap SystemCapability.MiscServices.InputMethodFramework
42   * @since 11
43   */
44  patterns: Array<Pattern>;
45  /**
46   * An action callback. When the pattern icon clicked, the callback will be invoked.
47   *
48   * @type { function }
49   * @syscap SystemCapability.MiscServices.InputMethodFramework
50   * @since 11
51   */
52  action: (index: number) => void;
53}
54
55/**
56 * Define pattern of keyboard. The caller must be the current inputmethod.
57 *
58 * @interface Pattern
59 * @syscap SystemCapability.MiscServices.InputMethodFramework
60 * @since 11
61 */
62export interface Pattern {
63  /**
64   * The icon resource of pattern.
65   *
66   * @type { Resource }
67   * @syscap SystemCapability.MiscServices.InputMethodFramework
68   * @since 11
69   */
70  icon: Resource;
71  /**
72   * The selected icon resource of pattern.
73   *
74   * @type { Resource }
75   * @syscap SystemCapability.MiscServices.InputMethodFramework
76   * @since 11
77   */
78  selectedIcon: Resource;
79}
80
81/**
82 * Declare input method list dialog. The caller must be the current inputmethod.
83 *
84 * @syscap SystemCapability.MiscServices.InputMethodFramework
85 * @since 11
86 */
87@CustomDialog
88export declare struct InputMethodListDialog {
89  /**
90   * Sets the controller.
91   *
92   * @type { CustomDialogController }
93   * @syscap SystemCapability.MiscServices.InputMethodFramework
94   * @since 11
95   */
96  controller: CustomDialogController;
97  /**
98   * Sets the pattern options. This parameter can be left blank when it is not default input method.
99   *
100   * @type { PatternOptions }
101   * @syscap SystemCapability.MiscServices.InputMethodFramework
102   * @since 11
103   */
104  patternOptions?: PatternOptions;
105}