• 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 * Defines the ColumnSplit component.
18 *
19 * @interface ColumnSplitInterface
20 * @syscap SystemCapability.ArkUI.ArkUI.Full
21 * @since 7
22 */
23/**
24 * Defines the ColumnSplit component.
25 *
26 * @interface ColumnSplitInterface
27 * @syscap SystemCapability.ArkUI.ArkUI.Full
28 * @crossplatform
29 * @since 10
30 */
31interface ColumnSplitInterface {
32  /**
33   * Layout the subassemblies vertically and insert a horizontal divider line between each subassemblies.
34   *
35   * @returns { ColumnSplitAttribute }
36   * @syscap SystemCapability.ArkUI.ArkUI.Full
37   * @since 7
38   */
39  /**
40   * Layout the subassemblies vertically and insert a horizontal divider line between each subassemblies.
41   *
42   * @returns { ColumnSplitAttribute }
43   * @syscap SystemCapability.ArkUI.ArkUI.Full
44   * @crossplatform
45   * @since 10
46   */
47  (): ColumnSplitAttribute;
48}
49
50/**
51 * Provides an interface for the style of a divider including start margin and end margin
52 *
53 * @interface ColumnSplitDividerStyle
54 * @syscap SystemCapability.ArkUI.ArkUI.Full
55 * @crossplatform
56 * @since 10
57 */
58interface ColumnSplitDividerStyle {
59  /**
60   * Define the start margin of the divider
61   *
62   * @type { ?Dimension }
63   * @default 0
64   * @syscap SystemCapability.ArkUI.ArkUI.Full
65   * @crossplatform
66   * @since 10
67   */
68  startMargin?: Dimension;
69
70  /**
71   * Define the end margin of the divider
72   *
73   * @type { ?Dimension }
74   * @default 0
75   * @syscap SystemCapability.ArkUI.ArkUI.Full
76   * @crossplatform
77   * @since 10
78   */
79  endMargin?: Dimension;
80}
81
82/**
83 * Defines the ColumnSplit component attribute functions.
84 *
85 * @extends CommonMethod
86 * @syscap SystemCapability.ArkUI.ArkUI.Full
87 * @since 7
88 */
89/**
90 * Defines the ColumnSplit component attribute functions.
91 *
92 * @extends CommonMethod
93 * @syscap SystemCapability.ArkUI.ArkUI.Full
94 * @crossplatform
95 * @since 10
96 */
97declare class ColumnSplitAttribute extends CommonMethod<ColumnSplitAttribute> {
98  /**
99   * Indicates whether the split line can be dragged. The default value is false.
100   *
101   * @param { boolean } value
102   * @returns { ColumnSplitAttribute }
103   * @syscap SystemCapability.ArkUI.ArkUI.Full
104   * @since 7
105   */
106  /**
107   * Indicates whether the split line can be dragged. The default value is false.
108   *
109   * @param { boolean } value
110   * @returns { ColumnSplitAttribute }
111   * @syscap SystemCapability.ArkUI.ArkUI.Full
112   * @crossplatform
113   * @since 10
114   */
115  resizeable(value: boolean): ColumnSplitAttribute;
116
117  /**
118   * Called when the ColumnSplit split line style is set.
119   * @param { ColumnSplitDividerStyle | null } value - indicates the style of the indicator.
120   * if value is set to null, the value of startMargin and endMargin is set to 0.0 by default.
121   * @returns { ColumnSplitAttribute } the attribute of the ColumnSplit
122   * @syscap SystemCapability.ArkUI.ArkUI.Full
123   * @crossplatform
124   * @since 10
125   */
126  divider(value: ColumnSplitDividerStyle | null): ColumnSplitAttribute;
127}
128
129/**
130 * Defines ColumnSplit Component instance.
131 *
132 * @syscap SystemCapability.ArkUI.ArkUI.Full
133 * @since 7
134 */
135/**
136 * Defines ColumnSplit Component instance.
137 *
138 * @syscap SystemCapability.ArkUI.ArkUI.Full
139 * @crossplatform
140 * @since 10
141 */
142declare const ColumnSplitInstance: ColumnSplitAttribute;
143
144/**
145 * Defines ColumnSplit Component.
146 *
147 * @syscap SystemCapability.ArkUI.ArkUI.Full
148 * @since 7
149 */
150/**
151 * Defines ColumnSplit Component.
152 *
153 * @syscap SystemCapability.ArkUI.ArkUI.Full
154 * @crossplatform
155 * @since 10
156 */
157declare const ColumnSplit: ColumnSplitInterface;
158