/* * 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 { CommonMethod, Bindable } from './common' /*** endif */ /** * Defines the grid item style. * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 11 */ /** * Defines the grid item style. * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ declare enum GridItemStyle { /** * Show none style. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 11 */ /** * Show none style. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ NONE = 0, /** * Show plain style. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 11 */ /** * Show plain style. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ PLAIN = 1, } /** * Defines the grid item options. * * @interface GridItemOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 11 */ /** * Defines the grid item options. * * @interface GridItemOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ declare interface GridItemOptions { /** * Describes the GridItem style. * * @type { ?GridItemStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 11 */ /** * Describes the GridItem style. * * @type { ?GridItemStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ style?: GridItemStyle; } /** * Mesh container for static fixed-size layout scenarios. * * @interface GridItemInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Mesh container for static fixed-size layout scenarios. * * @interface GridItemInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Mesh container for static fixed-size layout scenarios. * * @interface GridItemInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ interface GridItemInterface { /** * Return to get GridItem. * * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Return to get GridItem. * * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Return to get GridItem. * * @param { GridItemOptions } value - Defines the grid item options. * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ (value?: GridItemOptions): GridItemAttribute; } /** * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ declare class GridItemAttribute extends CommonMethod { /** * This parameter specifies the start line number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * This parameter specifies the start line number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * This parameter specifies the start line number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ rowStart(value: number): GridItemAttribute; /** * Specifies the end line number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Specifies the end line number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Specifies the end line number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ rowEnd(value: number): GridItemAttribute; /** * This parameter specifies the start column number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * This parameter specifies the start column number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * This parameter specifies the start column number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ columnStart(value: number): GridItemAttribute; /** * This parameter specifies the end column number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * This parameter specifies the end column number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * This parameter specifies the end column number of the current element. * * @param { number } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ columnEnd(value: number): GridItemAttribute; /** * This parameter specifies whether to recreate the node when the component build is triggered. * * @param { boolean } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 * @deprecated since 9 */ forceRebuild(value: boolean): GridItemAttribute; /** * Called when judging whether it is selectable. * * @param { boolean } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Called when judging whether it is selectable. * * @param { boolean } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Called when judging whether it is selectable. * * @param { boolean } value * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ selectable(value: boolean): GridItemAttribute; /** * Called when judging whether it is selected. * This parameter supports $$ for two-way binding of variables. * * @param { boolean } value - if the gridItem is selected. * @returns { GridItemAttribute } the attribute of the gridItem. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Called when judging whether it is selected. * This parameter supports $$ for two-way binding of variables. * * @param { boolean } value - if the gridItem is selected. * @returns { GridItemAttribute } the attribute of the gridItem. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ selected(value: boolean): GridItemAttribute; /** * Called when judging whether it is selected. * This parameter supports $$ for two-way binding of variables. * * @param { boolean | Bindable } value * @returns { GridItemAttribute } the attribute of the gridItem. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 20 * @arkts 1.2 */ selected(value: boolean | Bindable): GridItemAttribute; /** * Called when the gridItem is selected. * * @param { function } event * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ /** * Called when the gridItem is selected. * * @param { function } event * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Called when the gridItem is selected. * * @param { function } event * @returns { GridItemAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ onSelect(event: (isSelected: boolean) => void): GridItemAttribute; } /** * Defines GridItem Component. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Defines GridItem Component. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Defines GridItem Component. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ declare const GridItem: GridItemInterface /** * Defines GridItem Component instance. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * Defines GridItem Component instance. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** * Defines GridItem Component instance. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 11 */ declare const GridItemInstance: GridItemAttribute;