• 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 * Defines the ColumnSplit component.
23 *
24 * @interface ColumnSplitInterface
25 * @syscap SystemCapability.ArkUI.ArkUI.Full
26 * @since 7
27 */
28/**
29 * Defines the ColumnSplit component.
30 *
31 * @interface ColumnSplitInterface
32 * @syscap SystemCapability.ArkUI.ArkUI.Full
33 * @crossplatform
34 * @since 10
35 */
36/**
37 * Defines the ColumnSplit component.
38 *
39 * @interface ColumnSplitInterface
40 * @syscap SystemCapability.ArkUI.ArkUI.Full
41 * @crossplatform
42 * @atomicservice
43 * @since 11
44 */
45interface ColumnSplitInterface {
46  /**
47   * Layout the subassemblies vertically and insert a horizontal divider line between each subassemblies.
48   *
49   * @returns { ColumnSplitAttribute }
50   * @syscap SystemCapability.ArkUI.ArkUI.Full
51   * @since 7
52   */
53  /**
54   * Layout the subassemblies vertically and insert a horizontal divider line between each subassemblies.
55   *
56   * @returns { ColumnSplitAttribute }
57   * @syscap SystemCapability.ArkUI.ArkUI.Full
58   * @crossplatform
59   * @since 10
60   */
61  /**
62   * Layout the subassemblies vertically and insert a horizontal divider line between each subassemblies.
63   *
64   * @returns { ColumnSplitAttribute }
65   * @syscap SystemCapability.ArkUI.ArkUI.Full
66   * @crossplatform
67   * @atomicservice
68   * @since 11
69   */
70  (): ColumnSplitAttribute;
71}
72
73/**
74 * Provides an interface for the style of a divider including start margin and end margin
75 *
76 * @interface ColumnSplitDividerStyle
77 * @syscap SystemCapability.ArkUI.ArkUI.Full
78 * @crossplatform
79 * @since 10
80 */
81/**
82 * Provides an interface for the style of a divider including start margin and end margin
83 *
84 * @interface ColumnSplitDividerStyle
85 * @syscap SystemCapability.ArkUI.ArkUI.Full
86 * @crossplatform
87 * @atomicservice
88 * @since 11
89 */
90interface ColumnSplitDividerStyle {
91  /**
92   * Define the start margin of the divider
93   *
94   * @type { ?Dimension }
95   * @default 0
96   * @syscap SystemCapability.ArkUI.ArkUI.Full
97   * @crossplatform
98   * @since 10
99   */
100  /**
101   * Define the start margin of the divider
102   *
103   * @type { ?Dimension }
104   * @default 0
105   * @syscap SystemCapability.ArkUI.ArkUI.Full
106   * @crossplatform
107   * @atomicservice
108   * @since 11
109   */
110  startMargin?: Dimension;
111
112  /**
113   * Define the end margin of the divider
114   *
115   * @type { ?Dimension }
116   * @default 0
117   * @syscap SystemCapability.ArkUI.ArkUI.Full
118   * @crossplatform
119   * @since 10
120   */
121  /**
122   * Define the end margin of the divider
123   *
124   * @type { ?Dimension }
125   * @default 0
126   * @syscap SystemCapability.ArkUI.ArkUI.Full
127   * @crossplatform
128   * @atomicservice
129   * @since 11
130   */
131  endMargin?: Dimension;
132}
133
134/**
135 * Defines the ColumnSplit component attribute functions.
136 *
137 * @extends CommonMethod<ColumnSplitAttribute>
138 * @syscap SystemCapability.ArkUI.ArkUI.Full
139 * @since 7
140 */
141/**
142 * Defines the ColumnSplit component attribute functions.
143 *
144 * @extends CommonMethod<ColumnSplitAttribute>
145 * @syscap SystemCapability.ArkUI.ArkUI.Full
146 * @crossplatform
147 * @since 10
148 */
149/**
150 * Defines the ColumnSplit component attribute functions.
151 *
152 * @extends CommonMethod<ColumnSplitAttribute>
153 * @syscap SystemCapability.ArkUI.ArkUI.Full
154 * @crossplatform
155 * @atomicservice
156 * @since 11
157 */
158declare class ColumnSplitAttribute extends CommonMethod<ColumnSplitAttribute> {
159  /**
160   * Indicates whether the split line can be dragged. The default value is false.
161   *
162   * @param { boolean } value
163   * @returns { ColumnSplitAttribute }
164   * @syscap SystemCapability.ArkUI.ArkUI.Full
165   * @since 7
166   */
167  /**
168   * Indicates whether the split line can be dragged. The default value is false.
169   *
170   * @param { boolean } value
171   * @returns { ColumnSplitAttribute }
172   * @syscap SystemCapability.ArkUI.ArkUI.Full
173   * @crossplatform
174   * @since 10
175   */
176  /**
177   * Indicates whether the split line can be dragged. The default value is false.
178   *
179   * @param { boolean } value
180   * @returns { ColumnSplitAttribute }
181   * @syscap SystemCapability.ArkUI.ArkUI.Full
182   * @crossplatform
183   * @atomicservice
184   * @since 11
185   */
186  resizeable(value: boolean): ColumnSplitAttribute;
187
188  /**
189   * Called when the ColumnSplit split line style is set.
190   * @param { ColumnSplitDividerStyle | null } value - indicates the style of the indicator.
191   * if value is set to null, the value of startMargin and endMargin is set to 0.0 by default.
192   * @returns { ColumnSplitAttribute } the attribute of the ColumnSplit
193   * @syscap SystemCapability.ArkUI.ArkUI.Full
194   * @crossplatform
195   * @since 10
196   */
197  /**
198   * Called when the ColumnSplit split line style is set.
199   * @param { ColumnSplitDividerStyle | null } value - indicates the style of the indicator.
200   * if value is set to null, the value of startMargin and endMargin is set to 0.0 by default.
201   * @returns { ColumnSplitAttribute } the attribute of the ColumnSplit
202   * @syscap SystemCapability.ArkUI.ArkUI.Full
203   * @crossplatform
204   * @atomicservice
205   * @since 11
206   */
207  divider(value: ColumnSplitDividerStyle | null): ColumnSplitAttribute;
208}
209
210/**
211 * Defines ColumnSplit Component instance.
212 *
213 * @syscap SystemCapability.ArkUI.ArkUI.Full
214 * @since 7
215 */
216/**
217 * Defines ColumnSplit Component instance.
218 *
219 * @syscap SystemCapability.ArkUI.ArkUI.Full
220 * @crossplatform
221 * @since 10
222 */
223/**
224 * Defines ColumnSplit Component instance.
225 *
226 * @syscap SystemCapability.ArkUI.ArkUI.Full
227 * @crossplatform
228 * @atomicservice
229 * @since 11
230 */
231declare const ColumnSplitInstance: ColumnSplitAttribute;
232
233/**
234 * Defines ColumnSplit Component.
235 *
236 * @syscap SystemCapability.ArkUI.ArkUI.Full
237 * @since 7
238 */
239/**
240 * Defines ColumnSplit Component.
241 *
242 * @syscap SystemCapability.ArkUI.ArkUI.Full
243 * @crossplatform
244 * @since 10
245 */
246/**
247 * Defines ColumnSplit Component.
248 *
249 * @syscap SystemCapability.ArkUI.ArkUI.Full
250 * @crossplatform
251 * @atomicservice
252 * @since 11
253 */
254declare const ColumnSplit: ColumnSplitInterface;
255