• 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 */
40declare enum LoadingProgressStyle {
41  /**
42   * Default style.
43   *
44   * @syscap SystemCapability.ArkUI.ArkUI.Full
45   * @since 8
46   */
47  /**
48   * Default style.
49   *
50   * @syscap SystemCapability.ArkUI.ArkUI.Full
51   * @since 9
52   * @form
53   */
54  /**
55   * Default style.
56   *
57   * @syscap SystemCapability.ArkUI.ArkUI.Full
58   * @crossplatform
59   * @since 10
60   * @form
61   */
62  Default,
63
64  /**
65   * Announcement style.
66   *
67   * @syscap SystemCapability.ArkUI.ArkUI.Full
68   * @since 8
69   */
70  /**
71   * Announcement style.
72   *
73   * @syscap SystemCapability.ArkUI.ArkUI.Full
74   * @since 9
75   * @form
76   */
77  /**
78   * Announcement style.
79   *
80   * @syscap SystemCapability.ArkUI.ArkUI.Full
81   * @crossplatform
82   * @since 10
83   * @form
84   */
85  Circular,
86
87  /**
88   * The style of the track.
89   *
90   * @syscap SystemCapability.ArkUI.ArkUI.Full
91   * @since 8
92   */
93  /**
94   * The style of the track.
95   *
96   * @syscap SystemCapability.ArkUI.ArkUI.Full
97   * @since 9
98   * @form
99   */
100  /**
101   * The style of the track.
102   *
103   * @syscap SystemCapability.ArkUI.ArkUI.Full
104   * @crossplatform
105   * @since 10
106   * @form
107   */
108  Orbital,
109}
110
111/**
112 * Provides an interface for extending the loading progress.
113 *
114 * @interface LoadingProgressInterface
115 * @syscap SystemCapability.ArkUI.ArkUI.Full
116 * @since 8
117 */
118/**
119 * Provides an interface for extending the loading progress.
120 *
121 * @interface LoadingProgressInterface
122 * @syscap SystemCapability.ArkUI.ArkUI.Full
123 * @since 9
124 * @form
125 */
126/**
127 * Provides an interface for extending the loading progress.
128 *
129 * @interface LoadingProgressInterface
130 * @syscap SystemCapability.ArkUI.ArkUI.Full
131 * @crossplatform
132 * @since 10
133 * @form
134 */
135interface LoadingProgressInterface {
136  /**
137   * Called when the progress bar progress is viewed.
138   *
139   * @returns { LoadingProgressAttribute }
140   * @syscap SystemCapability.ArkUI.ArkUI.Full
141   * @since 8
142   */
143  /**
144   * Called when the progress bar progress is viewed.
145   *
146   * @returns { LoadingProgressAttribute }
147   * @syscap SystemCapability.ArkUI.ArkUI.Full
148   * @since 9
149   * @form
150   */
151  /**
152   * Called when the progress bar progress is viewed.
153   *
154   * @returns { LoadingProgressAttribute }
155   * @syscap SystemCapability.ArkUI.ArkUI.Full
156   * @crossplatform
157   * @since 10
158   * @form
159   */
160  (): LoadingProgressAttribute;
161}
162
163/**
164 * Declare the progress bar being loaded
165 *
166 * @extends CommonMethod
167 * @syscap SystemCapability.ArkUI.ArkUI.Full
168 * @since 8
169 */
170/**
171 * Declare the progress bar being loaded
172 *
173 * @extends CommonMethod
174 * @syscap SystemCapability.ArkUI.ArkUI.Full
175 * @since 9
176 * @form
177 */
178/**
179 * Declare the progress bar being loaded
180 *
181 * @extends CommonMethod
182 * @syscap SystemCapability.ArkUI.ArkUI.Full
183 * @crossplatform
184 * @since 10
185 * @form
186 */
187declare class LoadingProgressAttribute extends CommonMethod<LoadingProgressAttribute> {
188  /**
189   * Load the color of the progress bar.
190   *
191   * @param { ResourceColor } value
192   * @returns { LoadingProgressAttribute }
193   * @syscap SystemCapability.ArkUI.ArkUI.Full
194   * @since 8
195   */
196  /**
197   * Load the color of the progress bar.
198   *
199   * @param { ResourceColor } value
200   * @returns { LoadingProgressAttribute }
201   * @syscap SystemCapability.ArkUI.ArkUI.Full
202   * @since 9
203   * @form
204   */
205  /**
206   * Load the color of the progress bar.
207   *
208   * @param { ResourceColor } value
209   * @returns { LoadingProgressAttribute }
210   * @syscap SystemCapability.ArkUI.ArkUI.Full
211   * @crossplatform
212   * @since 10
213   * @form
214   */
215  color(value: ResourceColor): LoadingProgressAttribute;
216
217  /**
218   * Whether to display the LoadingProgress content.
219   *
220   * @param { boolean } value - indicates the state of LoadingProgress content
221   * @returns { LoadingProgressAttribute } the attribute of the LoadingProgress.
222   * @syscap SystemCapability.ArkUI.ArkUI.Full
223   * @crossplatform
224   * @since 10
225   */
226  enableLoading(value: boolean): LoadingProgressAttribute;
227}
228
229/**
230 * Defines LoadingProgress Component.
231 *
232 * @syscap SystemCapability.ArkUI.ArkUI.Full
233 * @since 8
234 */
235/**
236 * Defines LoadingProgress Component.
237 *
238 * @syscap SystemCapability.ArkUI.ArkUI.Full
239 * @since 9
240 * @form
241 */
242/**
243 * Defines LoadingProgress Component.
244 *
245 * @syscap SystemCapability.ArkUI.ArkUI.Full
246 * @crossplatform
247 * @since 10
248 * @form
249 */
250declare const LoadingProgress: LoadingProgressInterface;
251
252/**
253 * Loading Progress Extensions on Declarative Classes
254 *
255 * @syscap SystemCapability.ArkUI.ArkUI.Full
256 * @since 8
257 */
258/**
259 * Loading Progress Extensions on Declarative Classes
260 *
261 * @syscap SystemCapability.ArkUI.ArkUI.Full
262 * @since 9
263 * @form
264 */
265/**
266 * Loading Progress Extensions on Declarative Classes
267 *
268 * @syscap SystemCapability.ArkUI.ArkUI.Full
269 * @crossplatform
270 * @since 10
271 * @form
272 */
273declare const LoadingProgressInstance: LoadingProgressAttribute;
274