• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2  * Copyright (c) 2021-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 * Provides methods for control pattern lock component.
18 *
19 * @since 9
20 */
21/**
22 * Provides methods for control pattern lock component.
23 *
24 * @crossplatform
25 * @since 10
26 */
27declare class PatternLockController {
28  /**
29   * constructor.
30   *
31   * @syscap SystemCapability.ArkUI.ArkUI.Full
32   * @since 9
33   */
34  /**
35   * constructor.
36   *
37   * @syscap SystemCapability.ArkUI.ArkUI.Full
38   * @crossplatform
39   * @since 10
40   */
41  constructor();
42
43  /**
44   * Reset pattern lock.
45   *
46   * @syscap SystemCapability.ArkUI.ArkUI.Full
47   * @since 9
48   */
49  /**
50   * Reset pattern lock.
51   *
52   * @syscap SystemCapability.ArkUI.ArkUI.Full
53   * @crossplatform
54   * @since 10
55   */
56  reset();
57}
58
59/**
60 * Provides an interface for generating PatternLock.
61 *
62 * @interface PatternLockInterface
63 * @syscap SystemCapability.ArkUI.ArkUI.Full
64 * @since 9
65 */
66/**
67 * Provides an interface for generating PatternLock.
68 *
69 * @interface PatternLockInterface
70 * @syscap SystemCapability.ArkUI.ArkUI.Full
71 * @crossplatform
72 * @since 10
73 */
74interface PatternLockInterface {
75  (controller?: PatternLockController): PatternLockAttribute;
76}
77
78/**
79 * Provides methods for attribute pattern lock component.
80 *
81 * @extends CommonMethod
82 * @syscap SystemCapability.ArkUI.ArkUI.Full
83 * @since 9
84 */
85/**
86 * Provides methods for attribute pattern lock component.
87 *
88 * @extends CommonMethod
89 * @syscap SystemCapability.ArkUI.ArkUI.Full
90 * @crossplatform
91 * @since 10
92 */
93declare class PatternLockAttribute extends CommonMethod<PatternLockAttribute> {
94  /**
95   * The square side length of pattern lock component.
96   *
97   * @param { Length } value
98   * @returns { PatternLockAttribute }
99   * @syscap SystemCapability.ArkUI.ArkUI.Full
100   * @since 9
101   */
102  /**
103   * The square side length of pattern lock component.
104   *
105   * @param { Length } value
106   * @returns { PatternLockAttribute }
107   * @syscap SystemCapability.ArkUI.ArkUI.Full
108   * @crossplatform
109   * @since 10
110   */
111  sideLength(value: Length): PatternLockAttribute;
112
113  /**
114   * Circle radius.
115   *
116   * @param { Length } value
117   * @returns { PatternLockAttribute }
118   * @syscap SystemCapability.ArkUI.ArkUI.Full
119   * @since 9
120   */
121  /**
122   * Circle radius.
123   *
124   * @param { Length } value
125   * @returns { PatternLockAttribute }
126   * @syscap SystemCapability.ArkUI.ArkUI.Full
127   * @crossplatform
128   * @since 10
129   */
130  circleRadius(value: Length): PatternLockAttribute;
131
132  /**
133   * The background color.
134   *
135   * @param { ResourceColor } value
136   * @returns { PatternLockAttribute }
137   * @syscap SystemCapability.ArkUI.ArkUI.Full
138   * @since 9
139   */
140  /**
141   * The background color.
142   *
143   * @param { ResourceColor } value
144   * @returns { PatternLockAttribute }
145   * @syscap SystemCapability.ArkUI.ArkUI.Full
146   * @crossplatform
147   * @since 10
148   */
149  backgroundColor(value: ResourceColor): PatternLockAttribute;
150
151  /**
152   * Regular color.
153   *
154   * @param { ResourceColor } value
155   * @returns { PatternLockAttribute }
156   * @syscap SystemCapability.ArkUI.ArkUI.Full
157   * @since 9
158   */
159  /**
160   * Regular color.
161   *
162   * @param { ResourceColor } value
163   * @returns { PatternLockAttribute }
164   * @syscap SystemCapability.ArkUI.ArkUI.Full
165   * @crossplatform
166   * @since 10
167   */
168  regularColor(value: ResourceColor): PatternLockAttribute;
169
170  /**
171   * The color when cell is selected.
172   *
173   * @param { ResourceColor } value
174   * @returns { PatternLockAttribute }
175   * @syscap SystemCapability.ArkUI.ArkUI.Full
176   * @since 9
177   */
178  /**
179   * The color when cell is selected.
180   *
181   * @param { ResourceColor } value
182   * @returns { PatternLockAttribute }
183   * @syscap SystemCapability.ArkUI.ArkUI.Full
184   * @crossplatform
185   * @since 10
186   */
187  selectedColor(value: ResourceColor): PatternLockAttribute;
188
189  /**
190   * The color when cell is active state.
191   *
192   * @param { ResourceColor } value
193   * @returns { PatternLockAttribute }
194   * @syscap SystemCapability.ArkUI.ArkUI.Full
195   * @since 9
196   */
197  /**
198   * The color when cell is active state.
199   *
200   * @param { ResourceColor } value
201   * @returns { PatternLockAttribute }
202   * @syscap SystemCapability.ArkUI.ArkUI.Full
203   * @crossplatform
204   * @since 10
205   */
206  activeColor(value: ResourceColor): PatternLockAttribute;
207
208  /**
209   * The path line color.
210   *
211   * @param { ResourceColor } value
212   * @returns { PatternLockAttribute }
213   * @syscap SystemCapability.ArkUI.ArkUI.Full
214   * @since 9
215   */
216  /**
217   * The path line color.
218   *
219   * @param { ResourceColor } value
220   * @returns { PatternLockAttribute }
221   * @syscap SystemCapability.ArkUI.ArkUI.Full
222   * @crossplatform
223   * @since 10
224   */
225  pathColor(value: ResourceColor): PatternLockAttribute;
226
227  /**
228   * The path line stroke width.
229   *
230   * @param { number | string } value
231   * @returns { PatternLockAttribute }
232   * @syscap SystemCapability.ArkUI.ArkUI.Full
233   * @since 9
234   */
235  /**
236   * The path line stroke width.
237   *
238   * @param { number | string } value
239   * @returns { PatternLockAttribute }
240   * @syscap SystemCapability.ArkUI.ArkUI.Full
241   * @crossplatform
242   * @since 10
243   */
244  pathStrokeWidth(value: number | string): PatternLockAttribute;
245
246  /**
247   * Called when the pattern input completed.
248   *
249   * @param { function } callback
250   * @returns { PatternLockAttribute }
251   * @syscap SystemCapability.ArkUI.ArkUI.Full
252   * @since 9
253   */
254  /**
255   * Called when the pattern input completed.
256   *
257   * @param { function } callback
258   * @returns { PatternLockAttribute }
259   * @syscap SystemCapability.ArkUI.ArkUI.Full
260   * @crossplatform
261   * @since 10
262   */
263  onPatternComplete(callback: (input: Array<number>) => void): PatternLockAttribute;
264
265  /**
266   * Called when judging whether the input state can be reset by touch pattern lock.
267   *
268   * @param { boolean } value
269   * @returns { PatternLockAttribute }
270   * @syscap SystemCapability.ArkUI.ArkUI.Full
271   * @since 9
272   */
273  /**
274   * Called when judging whether the input state can be reset by touch pattern lock.
275   *
276   * @param { boolean } value
277   * @returns { PatternLockAttribute }
278   * @syscap SystemCapability.ArkUI.ArkUI.Full
279   * @crossplatform
280   * @since 10
281   */
282  autoReset(value: boolean): PatternLockAttribute;
283}
284
285/**
286 * Defines PatternLock Component.
287 *
288 * @syscap SystemCapability.ArkUI.ArkUI.Full
289 * @since 9
290 */
291/**
292 * Defines PatternLock Component.
293 *
294 * @syscap SystemCapability.ArkUI.ArkUI.Full
295 * @crossplatform
296 * @since 10
297 */
298declare const PatternLock: PatternLockInterface;
299
300/**
301 * Defines PatternLock Component instance.
302 *
303 * @syscap SystemCapability.ArkUI.ArkUI.Full
304 * @since 9
305 */
306/**
307 * Defines PatternLock Component instance.
308 *
309 * @syscap SystemCapability.ArkUI.ArkUI.Full
310 * @crossplatform
311 * @since 10
312 */
313declare const PatternLockInstance: PatternLockAttribute;
314