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 * Provides the interface for the marquee attributes. 23 * 24 * @interface MarqueeInterface 25 * @syscap SystemCapability.ArkUI.ArkUI.Full 26 * @since 8 27 */ 28/** 29 * Provides the interface for the marquee attributes. 30 * 31 * @interface MarqueeInterface 32 * @syscap SystemCapability.ArkUI.ArkUI.Full 33 * @form 34 * @since 9 35 */ 36/** 37 * Provides the interface for the marquee attributes. 38 * 39 * @interface MarqueeInterface 40 * @syscap SystemCapability.ArkUI.ArkUI.Full 41 * @crossplatform 42 * @form 43 * @since 10 44 */ 45/** 46 * Provides the interface for the marquee attributes. 47 * 48 * @interface MarqueeInterface 49 * @syscap SystemCapability.ArkUI.ArkUI.Full 50 * @crossplatform 51 * @form 52 * @atomicservice 53 * @since 11 54 */ 55interface MarqueeInterface { 56 /** 57 * Create marquee. 58 * 59 * @param { object } value 60 * @returns { MarqueeAttribute } 61 * @syscap SystemCapability.ArkUI.ArkUI.Full 62 * @since 8 63 */ 64 /** 65 * Create marquee. 66 * 67 * @param { object } value 68 * @returns { MarqueeAttribute } 69 * @syscap SystemCapability.ArkUI.ArkUI.Full 70 * @form 71 * @since 9 72 */ 73 /** 74 * Create marquee. 75 * 76 * @param { object } value 77 * @returns { MarqueeAttribute } 78 * @syscap SystemCapability.ArkUI.ArkUI.Full 79 * @crossplatform 80 * @form 81 * @since 10 82 */ 83 /** 84 * Create marquee. 85 * 86 * @param { object } value 87 * @returns { MarqueeAttribute } 88 * @syscap SystemCapability.ArkUI.ArkUI.Full 89 * @crossplatform 90 * @form 91 * @atomicservice 92 * @since 11 93 */ 94 (value: { start: boolean; step?: number; loop?: number; fromStart?: boolean; src: string }): MarqueeAttribute; 95} 96 97/** 98 * Declares marquee properties. 99 * 100 * @extends CommonMethod<MarqueeAttribute> 101 * @syscap SystemCapability.ArkUI.ArkUI.Full 102 * @since 8 103 */ 104/** 105 * Declares marquee properties. 106 * 107 * @extends CommonMethod<MarqueeAttribute> 108 * @syscap SystemCapability.ArkUI.ArkUI.Full 109 * @form 110 * @since 9 111 */ 112/** 113 * Declares marquee properties. 114 * 115 * @extends CommonMethod<MarqueeAttribute> 116 * @syscap SystemCapability.ArkUI.ArkUI.Full 117 * @crossplatform 118 * @form 119 * @since 10 120 */ 121/** 122 * Declares marquee properties. 123 * 124 * @extends CommonMethod<MarqueeAttribute> 125 * @syscap SystemCapability.ArkUI.ArkUI.Full 126 * @crossplatform 127 * @form 128 * @atomicservice 129 * @since 11 130 */ 131declare class MarqueeAttribute extends CommonMethod<MarqueeAttribute> { 132 /** 133 * Set marquee font Color. 134 * 135 * @param { ResourceColor } value 136 * @returns { MarqueeAttribute } 137 * @syscap SystemCapability.ArkUI.ArkUI.Full 138 * @since 8 139 */ 140 /** 141 * Set marquee font Color. 142 * 143 * @param { ResourceColor } value 144 * @returns { MarqueeAttribute } 145 * @syscap SystemCapability.ArkUI.ArkUI.Full 146 * @form 147 * @since 9 148 */ 149 /** 150 * Set marquee font Color. 151 * 152 * @param { ResourceColor } value 153 * @returns { MarqueeAttribute } 154 * @syscap SystemCapability.ArkUI.ArkUI.Full 155 * @crossplatform 156 * @form 157 * @since 10 158 */ 159 /** 160 * Set marquee font Color. 161 * 162 * @param { ResourceColor } value 163 * @returns { MarqueeAttribute } 164 * @syscap SystemCapability.ArkUI.ArkUI.Full 165 * @crossplatform 166 * @form 167 * @atomicservice 168 * @since 11 169 */ 170 fontColor(value: ResourceColor): MarqueeAttribute; 171 172 /** 173 * Set marquee font size. 174 * 175 * @param { Length } value 176 * @returns { MarqueeAttribute } 177 * @syscap SystemCapability.ArkUI.ArkUI.Full 178 * @since 8 179 */ 180 /** 181 * Set marquee font size. 182 * 183 * @param { Length } value 184 * @returns { MarqueeAttribute } 185 * @syscap SystemCapability.ArkUI.ArkUI.Full 186 * @form 187 * @since 9 188 */ 189 /** 190 * Set marquee font size. 191 * 192 * @param { Length } value 193 * @returns { MarqueeAttribute } 194 * @syscap SystemCapability.ArkUI.ArkUI.Full 195 * @crossplatform 196 * @form 197 * @since 10 198 */ 199 /** 200 * Set marquee font size. 201 * 202 * @param { Length } value 203 * @returns { MarqueeAttribute } 204 * @syscap SystemCapability.ArkUI.ArkUI.Full 205 * @crossplatform 206 * @form 207 * @atomicservice 208 * @since 11 209 */ 210 fontSize(value: Length): MarqueeAttribute; 211 212 /** 213 * Set marquee allow scale. 214 * 215 * @param { boolean } value 216 * @returns { MarqueeAttribute } 217 * @syscap SystemCapability.ArkUI.ArkUI.Full 218 * @since 8 219 */ 220 /** 221 * Set marquee allow scale. 222 * 223 * @param { boolean } value 224 * @returns { MarqueeAttribute } 225 * @syscap SystemCapability.ArkUI.ArkUI.Full 226 * @form 227 * @since 9 228 */ 229 /** 230 * Set marquee allow scale. 231 * 232 * @param { boolean } value 233 * @returns { MarqueeAttribute } 234 * @syscap SystemCapability.ArkUI.ArkUI.Full 235 * @crossplatform 236 * @form 237 * @since 10 238 */ 239 /** 240 * Set marquee allow scale. 241 * 242 * @param { boolean } value 243 * @returns { MarqueeAttribute } 244 * @syscap SystemCapability.ArkUI.ArkUI.Full 245 * @crossplatform 246 * @form 247 * @atomicservice 248 * @since 11 249 */ 250 allowScale(value: boolean): MarqueeAttribute; 251 252 /** 253 * Set marquee font weight. 254 * 255 * @param { number | FontWeight | string } value 256 * @returns { MarqueeAttribute } 257 * @syscap SystemCapability.ArkUI.ArkUI.Full 258 * @since 8 259 */ 260 /** 261 * Set marquee font weight. 262 * 263 * @param { number | FontWeight | string } value 264 * @returns { MarqueeAttribute } 265 * @syscap SystemCapability.ArkUI.ArkUI.Full 266 * @form 267 * @since 9 268 */ 269 /** 270 * Set marquee font weight. 271 * 272 * @param { number | FontWeight | string } value 273 * @returns { MarqueeAttribute } 274 * @syscap SystemCapability.ArkUI.ArkUI.Full 275 * @crossplatform 276 * @form 277 * @since 10 278 */ 279 /** 280 * Set marquee font weight. 281 * 282 * @param { number | FontWeight | string } value 283 * @returns { MarqueeAttribute } 284 * @syscap SystemCapability.ArkUI.ArkUI.Full 285 * @crossplatform 286 * @form 287 * @atomicservice 288 * @since 11 289 */ 290 fontWeight(value: number | FontWeight | string): MarqueeAttribute; 291 292 /** 293 * Set marquee font family. 294 * 295 * @param { string | Resource } value 296 * @returns { MarqueeAttribute } 297 * @syscap SystemCapability.ArkUI.ArkUI.Full 298 * @since 8 299 */ 300 /** 301 * Set marquee font family. 302 * 303 * @param { string | Resource } value 304 * @returns { MarqueeAttribute } 305 * @syscap SystemCapability.ArkUI.ArkUI.Full 306 * @form 307 * @since 9 308 */ 309 /** 310 * Set marquee font family. 311 * 312 * @param { string | Resource } value 313 * @returns { MarqueeAttribute } 314 * @syscap SystemCapability.ArkUI.ArkUI.Full 315 * @crossplatform 316 * @form 317 * @since 10 318 */ 319 /** 320 * Set marquee font family. 321 * 322 * @param { string | Resource } value 323 * @returns { MarqueeAttribute } 324 * @syscap SystemCapability.ArkUI.ArkUI.Full 325 * @crossplatform 326 * @form 327 * @atomicservice 328 * @since 11 329 */ 330 fontFamily(value: string | Resource): MarqueeAttribute; 331 332 /** 333 * Marquee scrolling strategy after text update. 334 * 335 * @param { MarqueeUpdateStrategy } value - The scrolling strategy after text update. 336 * @returns { MarqueeAttribute } 337 * @syscap SystemCapability.ArkUI.ArkUI.Full 338 * @crossplatform 339 * @atomicservice 340 * @since 12 341 */ 342 marqueeUpdateStrategy(value: MarqueeUpdateStrategy): MarqueeAttribute; 343 344 /** 345 * Called when scrolling starts. 346 * 347 * @param { function } event 348 * @returns { MarqueeAttribute } 349 * @syscap SystemCapability.ArkUI.ArkUI.Full 350 * @since 8 351 */ 352 /** 353 * Called when scrolling starts. 354 * 355 * @param { function } event 356 * @returns { MarqueeAttribute } 357 * @syscap SystemCapability.ArkUI.ArkUI.Full 358 * @form 359 * @since 9 360 */ 361 /** 362 * Called when scrolling starts. 363 * 364 * @param { function } event 365 * @returns { MarqueeAttribute } 366 * @syscap SystemCapability.ArkUI.ArkUI.Full 367 * @crossplatform 368 * @form 369 * @since 10 370 */ 371 /** 372 * Called when scrolling starts. 373 * 374 * @param { function } event 375 * @returns { MarqueeAttribute } 376 * @syscap SystemCapability.ArkUI.ArkUI.Full 377 * @crossplatform 378 * @form 379 * @atomicservice 380 * @since 11 381 */ 382 onStart(event: () => void): MarqueeAttribute; 383 384 /** 385 * Called when scrolling to the bottom. 386 * 387 * @param { function } event 388 * @returns { MarqueeAttribute } 389 * @syscap SystemCapability.ArkUI.ArkUI.Full 390 * @since 8 391 */ 392 /** 393 * Called when scrolling to the bottom. 394 * 395 * @param { function } event 396 * @returns { MarqueeAttribute } 397 * @syscap SystemCapability.ArkUI.ArkUI.Full 398 * @form 399 * @since 9 400 */ 401 /** 402 * Called when scrolling to the bottom. 403 * 404 * @param { function } event 405 * @returns { MarqueeAttribute } 406 * @syscap SystemCapability.ArkUI.ArkUI.Full 407 * @crossplatform 408 * @form 409 * @since 10 410 */ 411 /** 412 * Called when scrolling to the bottom. 413 * 414 * @param { function } event 415 * @returns { MarqueeAttribute } 416 * @syscap SystemCapability.ArkUI.ArkUI.Full 417 * @crossplatform 418 * @form 419 * @atomicservice 420 * @since 11 421 */ 422 onBounce(event: () => void): MarqueeAttribute; 423 424 /** 425 * Called when scrolling is complete. 426 * 427 * @param { function } event 428 * @returns { MarqueeAttribute } 429 * @syscap SystemCapability.ArkUI.ArkUI.Full 430 * @since 8 431 */ 432 /** 433 * Called when scrolling is complete. 434 * 435 * @param { function } event 436 * @returns { MarqueeAttribute } 437 * @syscap SystemCapability.ArkUI.ArkUI.Full 438 * @form 439 * @since 9 440 */ 441 /** 442 * Called when scrolling is complete. 443 * 444 * @param { function } event 445 * @returns { MarqueeAttribute } 446 * @syscap SystemCapability.ArkUI.ArkUI.Full 447 * @crossplatform 448 * @form 449 * @since 10 450 */ 451 /** 452 * Called when scrolling is complete. 453 * 454 * @param { function } event 455 * @returns { MarqueeAttribute } 456 * @syscap SystemCapability.ArkUI.ArkUI.Full 457 * @crossplatform 458 * @form 459 * @atomicservice 460 * @since 11 461 */ 462 onFinish(event: () => void): MarqueeAttribute; 463} 464 465/** 466 * Defines Marquee Component. 467 * 468 * @syscap SystemCapability.ArkUI.ArkUI.Full 469 * @since 8 470 */ 471/** 472 * Defines Marquee Component. 473 * 474 * @syscap SystemCapability.ArkUI.ArkUI.Full 475 * @form 476 * @since 9 477 */ 478/** 479 * Defines Marquee Component. 480 * 481 * @syscap SystemCapability.ArkUI.ArkUI.Full 482 * @crossplatform 483 * @form 484 * @since 10 485 */ 486/** 487 * Defines Marquee Component. 488 * 489 * @syscap SystemCapability.ArkUI.ArkUI.Full 490 * @crossplatform 491 * @form 492 * @atomicservice 493 * @since 11 494 */ 495declare const Marquee: MarqueeInterface; 496 497/** 498 * Defines Marquee Component instance. 499 * 500 * @syscap SystemCapability.ArkUI.ArkUI.Full 501 * @since 8 502 */ 503/** 504 * Defines Marquee Component instance. 505 * 506 * @syscap SystemCapability.ArkUI.ArkUI.Full 507 * @form 508 * @since 9 509 */ 510/** 511 * Defines Marquee Component instance. 512 * 513 * @syscap SystemCapability.ArkUI.ArkUI.Full 514 * @crossplatform 515 * @form 516 * @since 10 517 */ 518/** 519 * Defines Marquee Component instance. 520 * 521 * @syscap SystemCapability.ArkUI.ArkUI.Full 522 * @crossplatform 523 * @form 524 * @atomicservice 525 * @since 11 526 */ 527declare const MarqueeInstance: MarqueeAttribute; 528