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