mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 14:13:45 +00:00
345 lines
8.8 KiB
TypeScript
345 lines
8.8 KiB
TypeScript
/*
|
|
* 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
|
|
*/
|
|
|
|
import { Callback } from './@ohos.base';
|
|
|
|
/**
|
|
* Used to do mediaquery operations.
|
|
*
|
|
* @namespace mediaquery
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @since 7
|
|
*/
|
|
/**
|
|
* Used to do mediaquery operations.
|
|
*
|
|
* @namespace mediaquery
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Used to do mediaquery operations.
|
|
*
|
|
* @namespace mediaquery
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Used to do mediaquery operations.
|
|
*
|
|
* @namespace mediaquery
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @form
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
declare namespace mediaquery {
|
|
|
|
/**
|
|
* Defines the Result of mediaquery.
|
|
*
|
|
* @interface MediaQueryResult
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @since 7
|
|
*/
|
|
/**
|
|
* Defines the Result of mediaquery.
|
|
*
|
|
* @interface MediaQueryResult
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Defines the Result of mediaquery.
|
|
*
|
|
* @interface MediaQueryResult
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Defines the Result of mediaquery.
|
|
*
|
|
* @interface MediaQueryResult
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @form
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
interface MediaQueryResult {
|
|
/**
|
|
* Whether the match condition is met.
|
|
* This parameter is read-only.
|
|
*
|
|
* @type { boolean }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @since 7
|
|
*/
|
|
/**
|
|
* Whether the match condition is met.
|
|
* This parameter is read-only.
|
|
*
|
|
* @type { boolean }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Whether the match condition is met.
|
|
* This parameter is read-only.
|
|
*
|
|
* @type { boolean }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Whether the match condition is met.
|
|
* This parameter is read-only.
|
|
*
|
|
* @type { boolean }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @form
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
readonly matches: boolean;
|
|
|
|
/**
|
|
* Matching condition of a media event.
|
|
* This parameter is read-only.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @since 7
|
|
*/
|
|
/**
|
|
* Matching condition of a media event.
|
|
* This parameter is read-only.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Matching condition of a media event.
|
|
* This parameter is read-only.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Matching condition of a media event.
|
|
* This parameter is read-only.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @form
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
readonly media: string;
|
|
}
|
|
|
|
/**
|
|
* Defines the Listener of mediaquery.
|
|
*
|
|
* @interface MediaQueryListener
|
|
* @extends MediaQueryResult
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @since 7
|
|
*/
|
|
/**
|
|
* Defines the Listener of mediaquery.
|
|
*
|
|
* @interface MediaQueryListener
|
|
* @extends MediaQueryResult
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Defines the Listener of mediaquery.
|
|
*
|
|
* @interface MediaQueryListener
|
|
* @extends MediaQueryResult
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Defines the Listener of mediaquery.
|
|
*
|
|
* @interface MediaQueryListener
|
|
* @extends MediaQueryResult
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @form
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
interface MediaQueryListener extends MediaQueryResult {
|
|
/**
|
|
* Registers a callback with the corresponding query condition by using the handle.
|
|
* This callback is triggered when the media attributes change.
|
|
*
|
|
* @param { 'change' } type
|
|
* @param { Callback<MediaQueryResult> } callback
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @since 7
|
|
*/
|
|
/**
|
|
* Registers a callback with the corresponding query condition by using the handle.
|
|
* This callback is triggered when the media attributes change.
|
|
*
|
|
* @param { 'change' } type
|
|
* @param { Callback<MediaQueryResult> } callback
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Registers a callback with the corresponding query condition by using the handle.
|
|
* This callback is triggered when the media attributes change.
|
|
*
|
|
* @param { 'change' } type
|
|
* @param { Callback<MediaQueryResult> } callback
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Registers a callback with the corresponding query condition by using the handle.
|
|
* This callback is triggered when the media attributes change.
|
|
*
|
|
* @param { 'change' } type
|
|
* @param { Callback<MediaQueryResult> } callback
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @form
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
on(type: 'change', callback: Callback<MediaQueryResult>): void;
|
|
|
|
/**
|
|
* Deregisters a callback with the corresponding query condition by using the handle.
|
|
* This callback is not triggered when the media attributes chang.
|
|
*
|
|
* @param { 'change' } type
|
|
* @param { Callback<MediaQueryResult> } callback
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @since 7
|
|
*/
|
|
/**
|
|
* Deregisters a callback with the corresponding query condition by using the handle.
|
|
* This callback is not triggered when the media attributes chang.
|
|
*
|
|
* @param { 'change' } type
|
|
* @param { Callback<MediaQueryResult> } callback
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Deregisters a callback with the corresponding query condition by using the handle.
|
|
* This callback is not triggered when the media attributes chang.
|
|
*
|
|
* @param { 'change' } type
|
|
* @param { Callback<MediaQueryResult> } callback
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Deregisters a callback with the corresponding query condition by using the handle.
|
|
* This callback is not triggered when the media attributes chang.
|
|
*
|
|
* @param { 'change' } type
|
|
* @param { Callback<MediaQueryResult> } callback
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @form
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
off(type: 'change', callback?: Callback<MediaQueryResult>): void;
|
|
}
|
|
|
|
/**
|
|
* Sets the media query criteria and returns the corresponding listening handle
|
|
*
|
|
* @param { string } condition
|
|
* @returns { MediaQueryListener }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @since 7
|
|
*/
|
|
/**
|
|
* Sets the media query criteria and returns the corresponding listening handle
|
|
*
|
|
* @param { string } condition
|
|
* @returns { MediaQueryListener }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Sets the media query criteria and returns the corresponding listening handle
|
|
*
|
|
* @param { string } condition
|
|
* @returns { MediaQueryListener }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Sets the media query criteria and returns the corresponding listening handle
|
|
*
|
|
* @param { string } condition
|
|
* @returns { MediaQueryListener }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @form
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function matchMediaSync(condition: string): MediaQueryListener;
|
|
}
|
|
|
|
export default mediaquery;
|