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