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