1/* 2 * Copyright (c) 2022-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 { Dimension } from './units'; 23import { Axis } from './enums'; 24import { CommonMethod } from './common'; 25/*** endif */ 26 27/** 28 * Provides ports for relativeContainer. 29 * 30 * @interface RelativeContainerInterface 31 * @syscap SystemCapability.ArkUI.ArkUI.Full 32 * @form 33 * @since 9 34 */ 35/** 36 * Provides ports for relativeContainer. 37 * 38 * @interface RelativeContainerInterface 39 * @syscap SystemCapability.ArkUI.ArkUI.Full 40 * @crossplatform 41 * @form 42 * @since 10 43 */ 44/** 45 * Provides ports for relativeContainer. 46 * 47 * @interface RelativeContainerInterface 48 * @syscap SystemCapability.ArkUI.ArkUI.Full 49 * @crossplatform 50 * @form 51 * @atomicservice 52 * @since arkts {'1.1':'11','1.2':'20'} 53 * @arkts 1.1&1.2 54 */ 55interface RelativeContainerInterface { 56 /** 57 * Defines the constructor of RelativeContainer. 58 * 59 * @returns { RelativeContainerAttribute } 60 * @syscap SystemCapability.ArkUI.ArkUI.Full 61 * @form 62 * @since 9 63 */ 64 /** 65 * Defines the constructor of RelativeContainer. 66 * 67 * @returns { RelativeContainerAttribute } 68 * @syscap SystemCapability.ArkUI.ArkUI.Full 69 * @crossplatform 70 * @form 71 * @since 10 72 */ 73 /** 74 * Defines the constructor of RelativeContainer. 75 * 76 * @returns { RelativeContainerAttribute } 77 * @syscap SystemCapability.ArkUI.ArkUI.Full 78 * @crossplatform 79 * @form 80 * @atomicservice 81 * @since arkts {'1.1':'11','1.2':'20'} 82 * @arkts 1.1&1.2 83 */ 84 (): RelativeContainerAttribute; 85} 86 87/** 88 * Specifies the position of guideLine 89 * 90 * @interface GuideLinePosition 91 * @syscap SystemCapability.ArkUI.ArkUI.Full 92 * @crossplatform 93 * @atomicservice 94 * @since arkts {'1.1':'12','1.2':'20'} 95 * @arkts 1.1&1.2 96 */ 97declare interface GuideLinePosition { 98 /** 99 * Specifies the distance to start of container 100 * 101 * @type { ?Dimension } 102 * @syscap SystemCapability.ArkUI.ArkUI.Full 103 * @crossplatform 104 * @atomicservice 105 * @since arkts {'1.1':'12','1.2':'20'} 106 * @arkts 1.1&1.2 107 */ 108 start? : Dimension; 109 110 /** 111 * Specifies the distance to end of container 112 * 113 * @type { ?Dimension } 114 * @syscap SystemCapability.ArkUI.ArkUI.Full 115 * @crossplatform 116 * @atomicservice 117 * @since arkts {'1.1':'12','1.2':'20'} 118 * @arkts 1.1&1.2 119 */ 120 end? : Dimension; 121} 122 123/** 124 * Specifies the GuideLineStyle of relativeContainer 125 * 126 * @interface GuideLineStyle 127 * @syscap SystemCapability.ArkUI.ArkUI.Full 128 * @crossplatform 129 * @atomicservice 130 * @since arkts {'1.1':'12','1.2':'20'} 131 * @arkts 1.1&1.2 132 */ 133declare interface GuideLineStyle { 134 /** 135 * Specifies the id of guideLine 136 * 137 * @type { string } 138 * @syscap SystemCapability.ArkUI.ArkUI.Full 139 * @crossplatform 140 * @atomicservice 141 * @since arkts {'1.1':'12','1.2':'20'} 142 * @arkts 1.1&1.2 143 */ 144 id : string; 145 146 /** 147 * Specifies the direction of guideLine 148 * 149 * @type { Axis } 150 * @syscap SystemCapability.ArkUI.ArkUI.Full 151 * @crossplatform 152 * @atomicservice 153 * @since arkts {'1.1':'12','1.2':'20'} 154 * @arkts 1.1&1.2 155 */ 156 direction : Axis; 157 158 /** 159 * Specifies the position of guideLine 160 * 161 * @type { GuideLinePosition } 162 * @syscap SystemCapability.ArkUI.ArkUI.Full 163 * @crossplatform 164 * @atomicservice 165 * @since arkts {'1.1':'12','1.2':'20'} 166 * @arkts 1.1&1.2 167 */ 168 position : GuideLinePosition; 169} 170 171/** 172 * Specifies the direction value of Barrier. 173 * 174 * @enum { number } 175 * @syscap SystemCapability.Test.UiTest 176 * @crossplatform 177 * @atomicservice 178 * @since arkts {'1.1':'12','1.2':'20'} 179 * @arkts 1.1&1.2 180 */ 181declare enum BarrierDirection { 182 /** 183 * Barrier will be positioned to the far left of all referenced components. 184 * 185 * @syscap SystemCapability.ArkUI.ArkUI.Full 186 * @crossplatform 187 * @atomicservice 188 * @since arkts {'1.1':'12','1.2':'20'} 189 * @arkts 1.1&1.2 190 */ 191 LEFT, 192 193 /** 194 * Barrier will be positioned to the far right of all referenced components. 195 * 196 * @syscap SystemCapability.ArkUI.ArkUI.Full 197 * @crossplatform 198 * @atomicservice 199 * @since arkts {'1.1':'12','1.2':'20'} 200 * @arkts 1.1&1.2 201 */ 202 RIGHT, 203 204 /** 205 * Barrier will be positioned to the top of all referenced components. 206 * 207 * @syscap SystemCapability.ArkUI.ArkUI.Full 208 * @crossplatform 209 * @atomicservice 210 * @since arkts {'1.1':'12','1.2':'20'} 211 * @arkts 1.1&1.2 212 */ 213 TOP, 214 215 /** 216 * Barrier will be positioned to the bottom of all referenced components. 217 * 218 * @syscap SystemCapability.ArkUI.ArkUI.Full 219 * @crossplatform 220 * @atomicservice 221 * @since arkts {'1.1':'12','1.2':'20'} 222 * @arkts 1.1&1.2 223 */ 224 BOTTOM, 225} 226 227/** 228 * Specifies the localized direction value of Barrier. 229 * 230 * @enum { number } 231 * @syscap SystemCapability.ArkUI.ArkUI.Full 232 * @crossplatform 233 * @atomicservice 234 * @since arkts {'1.1':'12','1.2':'20'} 235 * @arkts 1.1&1.2 236 */ 237declare enum LocalizedBarrierDirection { 238 /** 239 * Localized barrier will be positioned to the far start of all referenced components. 240 * 241 * @syscap SystemCapability.ArkUI.ArkUI.Full 242 * @crossplatform 243 * @atomicservice 244 * @since arkts {'1.1':'12','1.2':'20'} 245 * @arkts 1.1&1.2 246 */ 247 START = 0, 248 249 /** 250 * Localized barrier will be positioned to the far end of all referenced components. 251 * 252 * @syscap SystemCapability.ArkUI.ArkUI.Full 253 * @crossplatform 254 * @atomicservice 255 * @since arkts {'1.1':'12','1.2':'20'} 256 * @arkts 1.1&1.2 257 */ 258 END = 1, 259 260 /** 261 * Localized barrier will be positioned to the top of all referenced components. 262 * 263 * @syscap SystemCapability.ArkUI.ArkUI.Full 264 * @crossplatform 265 * @atomicservice 266 * @since arkts {'1.1':'12','1.2':'20'} 267 * @arkts 1.1&1.2 268 */ 269 TOP = 2, 270 271 /** 272 * Localized barrier will be positioned to the bottom of all referenced components. 273 * 274 * @syscap SystemCapability.ArkUI.ArkUI.Full 275 * @crossplatform 276 * @atomicservice 277 * @since arkts {'1.1':'12','1.2':'20'} 278 * @arkts 1.1&1.2 279 */ 280 BOTTOM = 3, 281} 282 283/** 284 * Specifies the BarrierStyle of relativeContainer 285 * 286 * @interface BarrierStyle 287 * @syscap SystemCapability.ArkUI.ArkUI.Full 288 * @crossplatform 289 * @atomicservice 290 * @since arkts {'1.1':'12','1.2':'20'} 291 * @arkts 1.1&1.2 292 */ 293declare interface BarrierStyle { 294 /** 295 * Specifies the id of barrier 296 * 297 * @type { string } 298 * @syscap SystemCapability.ArkUI.ArkUI.Full 299 * @crossplatform 300 * @atomicservice 301 * @since arkts {'1.1':'12','1.2':'20'} 302 * @arkts 1.1&1.2 303 */ 304 id : string; 305 306 /** 307 * Specifies the direction of barrier 308 * 309 * @type { BarrierDirection } 310 * @syscap SystemCapability.ArkUI.ArkUI.Full 311 * @crossplatform 312 * @atomicservice 313 * @since arkts {'1.1':'12','1.2':'20'} 314 * @arkts 1.1&1.2 315 */ 316 direction : BarrierDirection; 317 318 /** 319 * Specifies the referencedId of barrier 320 * 321 * @type { Array<string> } 322 * @syscap SystemCapability.ArkUI.ArkUI.Full 323 * @crossplatform 324 * @atomicservice 325 * @since arkts {'1.1':'12','1.2':'20'} 326 * @arkts 1.1&1.2 327 */ 328 referencedId : Array<string>; 329} 330 331/** 332 * Specifies the Localized BarrierStyle of relativeContainer 333 * 334 * @interface LocalizedBarrierStyle 335 * @syscap SystemCapability.ArkUI.ArkUI.Full 336 * @crossplatform 337 * @atomicservice 338 * @since arkts {'1.1':'12','1.2':'20'} 339 * @arkts 1.1&1.2 340 */ 341declare interface LocalizedBarrierStyle { 342 /** 343 * Specifies the id of localized barrier 344 * 345 * @type { string } 346 * @syscap SystemCapability.ArkUI.ArkUI.Full 347 * @crossplatform 348 * @atomicservice 349 * @since arkts {'1.1':'12','1.2':'20'} 350 * @arkts 1.1&1.2 351 */ 352 id : string; 353 354 /** 355 * Specifies the localized barrier direction of barrier 356 * 357 * @type { LocalizedBarrierDirection } 358 * @syscap SystemCapability.ArkUI.ArkUI.Full 359 * @crossplatform 360 * @atomicservice 361 * @since arkts {'1.1':'12','1.2':'20'} 362 * @arkts 1.1&1.2 363 */ 364 localizedDirection : LocalizedBarrierDirection; 365 366 /** 367 * Specifies the referencedId of localized barrier 368 * 369 * @type { Array<string> } 370 * @syscap SystemCapability.ArkUI.ArkUI.Full 371 * @crossplatform 372 * @atomicservice 373 * @since arkts {'1.1':'12','1.2':'20'} 374 * @arkts 1.1&1.2 375 */ 376 referencedId : Array<string>; 377} 378 379/** 380 * @extends CommonMethod<RelativeContainerAttribute> 381 * @syscap SystemCapability.ArkUI.ArkUI.Full 382 * @form 383 * @since 9 384 */ 385/** 386 * @extends CommonMethod<RelativeContainerAttribute> 387 * @syscap SystemCapability.ArkUI.ArkUI.Full 388 * @crossplatform 389 * @form 390 * @since 10 391 */ 392/** 393 * @extends CommonMethod<RelativeContainerAttribute> 394 * @syscap SystemCapability.ArkUI.ArkUI.Full 395 * @crossplatform 396 * @form 397 * @atomicservice 398 * @since arkts {'1.1':'11','1.2':'20'} 399 * @arkts 1.1&1.2 400 */ 401declare class RelativeContainerAttribute extends CommonMethod<RelativeContainerAttribute> { 402 /** 403 * Specifies guideLines of relativeContainer 404 * 405 * @param { Array<GuideLineStyle> } value 406 * @returns { RelativeContainerAttribute } 407 * @syscap SystemCapability.ArkUI.ArkUI.Full 408 * @crossplatform 409 * @atomicservice 410 * @since arkts {'1.1':'12','1.2':'20'} 411 * @arkts 1.1&1.2 412 */ 413 guideLine(value: Array<GuideLineStyle>): RelativeContainerAttribute; 414 415 /** 416 * Specifies barriers of relativeContainer 417 * 418 * @param { Array<BarrierStyle> } value 419 * @returns { RelativeContainerAttribute } 420 * @syscap SystemCapability.ArkUI.ArkUI.Full 421 * @crossplatform 422 * @atomicservice 423 * @since arkts {'1.1':'12','1.2':'20'} 424 * @arkts 1.1&1.2 425 */ 426 barrier(value: Array<BarrierStyle>): RelativeContainerAttribute; 427 428 /** 429 * Specifies barriers of relativeContainer 430 * 431 * @param { Array<LocalizedBarrierStyle> } barrierStyle 432 * @returns { RelativeContainerAttribute } 433 * @syscap SystemCapability.ArkUI.ArkUI.Full 434 * @crossplatform 435 * @atomicservice 436 * @since arkts {'1.1':'12','1.2':'20'} 437 * @arkts 1.1&1.2 438 */ 439 barrier(barrierStyle: Array<LocalizedBarrierStyle>): RelativeContainerAttribute; 440} 441 442/** 443 * RelativeContainer 444 * 445 * @syscap SystemCapability.ArkUI.ArkUI.Full 446 * @form 447 * @since 9 448 */ 449/** 450 * RelativeContainer 451 * 452 * @syscap SystemCapability.ArkUI.ArkUI.Full 453 * @crossplatform 454 * @form 455 * @since 10 456 */ 457/** 458 * RelativeContainer 459 * 460 * @syscap SystemCapability.ArkUI.ArkUI.Full 461 * @crossplatform 462 * @form 463 * @atomicservice 464 * @since 11 465 */ 466declare const RelativeContainer: RelativeContainerInterface; 467 468/** 469 * RelativeContainerInstance 470 * 471 * @syscap SystemCapability.ArkUI.ArkUI.Full 472 * @form 473 * @since 9 474 */ 475/** 476 * RelativeContainerInstance 477 * 478 * @syscap SystemCapability.ArkUI.ArkUI.Full 479 * @crossplatform 480 * @form 481 * @since 10 482 */ 483/** 484 * RelativeContainerInstance 485 * 486 * @syscap SystemCapability.ArkUI.ArkUI.Full 487 * @crossplatform 488 * @form 489 * @atomicservice 490 * @since 11 491 */ 492declare const RelativeContainerInstance: RelativeContainerAttribute; 493