1/* 2 * Copyright (c) 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 { Resource } from './../../../api/global/resource'; 23import { CommonMethod, AttributeModifier } from './common'; 24import { ResourceColor } from './units'; 25import { FontWeight } from './enums'; 26import { SymbolEffectStrategy, SymbolRenderingStrategy } from './symbolglyph'; 27/*** endif */ 28 29/** 30 * Provides an interface for SymbolSpan. 31 * 32 * @interface SymbolSpanInterface 33 * @syscap SystemCapability.ArkUI.ArkUI.Full 34 * @since 11 35 */ 36/** 37 * Provides an interface for SymbolSpan. 38 * 39 * @interface SymbolSpanInterface 40 * @syscap SystemCapability.ArkUI.ArkUI.Full 41 * @form 42 * @atomicservice 43 * @since 12 44 */ 45/** 46 * Provides an interface for SymbolSpan. 47 * 48 * @interface SymbolSpanInterface 49 * @syscap SystemCapability.ArkUI.ArkUI.Full 50 * @crossplatform 51 * @form 52 * @atomicservice 53 * @since 20 54 * @arkts 1.1&1.2 55 */ 56interface SymbolSpanInterface { 57 /** 58 * Called when resource is entered in SymbolSpan. 59 * 60 * @param { Resource } value 61 * @returns { SymbolSpanAttribute } 62 * @syscap SystemCapability.ArkUI.ArkUI.Full 63 * @since 11 64 */ 65 /** 66 * Called when resource is entered in SymbolSpan. 67 * 68 * @param { Resource } value 69 * @returns { SymbolSpanAttribute } 70 * @syscap SystemCapability.ArkUI.ArkUI.Full 71 * @form 72 * @atomicservice 73 * @since 12 74 */ 75 /** 76 * Called when resource is entered in SymbolSpan. 77 * 78 * @param { Resource } value 79 * @returns { SymbolSpanAttribute } 80 * @syscap SystemCapability.ArkUI.ArkUI.Full 81 * @crossplatform 82 * @form 83 * @atomicservice 84 * @since 20 85 * @arkts 1.1&1.2 86 */ 87 (value: Resource): SymbolSpanAttribute; 88} 89 90/** 91 * Provides attribute for SymbolSpan. 92 * 93 * @extends CommonMethod<SymbolSpanAttribute> 94 * @syscap SystemCapability.ArkUI.ArkUI.Full 95 * @since 11 96 */ 97/** 98 * Provides attribute for SymbolSpan. 99 * 100 * @extends CommonMethod<SymbolSpanAttribute> 101 * @syscap SystemCapability.ArkUI.ArkUI.Full 102 * @form 103 * @atomicservice 104 * @since 12 105 */ 106/** 107 * Provides attribute for SymbolSpan. 108 * 109 * @extends CommonMethod<SymbolSpanAttribute> 110 * @syscap SystemCapability.ArkUI.ArkUI.Full 111 * @crossplatform 112 * @form 113 * @atomicservice 114 * @since 20 115 * @arkts 1.1&1.2 116 */ 117declare class SymbolSpanAttribute extends CommonMethod<SymbolSpanAttribute> { 118 /** 119 * Called when the SymbolSpan size is set. 120 * 121 * @param { number | string | Resource } value 122 * @returns { SymbolSpanAttribute } 123 * @syscap SystemCapability.ArkUI.ArkUI.Full 124 * @since 11 125 */ 126 /** 127 * Called when the SymbolSpan size is set. 128 * 129 * @param { number | string | Resource } value 130 * @returns { SymbolSpanAttribute } 131 * @syscap SystemCapability.ArkUI.ArkUI.Full 132 * @form 133 * @atomicservice 134 * @since 12 135 */ 136 /** 137 * Called when the SymbolSpan size is set. 138 * 139 * @param { number | string | Resource } value 140 * @returns { SymbolSpanAttribute } 141 * @syscap SystemCapability.ArkUI.ArkUI.Full 142 * @crossplatform 143 * @form 144 * @atomicservice 145 * @since 20 146 * @arkts 1.1&1.2 147 */ 148 fontSize(value: number | string | Resource): SymbolSpanAttribute; 149 150 /** 151 * Called when the SymbolSpan color is set. 152 * 153 * @param { Array<ResourceColor> } value 154 * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph. 155 * @syscap SystemCapability.ArkUI.ArkUI.Full 156 * @since 11 157 */ 158 /** 159 * Called when the SymbolSpan color is set. 160 * 161 * @param { Array<ResourceColor> } value 162 * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph. 163 * @syscap SystemCapability.ArkUI.ArkUI.Full 164 * @form 165 * @atomicservice 166 * @since 12 167 */ 168 /** 169 * Called when the SymbolSpan color is set. 170 * 171 * @param { Array<ResourceColor> } value 172 * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph. 173 * @syscap SystemCapability.ArkUI.ArkUI.Full 174 * @crossplatform 175 * @form 176 * @atomicservice 177 * @since 20 178 * @arkts 1.1&1.2 179 */ 180 fontColor(value: Array<ResourceColor>): SymbolSpanAttribute; 181 182 /** 183 * Called when the font SymbolSpan weight is set. 184 * 185 * @param { number | FontWeight | string } value 186 * @returns { SymbolSpanAttribute } 187 * @syscap SystemCapability.ArkUI.ArkUI.Full 188 * @since 11 189 */ 190 /** 191 * Called when the font SymbolSpan weight is set. 192 * 193 * @param { number | FontWeight | string } value 194 * @returns { SymbolSpanAttribute } 195 * @syscap SystemCapability.ArkUI.ArkUI.Full 196 * @form 197 * @atomicservice 198 * @since 12 199 */ 200 /** 201 * Called when the font SymbolSpan weight is set. 202 * 203 * @param { number | FontWeight | string } value 204 * @returns { SymbolSpanAttribute } 205 * @syscap SystemCapability.ArkUI.ArkUI.Full 206 * @crossplatform 207 * @form 208 * @atomicservice 209 * @since 20 210 * @arkts 1.1&1.2 211 */ 212 fontWeight(value: number | FontWeight | string): SymbolSpanAttribute; 213 214 /** 215 * Called when the SymbolSpan effect is set. 216 * 217 * @param { SymbolEffectStrategy } value 218 * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph. 219 * @syscap SystemCapability.ArkUI.ArkUI.Full 220 * @since 11 221 */ 222 /** 223 * Called when the SymbolSpan effect is set. 224 * 225 * @param { SymbolEffectStrategy } value 226 * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph. 227 * @syscap SystemCapability.ArkUI.ArkUI.Full 228 * @form 229 * @atomicservice 230 * @since 12 231 */ 232 /** 233 * Called when the SymbolSpan effect is set. 234 * 235 * @param { SymbolEffectStrategy } value 236 * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph. 237 * @syscap SystemCapability.ArkUI.ArkUI.Full 238 * @crossplatform 239 * @form 240 * @atomicservice 241 * @since 20 242 * @arkts 1.1&1.2 243 */ 244 effectStrategy(value: SymbolEffectStrategy): SymbolSpanAttribute; 245 246 /** 247 * Called when the SymbolSpan rendering strategy is set. 248 * 249 * @param { SymbolRenderingStrategy } value 250 * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph. 251 * @syscap SystemCapability.ArkUI.ArkUI.Full 252 * @since 11 253 */ 254 /** 255 * Called when the SymbolSpan rendering strategy is set. 256 * 257 * @param { SymbolRenderingStrategy } value 258 * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph. 259 * @syscap SystemCapability.ArkUI.ArkUI.Full 260 * @form 261 * @atomicservice 262 * @since 12 263 */ 264 /** 265 * Called when the SymbolSpan rendering strategy is set. 266 * 267 * @param { SymbolRenderingStrategy } value 268 * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph. 269 * @syscap SystemCapability.ArkUI.ArkUI.Full 270 * @crossplatform 271 * @form 272 * @atomicservice 273 * @since 20 274 * @arkts 1.1&1.2 275 */ 276 renderingStrategy(value: SymbolRenderingStrategy): SymbolSpanAttribute; 277 278 /** 279 * Sets the attribute modifier. 280 * 281 * @param { AttributeModifier<SymbolSpanAttribute> } modifier - The instance of symbol span modifier. 282 * @returns { SymbolSpanAttribute } the attribute of the SymbolSpanAttribute. 283 * @syscap SystemCapability.ArkUI.ArkUI.Full 284 * @atomicservice 285 * @since 12 286 */ 287 /** 288 * Sets the attribute modifier. 289 * 290 * @param { AttributeModifier<SymbolSpanAttribute> } modifier - The instance of symbol span modifier. 291 * @returns { SymbolSpanAttribute } the attribute of the SymbolSpanAttribute. 292 * @syscap SystemCapability.ArkUI.ArkUI.Full 293 * @crossplatform 294 * @atomicservice 295 * @since 20 296 * @arkts 1.1&1.2 297 */ 298 attributeModifier(modifier: AttributeModifier<SymbolSpanAttribute>): SymbolSpanAttribute; 299} 300 301/** 302 * Defines SymbolSpan Component. 303 * 304 * @syscap SystemCapability.ArkUI.ArkUI.Full 305 * @since 11 306 */ 307/** 308 * Defines SymbolSpan Component. 309 * 310 * @syscap SystemCapability.ArkUI.ArkUI.Full 311 * @form 312 * @atomicservice 313 * @since 12 314 */ 315/** 316 * Defines SymbolSpan Component. 317 * 318 * @syscap SystemCapability.ArkUI.ArkUI.Full 319 * @crossplatform 320 * @form 321 * @atomicservice 322 * @since 20 323 */ 324declare const SymbolSpan: SymbolSpanInterface; 325 326/** 327 * Defines SymbolSpan Component instance. 328 * 329 * @syscap SystemCapability.ArkUI.ArkUI.Full 330 * @since 11 331 */ 332/** 333 * Defines SymbolSpan Component instance. 334 * 335 * @syscap SystemCapability.ArkUI.ArkUI.Full 336 * @form 337 * @atomicservice 338 * @since 12 339 */ 340/** 341 * Defines SymbolSpan Component instance. 342 * 343 * @syscap SystemCapability.ArkUI.ArkUI.Full 344 * @crossplatform 345 * @form 346 * @atomicservice 347 * @since 20 348 */ 349declare const SymbolSpanInstance: SymbolSpanAttribute; 350