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