• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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/**
22 * Provides an interface for SymbolSpan.
23 *
24 * @interface SymbolSpanInterface
25 * @syscap SystemCapability.ArkUI.ArkUI.Full
26 * @crossplatform
27 * @since 11
28 */
29/**
30 * Provides an interface for SymbolSpan.
31 *
32 * @interface SymbolSpanInterface
33 * @syscap SystemCapability.ArkUI.ArkUI.Full
34 * @crossplatform
35 * @form
36 * @atomicservice
37 * @since 12
38 */
39interface SymbolSpanInterface {
40  /**
41   * Called when resource is entered in SymbolSpan.
42   *
43   * @param { Resource } value
44   * @returns { SymbolSpanAttribute }
45   * @syscap SystemCapability.ArkUI.ArkUI.Full
46   * @crossplatform
47   * @since 11
48   */
49  /**
50   * Called when resource is entered in SymbolSpan.
51   *
52   * @param { Resource } value
53   * @returns { SymbolSpanAttribute }
54   * @syscap SystemCapability.ArkUI.ArkUI.Full
55   * @crossplatform
56   * @form
57   * @atomicservice
58   * @since 12
59   */
60  (value: Resource): SymbolSpanAttribute;
61}
62
63/**
64 * Provides attribute for SymbolSpan.
65 *
66 * @extends CommonMethod<SymbolSpanAttribute>
67 * @syscap SystemCapability.ArkUI.ArkUI.Full
68 * @crossplatform
69 * @since 11
70 */
71/**
72 * Provides attribute for SymbolSpan.
73 *
74 * @extends CommonMethod<SymbolSpanAttribute>
75 * @syscap SystemCapability.ArkUI.ArkUI.Full
76 * @crossplatform
77 * @form
78 * @atomicservice
79 * @since 12
80 */
81declare class SymbolSpanAttribute extends CommonMethod<SymbolSpanAttribute> {
82  /**
83   * Called when the SymbolSpan size is set.
84   *
85   * @param { number | string | Resource } value
86   * @returns { SymbolSpanAttribute }
87   * @syscap SystemCapability.ArkUI.ArkUI.Full
88   * @crossplatform
89   * @since 11
90   */
91  /**
92   * Called when the SymbolSpan size is set.
93   *
94   * @param { number | string | Resource } value
95   * @returns { SymbolSpanAttribute }
96   * @syscap SystemCapability.ArkUI.ArkUI.Full
97   * @crossplatform
98   * @form
99   * @atomicservice
100   * @since 12
101   */
102  fontSize(value: number | string | Resource): SymbolSpanAttribute;
103
104  /**
105   * Called when the SymbolSpan color is set.
106   *
107   * @param { Array<ResourceColor> } value
108   * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph.
109   * @syscap SystemCapability.ArkUI.ArkUI.Full
110   * @crossplatform
111   * @since 11
112   */
113  /**
114   * Called when the SymbolSpan color is set.
115   *
116   * @param { Array<ResourceColor> } value
117   * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph.
118   * @syscap SystemCapability.ArkUI.ArkUI.Full
119   * @crossplatform
120   * @form
121   * @atomicservice
122   * @since 12
123   */
124  fontColor(value: Array<ResourceColor>): SymbolSpanAttribute;
125
126  /**
127   * Called when the font SymbolSpan weight is set.
128   *
129   * @param { number | FontWeight | string } value
130   * @returns { SymbolSpanAttribute }
131   * @syscap SystemCapability.ArkUI.ArkUI.Full
132   * @crossplatform
133   * @since 11
134   */
135  /**
136   * Called when the font SymbolSpan weight is set.
137   *
138   * @param { number | FontWeight | string } value
139   * @returns { SymbolSpanAttribute }
140   * @syscap SystemCapability.ArkUI.ArkUI.Full
141   * @crossplatform
142   * @form
143   * @atomicservice
144   * @since 12
145   */
146  fontWeight(value: number | FontWeight | string): SymbolSpanAttribute;
147
148  /**
149   * Called when the SymbolSpan effect is set.
150   *
151   * @param { SymbolEffectStrategy } value
152   * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph.
153   * @syscap SystemCapability.ArkUI.ArkUI.Full
154   * @crossplatform
155   * @since 11
156   */
157  /**
158   * Called when the SymbolSpan effect is set.
159   *
160   * @param { SymbolEffectStrategy } value
161   * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph.
162   * @syscap SystemCapability.ArkUI.ArkUI.Full
163   * @crossplatform
164   * @form
165   * @atomicservice
166   * @since 12
167   */
168  effectStrategy(value: SymbolEffectStrategy): SymbolSpanAttribute;
169
170  /**
171   * Called when the SymbolSpan rendering strategy is set.
172   *
173   * @param { SymbolRenderingStrategy } value
174   * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph.
175   * @syscap SystemCapability.ArkUI.ArkUI.Full
176   * @crossplatform
177   * @since 11
178   */
179  /**
180   * Called when the SymbolSpan rendering strategy is set.
181   *
182   * @param { SymbolRenderingStrategy } value
183   * @returns { SymbolSpanAttribute } The attribute of the SymbolGlyph.
184   * @syscap SystemCapability.ArkUI.ArkUI.Full
185   * @crossplatform
186   * @form
187   * @atomicservice
188   * @since 12
189   */
190  renderingStrategy(value: SymbolRenderingStrategy): SymbolSpanAttribute;
191
192  /**
193   * Sets the attribute modifier.
194   *
195   * @param { AttributeModifier<SymbolSpanAttribute> } modifier - The instance of symbol span modifier.
196   * @returns { SymbolSpanAttribute } the attribute of the SymbolSpanAttribute.
197   * @syscap SystemCapability.ArkUI.ArkUI.Full
198   * @crossplatform
199   * @atomicservice
200   * @since 12
201   */
202  attributeModifier(modifier: AttributeModifier<SymbolSpanAttribute>): SymbolSpanAttribute;
203}
204
205/**
206 * Defines SymbolSpan Component.
207 *
208 * @syscap SystemCapability.ArkUI.ArkUI.Full
209 * @crossplatform
210 * @since 11
211 */
212/**
213 * Defines SymbolSpan Component.
214 *
215 * @syscap SystemCapability.ArkUI.ArkUI.Full
216 * @crossplatform
217 * @form
218 * @atomicservice
219 * @since 12
220 */
221declare const SymbolSpan: SymbolSpanInterface;
222
223/**
224 * Defines SymbolSpan Component instance.
225 *
226 * @syscap SystemCapability.ArkUI.ArkUI.Full
227 * @crossplatform
228 * @since 11
229 */
230/**
231 * Defines SymbolSpan Component instance.
232 *
233 * @syscap SystemCapability.ArkUI.ArkUI.Full
234 * @crossplatform
235 * @form
236 * @atomicservice
237 * @since 12
238 */
239declare const SymbolSpanInstance: SymbolSpanAttribute;
240