interface_sdk-js/api/@ohos.arkui.drawableDescriptor.d.ts
h30043025 94b5e0b143 js DOC 整改 15
Signed-off-by: h30043025 <hangjian1@huawei.com>
2023-07-24 14:27:47 +08:00

89 lines
2.5 KiB
TypeScript

/*
* Copyright (c) 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.
*/
import image from './@ohos.multimedia.image';
/**
* Use the DrawableDescriptor class to get drawable image.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
export class DrawableDescriptor {
/**
* Creates a new DrawableDescriptor.
*
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi Hide this for inner system use.
* @since 10
*/
constructor();
/**
* Get pixelMap of drawable image.
*
* @returns { image.PixelMap } Return the PixelMap of the calling DrawableDescriptor object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
getPixelMap(): image.PixelMap;
}
/**
* Use the LayeredDrawableDescriptor class to get the foreground, the background and the mask DrawableDescriptor.
*
* @extends DrawableDescriptor
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
export class LayeredDrawableDescriptor extends DrawableDescriptor {
/**
* Get DrawableDescriptor for the foreground.
*
* @returns { DrawableDescriptor } Return the DrawableDescriptor object of foreground.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
getForeground(): DrawableDescriptor;
/**
* Get DrawableDescriptor for the background.
*
* @returns { DrawableDescriptor } Return the DrawableDescriptor object of background.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
getBackground(): DrawableDescriptor;
/**
* Get DrawableDescriptor for the mask.
*
* @returns { DrawableDescriptor } Return the DrawableDescriptor object of mask.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
getMask(): DrawableDescriptor;
/**
* Get the clip path info of the adaptive icon mask.
*
* @returns { string } Return the clip path info of mask.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 10
*/
static getMaskClipPath(): string;
}