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