• 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 * Span container interface.
23 *
24 * @interface ContainerSpanInterface
25 * @syscap SystemCapability.ArkUI.ArkUI.Full
26 * @crossplatform
27 * @since 11
28 */
29/**
30 * Span container interface.
31 *
32 * @interface ContainerSpanInterface
33 * @syscap SystemCapability.ArkUI.ArkUI.Full
34 * @crossplatform
35 * @atomicservice
36 * @since 12
37 */
38interface ContainerSpanInterface {
39  /**
40   * Called when container is entered in span.
41   *
42   * @returns { ContainerSpanAttribute } The attribute of the container span.
43   * @syscap SystemCapability.ArkUI.ArkUI.Full
44   * @crossplatform
45   * @since 11
46   */
47  /**
48   * Called when container is entered in span.
49   *
50   * @returns { ContainerSpanAttribute } The attribute of the container span.
51   * @syscap SystemCapability.ArkUI.ArkUI.Full
52   * @crossplatform
53   * @atomicservice
54   * @since 12
55   */
56  (): ContainerSpanAttribute;
57}
58
59/**
60 * Define the ContainerSpan attribute functions.
61 *
62 * @syscap SystemCapability.ArkUI.ArkUI.Full
63 * @crossplatform
64 * @since 11
65 */
66/**
67 * Define the ContainerSpan attribute functions.
68 *
69 * @syscap SystemCapability.ArkUI.ArkUI.Full
70 * @crossplatform
71 * @atomicservice
72 * @since 12
73 */
74declare class ContainerSpanAttribute {
75  /**
76   * Span background style.
77   *
78   * @param { TextBackgroundStyle } style - The background style of span.
79   * @returns { ContainerSpanAttribute }
80   * @syscap SystemCapability.ArkUI.ArkUI.Full
81   * @crossplatform
82   * @since 11
83   */
84  /**
85   * Span background style.
86   *
87   * @param { TextBackgroundStyle } style - The background style of span.
88   * @returns { ContainerSpanAttribute }
89   * @syscap SystemCapability.ArkUI.ArkUI.Full
90   * @crossplatform
91   * @atomicservice
92   * @since 12
93   */
94  textBackgroundStyle(style: TextBackgroundStyle): ContainerSpanAttribute;
95
96  /**
97   * Sets the attribute modifier.
98   *
99   * @param { AttributeModifier<ContainerSpanAttribute> } modifier - The instance of contain span modifier.
100   * @returns { ContainerSpanAttribute } the attribute of the ContainerSpanAttribute.
101   * @syscap SystemCapability.ArkUI.ArkUI.Full
102   * @crossplatform
103   * @atomicservice
104   * @since 12
105   */
106  attributeModifier(modifier: AttributeModifier<ContainerSpanAttribute>): ContainerSpanAttribute;
107}
108
109/**
110 * Defines ContainerSpan Component instance.
111 *
112 * @syscap SystemCapability.ArkUI.ArkUI.Full
113 * @crossplatform
114 * @since 11
115 */
116/**
117 * Defines ContainerSpan Component instance.
118 *
119 * @syscap SystemCapability.ArkUI.ArkUI.Full
120 * @crossplatform
121 * @atomicservice
122 * @since 12
123 */
124declare const ContainerSpan: ContainerSpanInterface;
125
126/**
127 * Defines ContainerSpan Component.
128 *
129 * @syscap SystemCapability.ArkUI.ArkUI.Full
130 * @crossplatform
131 * @since 11
132 */
133/**
134 * Defines ContainerSpan Component.
135 *
136 * @syscap SystemCapability.ArkUI.ArkUI.Full
137 * @crossplatform
138 * @atomicservice
139 * @since 12
140 */
141declare const ContainerSpanInstance: ContainerSpanAttribute;
142