• 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 * Load style of progress bar.
18 *
19 * @enum { number }
20 * @syscap SystemCapability.ArkUI.ArkUI.Full
21 * @since 8
22 */
23/**
24 * Load style of progress bar.
25 *
26 * @enum { number }
27 * @syscap SystemCapability.ArkUI.ArkUI.Full
28 * @since 9
29 * @form
30 */
31/**
32 * Load style of progress bar.
33 *
34 * @enum { number }
35 * @syscap SystemCapability.ArkUI.ArkUI.Full
36 * @crossplatform
37 * @since 10
38 * @form
39 */
40/**
41 * Load style of progress bar.
42 *
43 * @enum { number }
44 * @syscap SystemCapability.ArkUI.ArkUI.Full
45 * @crossplatform
46 * @atomicservice
47 * @since 11
48 * @form
49 */
50declare enum LoadingProgressStyle {
51  /**
52   * Default style.
53   *
54   * @syscap SystemCapability.ArkUI.ArkUI.Full
55   * @since 8
56   */
57  /**
58   * Default style.
59   *
60   * @syscap SystemCapability.ArkUI.ArkUI.Full
61   * @since 9
62   * @form
63   */
64  /**
65   * Default style.
66   *
67   * @syscap SystemCapability.ArkUI.ArkUI.Full
68   * @crossplatform
69   * @since 10
70   * @form
71   */
72  /**
73   * Default style.
74   *
75   * @syscap SystemCapability.ArkUI.ArkUI.Full
76   * @crossplatform
77   * @atomicservice
78   * @since 11
79   * @form
80   */
81  Default,
82
83  /**
84   * Announcement style.
85   *
86   * @syscap SystemCapability.ArkUI.ArkUI.Full
87   * @since 8
88   */
89  /**
90   * Announcement style.
91   *
92   * @syscap SystemCapability.ArkUI.ArkUI.Full
93   * @since 9
94   * @form
95   */
96  /**
97   * Announcement style.
98   *
99   * @syscap SystemCapability.ArkUI.ArkUI.Full
100   * @crossplatform
101   * @since 10
102   * @form
103   */
104  /**
105   * Announcement style.
106   *
107   * @syscap SystemCapability.ArkUI.ArkUI.Full
108   * @crossplatform
109   * @atomicservice
110   * @since 11
111   * @form
112   */
113  Circular,
114
115  /**
116   * The style of the track.
117   *
118   * @syscap SystemCapability.ArkUI.ArkUI.Full
119   * @since 8
120   */
121  /**
122   * The style of the track.
123   *
124   * @syscap SystemCapability.ArkUI.ArkUI.Full
125   * @since 9
126   * @form
127   */
128  /**
129   * The style of the track.
130   *
131   * @syscap SystemCapability.ArkUI.ArkUI.Full
132   * @crossplatform
133   * @since 10
134   * @form
135   */
136  /**
137   * The style of the track.
138   *
139   * @syscap SystemCapability.ArkUI.ArkUI.Full
140   * @crossplatform
141   * @atomicservice
142   * @since 11
143   * @form
144   */
145  Orbital,
146}
147
148/**
149 * Provides an interface for extending the loading progress.
150 *
151 * @interface LoadingProgressInterface
152 * @syscap SystemCapability.ArkUI.ArkUI.Full
153 * @since 8
154 */
155/**
156 * Provides an interface for extending the loading progress.
157 *
158 * @interface LoadingProgressInterface
159 * @syscap SystemCapability.ArkUI.ArkUI.Full
160 * @since 9
161 * @form
162 */
163/**
164 * Provides an interface for extending the loading progress.
165 *
166 * @interface LoadingProgressInterface
167 * @syscap SystemCapability.ArkUI.ArkUI.Full
168 * @crossplatform
169 * @since 10
170 * @form
171 */
172/**
173 * Provides an interface for extending the loading progress.
174 *
175 * @interface LoadingProgressInterface
176 * @syscap SystemCapability.ArkUI.ArkUI.Full
177 * @crossplatform
178 * @atomicservice
179 * @since 11
180 * @form
181 */
182interface LoadingProgressInterface {
183  /**
184   * Called when the progress bar progress is viewed.
185   *
186   * @returns { LoadingProgressAttribute }
187   * @syscap SystemCapability.ArkUI.ArkUI.Full
188   * @since 8
189   */
190  /**
191   * Called when the progress bar progress is viewed.
192   *
193   * @returns { LoadingProgressAttribute }
194   * @syscap SystemCapability.ArkUI.ArkUI.Full
195   * @since 9
196   * @form
197   */
198  /**
199   * Called when the progress bar progress is viewed.
200   *
201   * @returns { LoadingProgressAttribute }
202   * @syscap SystemCapability.ArkUI.ArkUI.Full
203   * @crossplatform
204   * @since 10
205   * @form
206   */
207  /**
208   * Called when the progress bar progress is viewed.
209   *
210   * @returns { LoadingProgressAttribute }
211   * @syscap SystemCapability.ArkUI.ArkUI.Full
212   * @crossplatform
213   * @atomicservice
214   * @since 11
215   * @form
216   */
217  (): LoadingProgressAttribute;
218}
219
220/**
221 * Declare the progress bar being loaded
222 *
223 * @extends CommonMethod<LoadingProgressAttribute>
224 * @syscap SystemCapability.ArkUI.ArkUI.Full
225 * @since 8
226 */
227/**
228 * Declare the progress bar being loaded
229 *
230 * @extends CommonMethod<LoadingProgressAttribute>
231 * @syscap SystemCapability.ArkUI.ArkUI.Full
232 * @since 9
233 * @form
234 */
235/**
236 * Declare the progress bar being loaded
237 *
238 * @extends CommonMethod<LoadingProgressAttribute>
239 * @syscap SystemCapability.ArkUI.ArkUI.Full
240 * @crossplatform
241 * @since 10
242 * @form
243 */
244/**
245 * Declare the progress bar being loaded
246 *
247 * @extends CommonMethod<LoadingProgressAttribute>
248 * @syscap SystemCapability.ArkUI.ArkUI.Full
249 * @crossplatform
250 * @atomicservice
251 * @since 11
252 * @form
253 */
254declare class LoadingProgressAttribute extends CommonMethod<LoadingProgressAttribute> {
255  /**
256   * Load the color of the progress bar.
257   *
258   * @param { ResourceColor } value
259   * @returns { LoadingProgressAttribute }
260   * @syscap SystemCapability.ArkUI.ArkUI.Full
261   * @since 8
262   */
263  /**
264   * Load the color of the progress bar.
265   *
266   * @param { ResourceColor } value
267   * @returns { LoadingProgressAttribute }
268   * @syscap SystemCapability.ArkUI.ArkUI.Full
269   * @since 9
270   * @form
271   */
272  /**
273   * Load the color of the progress bar.
274   *
275   * @param { ResourceColor } value
276   * @returns { LoadingProgressAttribute }
277   * @syscap SystemCapability.ArkUI.ArkUI.Full
278   * @crossplatform
279   * @since 10
280   * @form
281   */
282  /**
283   * Load the color of the progress bar.
284   *
285   * @param { ResourceColor } value
286   * @returns { LoadingProgressAttribute }
287   * @syscap SystemCapability.ArkUI.ArkUI.Full
288   * @crossplatform
289   * @atomicservice
290   * @since 11
291   * @form
292   */
293  color(value: ResourceColor): LoadingProgressAttribute;
294
295  /**
296   * Whether to display the LoadingProgress content.
297   *
298   * @param { boolean } value - indicates the state of LoadingProgress content
299   * @returns { LoadingProgressAttribute } the attribute of the LoadingProgress.
300   * @syscap SystemCapability.ArkUI.ArkUI.Full
301   * @crossplatform
302   * @since 10
303   */
304  /**
305   * Whether to display the LoadingProgress content.
306   *
307   * @param { boolean } value - indicates the state of LoadingProgress content
308   * @returns { LoadingProgressAttribute } the attribute of the LoadingProgress.
309   * @syscap SystemCapability.ArkUI.ArkUI.Full
310   * @crossplatform
311   * @atomicservice
312   * @since 11
313   */
314  enableLoading(value: boolean): LoadingProgressAttribute;
315}
316
317/**
318 * Defines LoadingProgress Component.
319 *
320 * @syscap SystemCapability.ArkUI.ArkUI.Full
321 * @since 8
322 */
323/**
324 * Defines LoadingProgress Component.
325 *
326 * @syscap SystemCapability.ArkUI.ArkUI.Full
327 * @since 9
328 * @form
329 */
330/**
331 * Defines LoadingProgress Component.
332 *
333 * @syscap SystemCapability.ArkUI.ArkUI.Full
334 * @crossplatform
335 * @since 10
336 * @form
337 */
338/**
339 * Defines LoadingProgress Component.
340 *
341 * @syscap SystemCapability.ArkUI.ArkUI.Full
342 * @crossplatform
343 * @atomicservice
344 * @since 11
345 * @form
346 */
347declare const LoadingProgress: LoadingProgressInterface;
348
349/**
350 * Loading Progress Extensions on Declarative Classes
351 *
352 * @syscap SystemCapability.ArkUI.ArkUI.Full
353 * @since 8
354 */
355/**
356 * Loading Progress Extensions on Declarative Classes
357 *
358 * @syscap SystemCapability.ArkUI.ArkUI.Full
359 * @since 9
360 * @form
361 */
362/**
363 * Loading Progress Extensions on Declarative Classes
364 *
365 * @syscap SystemCapability.ArkUI.ArkUI.Full
366 * @crossplatform
367 * @since 10
368 * @form
369 */
370/**
371 * Loading Progress Extensions on Declarative Classes
372 *
373 * @syscap SystemCapability.ArkUI.ArkUI.Full
374 * @crossplatform
375 * @atomicservice
376 * @since 11
377 * @form
378 */
379declare const LoadingProgressInstance: LoadingProgressAttribute;
380