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