• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 { PointLightStyle, CommonMethod } from './common';
23import { Alignment } from './enums';
24/*** endif */
25
26/**
27 * Options used to construct the stack.
28 *
29 * @interface StackOptions
30 * @syscap SystemCapability.ArkUI.ArkUI.Full
31 * @crossplatform
32 * @form
33 * @atomicservice
34 * @since arkts {'1.1':'18','1.2':'20'}
35 * @arkts 1.1&1.2
36 */
37declare interface StackOptions {
38  /**
39   * Set the alignment of sub components within the container.
40   *
41   * @type { ?Alignment }
42   * @syscap SystemCapability.ArkUI.ArkUI.Full
43   * @since 7
44   */
45  /**
46   * Set the alignment of sub components within the container.
47   *
48   * @type { ?Alignment }
49   * @syscap SystemCapability.ArkUI.ArkUI.Full
50   * @form
51   * @since 9
52   */
53  /**
54   * Set the alignment of sub components within the container.
55   *
56   * @type { ?Alignment }
57   * @syscap SystemCapability.ArkUI.ArkUI.Full
58   * @crossplatform
59   * @form
60   * @since 10
61   */
62  /**
63   * Set the alignment of sub components within the container.
64   *
65   * @type { ?Alignment }
66   * @syscap SystemCapability.ArkUI.ArkUI.Full
67   * @crossplatform
68   * @form
69   * @atomicservice
70   * @since 11
71   */
72  /**
73   * Alignment of child components in the container.
74   *
75   * Anonymous Object Rectification
76   * @type { ?Alignment }
77   * @default Alignment.Center
78   * @syscap SystemCapability.ArkUI.ArkUI.Full
79   * @crossplatform
80   * @form
81   * @atomicservice
82   * @since arkts {'1.1':'18','1.2':'20'}
83   * @arkts 1.1&1.2
84   */
85  alignContent?: Alignment;
86}
87
88/**
89 * Provides ports for stacking containers.
90 *
91 * @interface StackInterface
92 * @syscap SystemCapability.ArkUI.ArkUI.Full
93 * @since 7
94 */
95/**
96 * Provides ports for stacking containers.
97 *
98 * @interface StackInterface
99 * @syscap SystemCapability.ArkUI.ArkUI.Full
100 * @form
101 * @since 9
102 */
103/**
104 * Provides ports for stacking containers.
105 *
106 * @interface StackInterface
107 * @syscap SystemCapability.ArkUI.ArkUI.Full
108 * @crossplatform
109 * @form
110 * @since 10
111 */
112/**
113 * Provides ports for stacking containers.
114 *
115 * @interface StackInterface
116 * @syscap SystemCapability.ArkUI.ArkUI.Full
117 * @crossplatform
118 * @form
119 * @atomicservice
120 * @since arkts {'1.1':'11','1.2':'20'}
121 * @arkts 1.1&1.2
122 */
123interface StackInterface {
124  /**
125   * Set the value.
126   *
127   * @param { object } value
128   * @returns { StackAttribute }
129   * @syscap SystemCapability.ArkUI.ArkUI.Full
130   * @since 7
131   */
132  /**
133   * Set the value.
134   *
135   * @param { object } value
136   * @returns { StackAttribute }
137   * @syscap SystemCapability.ArkUI.ArkUI.Full
138   * @form
139   * @since 9
140   */
141  /**
142   * Set the value.
143   *
144   * @param { object } value
145   * @returns { StackAttribute }
146   * @syscap SystemCapability.ArkUI.ArkUI.Full
147   * @crossplatform
148   * @form
149   * @since 10
150   */
151  /**
152   * Set the value.
153   *
154   * @param { object } value
155   * @returns { StackAttribute }
156   * @syscap SystemCapability.ArkUI.ArkUI.Full
157   * @crossplatform
158   * @form
159   * @atomicservice
160   * @since 11
161   */
162  /**
163   * Set the options.
164   *
165   * Anonymous Object Rectification
166   * @param { ?StackOptions } options - stack options
167   * @returns { StackAttribute }
168   * @syscap SystemCapability.ArkUI.ArkUI.Full
169   * @crossplatform
170   * @form
171   * @atomicservice
172   * @since arkts {'1.1':'18','1.2':'20'}
173   * @arkts 1.1&1.2
174   */
175  (options?: StackOptions): StackAttribute;
176}
177
178/**
179 * @extends CommonMethod<StackAttribute>
180 * @syscap SystemCapability.ArkUI.ArkUI.Full
181 * @since 7
182 */
183/**
184 * @extends CommonMethod<StackAttribute>
185 * @syscap SystemCapability.ArkUI.ArkUI.Full
186 * @form
187 * @since 9
188 */
189/**
190 * @extends CommonMethod<StackAttribute>
191 * @syscap SystemCapability.ArkUI.ArkUI.Full
192 * @crossplatform
193 * @form
194 * @since 10
195 */
196/**
197 * @extends CommonMethod<StackAttribute>
198 * @syscap SystemCapability.ArkUI.ArkUI.Full
199 * @crossplatform
200 * @form
201 * @atomicservice
202 * @since arkts {'1.1':'11','1.2':'20'}
203 * @arkts 1.1&1.2
204 */
205declare class StackAttribute extends CommonMethod<StackAttribute> {
206  /**
207   * Called when the occupancy of items in the container is set.
208   *
209   * @param { Alignment } value
210   * @returns { StackAttribute }
211   * @syscap SystemCapability.ArkUI.ArkUI.Full
212   * @since 7
213   */
214  /**
215   * Called when the occupancy of items in the container is set.
216   *
217   * @param { Alignment } value
218   * @returns { StackAttribute }
219   * @syscap SystemCapability.ArkUI.ArkUI.Full
220   * @form
221   * @since 9
222   */
223  /**
224   * Called when the occupancy of items in the container is set.
225   *
226   * @param { Alignment } value
227   * @returns { StackAttribute }
228   * @syscap SystemCapability.ArkUI.ArkUI.Full
229   * @crossplatform
230   * @form
231   * @since 10
232   */
233  /**
234   * Called when the alignment of items in the container is set.
235   *
236   * @param { Alignment } value
237   * @returns { StackAttribute }
238   * @syscap SystemCapability.ArkUI.ArkUI.Full
239   * @crossplatform
240   * @form
241   * @atomicservice
242   * @since arkts {'1.1':'11','1.2':'20'}
243   * @arkts 1.1&1.2
244   */
245  alignContent(value: Alignment): StackAttribute;
246
247  /**
248   * Sets the point light style.
249   *
250   * @param { PointLightStyle } value - The point light style.
251   * @returns { StackAttribute } The attribute of the stack.
252   * @syscap SystemCapability.ArkUI.ArkUI.Full
253   * @systemapi
254   * @since arkts {'1.1':'11','1.2':'20'}
255   * @arkts 1.1&1.2
256   */
257  pointLight(value: PointLightStyle): StackAttribute;
258}
259
260/**
261 * Defines Stack Component.
262 *
263 * @syscap SystemCapability.ArkUI.ArkUI.Full
264 * @since 7
265 */
266/**
267 * Defines Stack Component.
268 *
269 * @syscap SystemCapability.ArkUI.ArkUI.Full
270 * @form
271 * @since 9
272 */
273/**
274 * Defines Stack Component.
275 *
276 * @syscap SystemCapability.ArkUI.ArkUI.Full
277 * @crossplatform
278 * @form
279 * @since 10
280 */
281/**
282 * Defines Stack Component.
283 *
284 * @syscap SystemCapability.ArkUI.ArkUI.Full
285 * @crossplatform
286 * @form
287 * @atomicservice
288 * @since 11
289 */
290declare const Stack: StackInterface;
291
292/**
293 * Defines Stack Component instance.
294 *
295 * @syscap SystemCapability.ArkUI.ArkUI.Full
296 * @since 7
297 */
298/**
299 * Defines Stack Component instance.
300 *
301 * @syscap SystemCapability.ArkUI.ArkUI.Full
302 * @form
303 * @since 9
304 */
305/**
306 * Defines Stack Component instance.
307 *
308 * @syscap SystemCapability.ArkUI.ArkUI.Full
309 * @crossplatform
310 * @form
311 * @since 10
312 */
313/**
314 * Defines Stack Component instance.
315 *
316 * @syscap SystemCapability.ArkUI.ArkUI.Full
317 * @crossplatform
318 * @form
319 * @atomicservice
320 * @since 11
321 */
322declare const StackInstance: StackAttribute;
323