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