/* * Copyright (c) 2021-2023 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file * @kit ArkUI */ /*** if arkts 1.2 */ import { Resource } from '../../global/resource'; import { ResourceColor } from './units'; import { CommonConfiguration, Callback, CommonMethod, ContentModifier, Bindable } from './common'; /*** endif */ /** * Declare the type of status button * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Declare the type of status button * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Declare the type of status button * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Declare the type of status button * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ declare enum ToggleType { /** * Checkbox * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Checkbox * * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Checkbox * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Checkbox * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ Checkbox, /** * Switch * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Switch * * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Switch * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Switch * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ Switch, /** * Button * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Button * * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Button * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Button * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ Button, } /** * Defines the switch style. * * @interface SwitchStyle * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ declare interface SwitchStyle { /** * Set the radius of the point of the switch. * * @type { ?(number | Resource) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ pointRadius?: number | Resource; /** * Set the color of the unselected switch. * * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ unselectedColor?: ResourceColor; /** * Set the color of the point of the switch. * * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ pointColor?: ResourceColor; /** * Set the border radius of the track of the switch. * * @type { ?(number | Resource) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ trackBorderRadius?: number | Resource; } /** * ToggleConfiguration used by toggle Modifier * * @extends CommonConfiguration * @interface ToggleConfiguration * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ declare interface ToggleConfiguration extends CommonConfiguration { /** * Indicates whether the Toggle is on. * * @type { boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ isOn: boolean; /** * Indicates whether the Toggle is enabled. * * @type { boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ enabled: boolean; /** * Trigger toggle select change * * @type { Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ triggerChange: Callback; } /** * Defines the toggle options. * * @interface ToggleOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ declare interface ToggleOptions { /** * Type of the toggle. * * @type { ToggleType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Type of the toggle. * * @type { ToggleType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Type of the toggle. * * @type { ToggleType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Type of the toggle. * * @type { ToggleType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since 11 */ /** * Type of the toggle. * Anonymous Object Rectification. * * @type { ToggleType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ type: ToggleType; /** * Whether the toggle is on. * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Whether the toggle is on. * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Whether the toggle is on. * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Whether the toggle is on. * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since 11 */ /** * Whether the toggle is on. * Anonymous Object Rectification. * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ isOn?: boolean } /** * Defines the toggle interface. * * @interface ToggleInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Defines the toggle interface. * * @interface ToggleInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Defines the toggle interface. * * @interface ToggleInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Defines the toggle interface. * * @interface ToggleInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ interface ToggleInterface { /** * Set parameters to obtain the toggle. * * @param { object } options * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Set parameters to obtain the toggle. * * @param { object } options * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Set parameters to obtain the toggle. * * @param { object } options * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Set parameters to obtain the toggle. * * @param { object } options * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since 11 */ /** * Set parameters to obtain the toggle. * Anonymous Object Rectification. * * @param { ToggleOptions } options - toggle options * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ (options: ToggleOptions): ToggleAttribute; } /** * Defines the toggle attribute functions * * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Defines the toggle attribute functions * * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Defines the toggle attribute functions * * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Defines the toggle attribute functions * * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ declare class ToggleAttribute extends CommonMethod { /** * Called when the selected state of the component changes. * * @param { function } callback * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Called when the selected state of the component changes. * * @param { function } callback * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Called when the selected state of the component changes. * * @param { function } callback * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Called when the selected state of the component changes. * * @param { function } callback * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ onChange(callback: (isOn: boolean) => void): ToggleAttribute; /** * Set the content modifier of toggle. * * @param { ContentModifier } modifier - The content modifier of toggle. * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): ToggleAttribute; /** * Called when the color of the selected button is set. * * @param { ResourceColor } value * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Called when the color of the selected button is set. * * @param { ResourceColor } value * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Called when the color of the selected button is set. * * @param { ResourceColor } value * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Called when the color of the selected button is set. * * @param { ResourceColor } value * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ selectedColor(value: ResourceColor): ToggleAttribute; /** * Called when the color of the selected button is set. * * @param { ResourceColor } color * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Called when the color of the selected button is set. * * @param { ResourceColor } color * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Called when the color of the selected button is set. * * @param { ResourceColor } color * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Called when the color of the selected button is set. * * @param { ResourceColor } color * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ switchPointColor(color: ResourceColor): ToggleAttribute; /** * Set the style of the switch. * * @param { SwitchStyle } value * @returns { ToggleAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ switchStyle(value: SwitchStyle): ToggleAttribute; } /** * Defines Toggle Component. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Defines Toggle Component. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Defines Toggle Component. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Defines Toggle Component. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since 11 */ declare const Toggle: ToggleInterface; /** * Defines Toggle Component instance. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Defines Toggle Component instance. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 */ /** * Defines Toggle Component instance. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @since 10 */ /** * Defines Toggle Component instance. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice * @since 11 */ declare const ToggleInstance: ToggleAttribute;