mirror of
https://github.com/openharmony/windowmanager.git
synced 2026-07-19 17:08:11 -04:00
chyyy0213
20fe7a2111
Signed-off-by: chyyy0213 <chenhaiying3@huawei.com> Change-Id: I867f7189636ae398753848bd4f09bcb10317602b Signed-off-by: chyyy0213 <chenhaiying3@huawei.com>
1217 lines
31 KiB
TypeScript
1217 lines
31 KiB
TypeScript
/*
|
|
* Copyright (c) 2021-2022 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 { AsyncCallback, Callback } from './basic' ;
|
|
import { Context } from './app/context';
|
|
import { ContenStorage } from './@internal/component/ets/stateManagement'
|
|
/**
|
|
* Window manager.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
*/
|
|
declare namespace window {
|
|
/**
|
|
* The type of a window.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
*/
|
|
enum WindowType {
|
|
/**
|
|
* App.
|
|
*/
|
|
TYPE_APP,
|
|
/**
|
|
* System alert.
|
|
*/
|
|
TYPE_SYSTEM_ALERT,
|
|
/**
|
|
* Input method.
|
|
*/
|
|
TYPE_INPUT_METHOD,
|
|
/**
|
|
* Status bar.
|
|
*/
|
|
TYPE_STATUS_BAR,
|
|
/**
|
|
* Notification hubs.
|
|
*/
|
|
TYPE_PANEL,
|
|
/**
|
|
* Screen lock.
|
|
*/
|
|
TYPE_KEYGUARD,
|
|
/**
|
|
* Volume bar.
|
|
*/
|
|
TYPE_VOLUME_OVERLAY,
|
|
/**
|
|
* Navigation bar.
|
|
*/
|
|
TYPE_NAVIGATION_BAR,
|
|
|
|
/**
|
|
* System gesture.
|
|
*/
|
|
TYPE_SYSTEM_GESTURE,
|
|
}
|
|
|
|
/**
|
|
* Describes the type of avoid area
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
enum AvoidAreaType {
|
|
/**
|
|
* Default area of the system
|
|
*/
|
|
TYPE_SYSTEM,
|
|
|
|
/**
|
|
* Notch
|
|
*/
|
|
TYPE_CUTOUT,
|
|
|
|
/**
|
|
* area for system gesture
|
|
*/
|
|
TYPE_SYSTEM_GESTURE,
|
|
|
|
/**
|
|
* area for soft input keyboard
|
|
* @since 9
|
|
*/
|
|
TYPE_KEYBOARD
|
|
}
|
|
|
|
/**
|
|
* Describes the scale Transition Options of window
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 9
|
|
* @systemapi
|
|
*/
|
|
declare interface ScaleOptions {
|
|
/**
|
|
* The scale param of x direction. Default is 1.f
|
|
*/
|
|
x?: number;
|
|
/**
|
|
* The scale param of y direction. Default is 1.f
|
|
*/
|
|
y?: number;
|
|
/**
|
|
* The scale param of pivot point of x. Default is 0.5f, Interval is 0.f - 1.f
|
|
*/
|
|
pivotX?: number;
|
|
/**
|
|
* The scale param of pivot point of y. Default is 0.5f, Interval is 0.f - 1.f
|
|
*/
|
|
pivotY?: number;
|
|
}
|
|
|
|
/**
|
|
* Describes the rotate Transition Options of window
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 9
|
|
* @systemapi
|
|
*/
|
|
declare interface RotateOptions {
|
|
/**
|
|
* The rotate degree of x direction. Default value is 0.f
|
|
*/
|
|
x?: number;
|
|
/**
|
|
* The rotate degree of y direction. Default value is 0.f
|
|
*/
|
|
y?: number;
|
|
/**
|
|
* The rotate degree of z direction. Default value is 0.f
|
|
*/
|
|
z?: number;
|
|
/**
|
|
* The param of pivot point of x. Default is 0.5f, Interval is 0.f - 1.f
|
|
*/
|
|
pivotX?: number;
|
|
/**
|
|
* The param of pivot point of y. Default is 0.5f, Interval is 0.f - 1.f
|
|
*/
|
|
pivotY?: number;
|
|
}
|
|
|
|
/**
|
|
* Describes the translate Transition Options of window
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 9
|
|
* @systemapi
|
|
*/
|
|
declare interface TranslateOptions {
|
|
/**
|
|
* The translate pixel param of x direction. Default is 0.f
|
|
*/
|
|
x?: number;
|
|
/**
|
|
* The translate pixel param of y direction. Default is 0.f
|
|
*/
|
|
y?: number;
|
|
/**
|
|
* The translate pixel param of z direction. Default is 0.f
|
|
*/
|
|
z?: number;
|
|
}
|
|
|
|
/**
|
|
* Describes the window mode of an application
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
enum WindowMode {
|
|
UNDEFINED = 1,
|
|
FULLSCREEN,
|
|
PRIMARY,
|
|
SECONDARY,
|
|
FLOATING
|
|
}
|
|
|
|
/**
|
|
* Describes the mode of window layout
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 9
|
|
*/
|
|
enum WindowLayoutMode {
|
|
/**
|
|
* CASCADE
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 9
|
|
*/
|
|
WINDOW_LAYOUT_MODE_CASCADE,
|
|
/**
|
|
* TILE
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 9
|
|
*/
|
|
WINDOW_LAYOUT_MODE_TILE
|
|
}
|
|
|
|
/**
|
|
* Create a sub window with a specific id and type.
|
|
* @param id Indicates window id.
|
|
* @param type Indicates window type.
|
|
* @since 7
|
|
*/
|
|
function create(id: string, type: WindowType, callback: AsyncCallback<Window>): void;
|
|
|
|
/**
|
|
* Create a sub window with a specific id and type.
|
|
* @param id Indicates window id.
|
|
* @param type Indicates window type.
|
|
* @since 7
|
|
*/
|
|
function create(id: string, type: WindowType): Promise<Window>;
|
|
|
|
/**
|
|
* Create a system window with a specific id and type.
|
|
* @param ctx Indicates the context on which the window depends
|
|
* @param id Indicates window id.
|
|
* @param type Indicates window type.
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 8
|
|
*/
|
|
function create(ctx: Context, id: string, type: WindowType): Promise<Window>;
|
|
|
|
/**
|
|
* Find the window by id.
|
|
* @param id Indicates window id.
|
|
* @since 7
|
|
*/
|
|
function find(id: string, callback: AsyncCallback<Window>): void;
|
|
|
|
/**
|
|
* Find the window by id.
|
|
* @param id Indicates window id.
|
|
* @since 7
|
|
*/
|
|
function find(id: string): Promise<Window>;
|
|
|
|
/**
|
|
* Get the final show window.
|
|
* @param id Indicates window id.
|
|
* @since 6
|
|
*/
|
|
function getTopWindow(callback: AsyncCallback<Window>): void;
|
|
|
|
/**
|
|
* Get the final show window.
|
|
* @since 6
|
|
*/
|
|
function getTopWindow(): Promise<Window>;
|
|
|
|
/**
|
|
* Get the final show window.
|
|
* @param ctx Indicates the context on which the window depends
|
|
* @since 8
|
|
*/
|
|
function getTopWindow(ctx: Context): Promise<Window>;
|
|
|
|
/**
|
|
* Get the final show window.
|
|
* @param ctx Indicates the context on which the window depends
|
|
* @since 8
|
|
*/
|
|
function getTopWindow(ctx: Context, callback: AsyncCallback<Window>): void;
|
|
|
|
/**
|
|
* minimize all app windows.
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 8
|
|
*/
|
|
function minimizeAll(id: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* minimize all app windows.
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 8
|
|
*/
|
|
function minimizeAll(id: number): Promise<void>;
|
|
|
|
/**
|
|
* Toggle shown state for all app windows. Minimize or restore all app windows.
|
|
* @systemapi Minimize or restore all app windows for inner system use.
|
|
* @since 9
|
|
*/
|
|
function toggleShownStateForAllAppWindows(callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Toggle shown state for all app windows. Minimize or restore all app windows.
|
|
* @systemapi Minimize or restore all app windows for inner system use.
|
|
* @since 9
|
|
*/
|
|
function toggleShownStateForAllAppWindows(): Promise<void>;
|
|
|
|
/**
|
|
* Set the layout mode of a window.
|
|
* @param mode the layout mode of a window.
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 9
|
|
*/
|
|
function setWindowLayoutMode(mode: WindowLayoutMode, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Set the layout mode of a window.
|
|
* @param mode the layout mode of a window.
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 9
|
|
*/
|
|
function setWindowLayoutMode(mode: WindowLayoutMode): Promise<void>;
|
|
|
|
/**
|
|
* register the callback of systemBarTintChange
|
|
* @param type: 'systemBarTintChange'
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 8
|
|
*/
|
|
function on(type: 'systemBarTintChange', callback: Callback<SystemBarTintState>): void;
|
|
|
|
/**
|
|
* register the callback of keyboardHeightChange
|
|
* @param type: 'keyboardHeightChange'
|
|
* @since 7
|
|
*/
|
|
function on(type: 'keyboardHeightChange', callback: Callback<number>): void;
|
|
|
|
/**
|
|
* unregister the callback of systemBarTintChange
|
|
* @param type: 'systemBarTintChange'
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 8
|
|
*/
|
|
function off(type: 'systemBarTintChange', callback?: Callback<SystemBarTintState>): void;
|
|
|
|
|
|
/**
|
|
* unregister the callback of keyboardHeightChange
|
|
* @param type: 'keyboardHeightChange'
|
|
* @since 7
|
|
*/
|
|
function off(type: 'keyboardHeightChange', callback?: Callback<number>): void;
|
|
|
|
/**
|
|
* Properties of status bar and navigation bar, it couldn't update automatically
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 6
|
|
*/
|
|
interface SystemBarProperties {
|
|
/**
|
|
* the color of the status bar.
|
|
* @since 6
|
|
*/
|
|
statusBarColor?: string;
|
|
|
|
/**
|
|
* the light icon of the status bar.
|
|
* @since 7
|
|
*/
|
|
isStatusBarLightIcon?: boolean;
|
|
|
|
/**
|
|
* the content color of the status bar
|
|
* @since 8
|
|
*/
|
|
statusBarContentColor?: string;
|
|
|
|
/**
|
|
* the color of the navigation bar.
|
|
* @since 6
|
|
*/
|
|
navigationBarColor?: string;
|
|
|
|
/**
|
|
* the light icon of the navigation bar.
|
|
* @since 7
|
|
*/
|
|
isNavigationBarLightIcon?: boolean;
|
|
|
|
/**
|
|
* the content color of the navigation bar
|
|
* @since 8
|
|
*/
|
|
navigationBarContentColor?: string;
|
|
}
|
|
|
|
/**
|
|
* system bar tint of region
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 8
|
|
*/
|
|
interface SystemBarRegionTint {
|
|
/**
|
|
* system bar type
|
|
*/
|
|
type: WindowType;
|
|
|
|
/**
|
|
* the visibility of system bar
|
|
*/
|
|
isEnable?: boolean;
|
|
|
|
/**
|
|
* the region of system bar
|
|
*/
|
|
region?: Rect;
|
|
|
|
/**
|
|
* the background color of the system bar.
|
|
*/
|
|
backgroundColor?: string;
|
|
|
|
/**
|
|
* the content color of the system bar.
|
|
*/
|
|
contentColor?: string
|
|
}
|
|
|
|
/**
|
|
* system bar tint state for systemui
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 8
|
|
*/
|
|
interface SystemBarTintState {
|
|
/**
|
|
* id of display
|
|
*/
|
|
displayId: number;
|
|
/**
|
|
* region tint of systembar
|
|
*/
|
|
regionTint: Array<SystemBarRegionTint>;
|
|
}
|
|
|
|
/**
|
|
* Rectangle
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
interface Rect {
|
|
left: number;
|
|
|
|
top: number;
|
|
|
|
width: number;
|
|
|
|
height: number;
|
|
}
|
|
|
|
/**
|
|
* avoid area
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
interface AvoidArea {
|
|
/**
|
|
* Whether avoidArea is visible on screen
|
|
* @since 9
|
|
*/
|
|
visible: boolean;
|
|
|
|
/**
|
|
* Rectangle on the left of the screen
|
|
*/
|
|
leftRect: Rect;
|
|
|
|
/**
|
|
* Rectangle on the top of the screen
|
|
*/
|
|
topRect: Rect;
|
|
|
|
/**
|
|
* Rectangle on the right of the screen
|
|
*/
|
|
rightRect: Rect;
|
|
|
|
/**
|
|
* Rectangle on the bottom of the screen
|
|
*/
|
|
bottomRect: Rect;
|
|
}
|
|
|
|
/**
|
|
* window size
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
interface Size {
|
|
/**
|
|
* the width of the window.
|
|
*/
|
|
width: number;
|
|
|
|
/**
|
|
* the height of the window.
|
|
*/
|
|
height: number;
|
|
}
|
|
|
|
/**
|
|
* Properties of window, it couldn't update automatically
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 6
|
|
*/
|
|
interface WindowProperties {
|
|
/**
|
|
* the position and size of the window
|
|
* @since 7
|
|
*/
|
|
windowRect: Rect;
|
|
|
|
/**
|
|
* window type
|
|
* @since 7
|
|
*/
|
|
type: WindowType;
|
|
|
|
/**
|
|
* window name
|
|
* @since 8
|
|
*/
|
|
name: string;
|
|
|
|
/**
|
|
* Whether the window is displayed in full screen mode. The default value is false.
|
|
* @since 6
|
|
*/
|
|
isFullScreen: boolean
|
|
|
|
/**
|
|
* Whether the window layout is in full screen mode(whether the window is immersive). The default value is false.
|
|
* @since 6
|
|
*/
|
|
isLayoutFullScreen: boolean
|
|
|
|
/**
|
|
* Whether the window can gain focus. The default value is true
|
|
* @since 7
|
|
*/
|
|
focusable: boolean
|
|
|
|
/**
|
|
* Whether the window is touchable. The default value is false
|
|
* @since 6
|
|
*/
|
|
touchable: boolean
|
|
|
|
|
|
/**
|
|
* Brightness value of window.
|
|
* @since 7
|
|
*/
|
|
brightness: number
|
|
|
|
/**
|
|
* The dimbehind value of window.
|
|
* @since 7
|
|
*/
|
|
dimBehindValue: number
|
|
|
|
/**
|
|
* Whether keep screen on.
|
|
* @since 7
|
|
*/
|
|
isKeepScreenOn: boolean
|
|
|
|
/**
|
|
* Whether make window in privacy mode or not.
|
|
* @since 7
|
|
*/
|
|
isPrivacyMode: boolean
|
|
|
|
/**
|
|
* Whether is round corner or not.
|
|
* @since 7
|
|
*/
|
|
isRoundCorner: boolean
|
|
|
|
/**
|
|
* Whether is transparent or not.
|
|
* @since 7
|
|
*/
|
|
isTransparent: boolean
|
|
}
|
|
|
|
/**
|
|
* Type of allowing the specified of color space.
|
|
* @since 8
|
|
*/
|
|
enum ColorSpace {
|
|
/**
|
|
* Default color space.
|
|
*/
|
|
DEFAULT,
|
|
/**
|
|
* Wide gamut color space. The specific wide color gamut depends on thr screen.
|
|
*/
|
|
WIDE_GAMUT,
|
|
}
|
|
|
|
interface Window {
|
|
/**
|
|
* hide sub window.
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
hide (callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* hide sub window.
|
|
* @systemapi Hide this for inner system use.
|
|
* @since 7
|
|
*/
|
|
hide(): Promise<void>;
|
|
|
|
/**
|
|
* show sub window.
|
|
* @since 7
|
|
*/
|
|
show(callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* show sub window.
|
|
* @since 7
|
|
*/
|
|
show(): Promise<void>;
|
|
|
|
/**
|
|
* Destroy the sub window.
|
|
* @since 7
|
|
*/
|
|
destroy(callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Destroy the sub window.
|
|
* @since 7
|
|
*/
|
|
destroy(): Promise<void>;
|
|
|
|
/**
|
|
* Set the position of a window.
|
|
* @param x Indicate the X-coordinate of the window.
|
|
* @param y Indicate the Y-coordinate of the window.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
moveTo(x: number, y: number): Promise<void>;
|
|
|
|
/**
|
|
* Set the position of a window.
|
|
* @param x Indicate the X-coordinate of the window.
|
|
* @param y Indicate the Y-coordinate of the window.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
moveTo(x: number, y: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Set the size of a window .
|
|
* @param width Indicates the width of the window.
|
|
* @param height Indicates the height of the window.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
resize(width: number, height: number): Promise<void>;
|
|
|
|
/**
|
|
* Set the size of a window .
|
|
* @param width Indicates the width of the window.
|
|
* @param height Indicates the height of the window.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
resize(width: number, height: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Set the type of a window.
|
|
* @param windowType Indicate the type of a window.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
setWindowType(windowType: WindowType): Promise<void>;
|
|
|
|
/**
|
|
* Set the type of a window.
|
|
* @param windowType Indicate the type of a window.
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
setWindowType(windowType: WindowType, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* get the properties of current window
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 6
|
|
*/
|
|
getProperties(callback: AsyncCallback<WindowProperties>): void;
|
|
|
|
/**
|
|
* get the properties of current window
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 6
|
|
*/
|
|
getProperties(): Promise<WindowProperties>;
|
|
|
|
/**
|
|
* get the avoid area
|
|
* @param type Type of the area
|
|
* @since 7
|
|
*/
|
|
getAvoidArea(type: AvoidAreaType, callback: AsyncCallback<AvoidArea>): void;
|
|
|
|
/**
|
|
* get the avoid area
|
|
* @param type Type of the area
|
|
* @since 7
|
|
*/
|
|
getAvoidArea(type: AvoidAreaType): Promise<AvoidArea>;
|
|
|
|
/**
|
|
* set the flag of the window is shown full screen
|
|
* @param isFullScreen the flag of the window is shown full screen
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 6
|
|
*/
|
|
setFullScreen(isFullScreen: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* set the flag of the window is shown full screen
|
|
* @param isFullScreen the flag of the window is shown full screen
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 6
|
|
*/
|
|
setFullScreen(isFullScreen: boolean): Promise<void>;
|
|
|
|
/**
|
|
* set the property of the window can layout in full screen
|
|
* @param isLayoutFullScreen the window can layout in full screen
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
setLayoutFullScreen(isLayoutFullScreen: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* set the property of the window can layout in full screen
|
|
* @param isLayoutFullScreen the window can layout in full screen
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
setLayoutFullScreen(isLayoutFullScreen: boolean): Promise<void>;
|
|
|
|
/**
|
|
* set the system bar to have visible.
|
|
* @param names the set of system bar
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
setSystemBarEnable(names: Array<'status'|'navigation'>, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* set the system bar to have visible.
|
|
* @param names the set of system bar
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
setSystemBarEnable(names: Array<'status'|'navigation'>): Promise<void>;
|
|
|
|
/**
|
|
* set the background color of statusbar
|
|
* @param color the background color of statusbar
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 6
|
|
*/
|
|
setSystemBarProperties(systemBarProperties: SystemBarProperties, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* set the background color of statusbar
|
|
* @param color the background color of statusbar
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 6
|
|
*/
|
|
setSystemBarProperties(systemBarProperties: SystemBarProperties): Promise<void>;
|
|
|
|
/**
|
|
* Loads content
|
|
* @param path path Path of the page to which the content will be loaded
|
|
* @param storage storage The data object shared within the content instance loaded by the window
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 8
|
|
*/
|
|
loadContent(path: string, storage: ContenStorage, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Loads content
|
|
* @param path path of the page to which the content will be loaded
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
loadContent(path: string, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Loads content
|
|
* @param path path of the page to which the content will be loaded
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
loadContent(path: string, storage?: ContenStorage): Promise<void>;
|
|
|
|
/**
|
|
* register the callback of windowSizeChange
|
|
* @param type: 'windowSizeChange'
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
on(type: 'windowSizeChange', callback: Callback<Size>): void;
|
|
|
|
/**
|
|
* unregister the callback of windowSizeChange
|
|
* @param type: 'windowSizeChange'
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
*/
|
|
off(type: 'windowSizeChange', callback?: Callback<Size>): void;
|
|
|
|
/**
|
|
* register the callback of systemAvoidAreaChange
|
|
* @param type: 'systemAvoidAreaChange'
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
* @deprecated since 9, please use on_avoidAreaChange instead.
|
|
*/
|
|
on(type: 'systemAvoidAreaChange', callback: Callback<AvoidArea>): void;
|
|
|
|
/**
|
|
* unregister the callback of systemAvoidAreaChange
|
|
* @param type: 'systemAvoidAreaChange'
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 7
|
|
* @deprecated since 9, please use off_avoidAreaChange instead.
|
|
*/
|
|
off(type: 'systemAvoidAreaChange', callback?: Callback<AvoidArea>): void;
|
|
|
|
/**
|
|
* register the callback of avoidAreaChange
|
|
* @param type: 'avoidAreaChange'
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 9
|
|
*/
|
|
on(type: 'avoidAreaChange', callback: Callback<{ type: AvoidAreaType, area: AvoidArea }>): void;
|
|
|
|
/**
|
|
* unregister the callback of avoidAreaChange
|
|
* @param type: 'avoidAreaChange'
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 9
|
|
*/
|
|
off(type: 'avoidAreaChange', callback?: Callback<{ type: AvoidAreaType, area: AvoidArea }>): void;
|
|
|
|
/**
|
|
* Whether the window supports thr wide gamut setting.
|
|
* @since 8
|
|
*/
|
|
isSupportWideGamut(): Promise<boolean>;
|
|
|
|
/**
|
|
* Whether the window supports thr wide gamut setting.
|
|
* @since 8
|
|
*/
|
|
isSupportWideGamut(callback: AsyncCallback<boolean>): void;
|
|
|
|
/**
|
|
* Sets the specified color space.
|
|
* @param colorSpace the specified color space.
|
|
* @since 8
|
|
*/
|
|
setColorSpace(colorSpace:ColorSpace): Promise<void>;
|
|
|
|
/**
|
|
* Sets the specified color space.
|
|
* @param colorSpace the specified color space.
|
|
* @since 8
|
|
*/
|
|
setColorSpace(colorSpace:ColorSpace, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Obtains thr set color space.
|
|
* @since 8
|
|
*/
|
|
getColorSpace(): Promise<ColorSpace>;
|
|
|
|
/**
|
|
* Obtains thr set color space.
|
|
* @since 8
|
|
*/
|
|
getColorSpace(callback: AsyncCallback<ColorSpace>): void;
|
|
|
|
/**
|
|
* Sets the background color of window.
|
|
* @param color the specified color.
|
|
* @since 7
|
|
*/
|
|
setBackgroundColor(color: string): Promise<void>;
|
|
|
|
/**
|
|
* Sets the background color of window.
|
|
* @param color the specified color.
|
|
* @since 7
|
|
*/
|
|
setBackgroundColor(color: string, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets the brightness of window.
|
|
* @param brightness the specified brightness value.
|
|
* @since 7
|
|
*/
|
|
setBrightness(brightness: number): Promise<void>;
|
|
|
|
/**
|
|
* Sets the brightness of window.
|
|
* @param brightness the specified brightness value.
|
|
* @since 7
|
|
*/
|
|
setBrightness(brightness: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets the dimBehind of window.
|
|
* @param dimBehindValue the specified dimBehind.
|
|
* @since 7
|
|
*/
|
|
setDimBehind(dimBehindValue: number, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets the dimBehind of window.
|
|
* @param dimBehind the specified dimBehind.
|
|
* @since 7
|
|
*/
|
|
setDimBehind(dimBehindValue: number): Promise<void>;
|
|
|
|
/**
|
|
* Sets whether focusable or not.
|
|
* @param isFocusable can be focus if true, or can not be focus if false.
|
|
* @since 7
|
|
*/
|
|
setFocusable(isFocusable: boolean): Promise<void>;
|
|
|
|
/**
|
|
* Sets whether focusable or not.
|
|
* @param isFocusable can be focus if true, or can not be focus if false.
|
|
* @since 7
|
|
*/
|
|
setFocusable(isFocusable: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets whether keep screen on or not.
|
|
* @param isKeepScreenOn keep screen on if true, or not if false.
|
|
* @since 7
|
|
*/
|
|
setKeepScreenOn(isKeepScreenOn: boolean): Promise<void>;
|
|
|
|
/**
|
|
* Sets whether keep screen on or not.
|
|
* @param isKeepScreenOn keep screen on if true, or not if false.
|
|
* @since 7
|
|
*/
|
|
setKeepScreenOn(isKeepScreenOn: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets whether outside can be touch or not.
|
|
* @param touchable outside can be touch if true, or not if false.
|
|
* @since 7
|
|
*/
|
|
setOutsideTouchable(touchable: boolean): Promise<void>;
|
|
|
|
/**
|
|
* Sets whether outside can be touch or not.
|
|
* @param touchable outside can be touch if true, or not if false.
|
|
* @since 7
|
|
*/
|
|
setOutsideTouchable(touchable: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets whether is private mode or not.
|
|
* @param isPrivacyMode in private mode if true, or not if false.
|
|
* @since 7
|
|
*/
|
|
setPrivacyMode(isPrivacyMode: boolean): Promise<void>;
|
|
|
|
/**
|
|
* Sets whether is private mode or not.
|
|
* @param isPrivacyMode in private mode if true, or not if false.
|
|
* @since 7
|
|
*/
|
|
setPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets whether is touchable or not.
|
|
* @param isTouchable is touchable if true, or not if false.
|
|
* @since 7
|
|
*/
|
|
setTouchable(isTouchable: boolean): Promise<void>;
|
|
|
|
/**
|
|
* Sets whether is touchable or not.
|
|
* @param isTouchable is touchable if true, or not if false.
|
|
* @since 7
|
|
*/
|
|
setTouchable(isTouchable: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets whether is transparent or not.
|
|
* @param isTransparent is transparent if true, or not if false.
|
|
* @since 7
|
|
*/
|
|
setTransparent(isTransparent: boolean): Promise<void>;
|
|
|
|
/**
|
|
* Sets whether is transparent or not.
|
|
* @param isTransparent is transparent if true, or not if false.
|
|
* @since 7
|
|
*/
|
|
setTransparent(isTransparent: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Set the preferred orientation config of a window
|
|
* @param orientation the orientation config of a window
|
|
* @since 9
|
|
*/
|
|
setPreferredOrientation(orientation: Orientation): Promise<void>;
|
|
|
|
/**
|
|
* Set the preferred orientation config of a window
|
|
* @param orientation the orientation config of a window
|
|
* @since 9
|
|
*/
|
|
setPreferredOrientation(orientation: Orientation, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* disable window decoration. It must be called before loadContent.
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
disableWindowDecor(): void;
|
|
|
|
/**
|
|
* Dump window client information.
|
|
* Called in the dump callback of ability is the typical usage scenario.
|
|
* @since 9
|
|
* @param params Indicates the params from command.
|
|
* @return The dump info array.
|
|
*/
|
|
dump(params: Array<string>): Array<string>;
|
|
|
|
/**
|
|
* set the flag of the window is forbidden to move in split screen mode
|
|
* @param isForbidSplitMove the flag of the window is forbidden to move in split screen mode
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
setForbidSplitMove(isForbidSplitMove: boolean, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* set the flag of the window is forbidden to move in split screen mode
|
|
* @param isForbidSplitMove the flag of the window is forbidden to move in split screen mode
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
setForbidSplitMove(isForbidSplitMove: boolean): Promise<void>;
|
|
/**
|
|
* Sets opacity of window
|
|
* @param opacity Interval is 0.f-1.f.
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
setOpacitySync(opacity: number): void;
|
|
/**
|
|
* Sets scale options of window.
|
|
* @param scaleOptions scale param of window.
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
setScaleSync(scaleOptions: ScaleOptions): void;
|
|
/**
|
|
* Sets rotate options of window.
|
|
* @param rotateOptions rotate param of window.
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
setRotateSync(rotateOptions: RotateOptions): void;
|
|
/**
|
|
* Sets whether is transparent or not.
|
|
* @param translateOptions translate param of window.
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
setTranslateSync(translateOptions: TranslateOptions): void;
|
|
}
|
|
|
|
enum WindowStageEventType {
|
|
FOREGROUND = 1,
|
|
ACTIVE,
|
|
INACTIVE,
|
|
BACKGROUND,
|
|
}
|
|
/**
|
|
* WindowStage
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
*/
|
|
interface WindowStage {
|
|
/**
|
|
* Get main window of the stage.
|
|
* @since 8
|
|
*/
|
|
getMainWindow(): Promise<Window>;
|
|
/**
|
|
* Get main window of the stage.
|
|
* @since 8
|
|
*/
|
|
getMainWindow(callback: AsyncCallback<Window>): void;
|
|
/**
|
|
* Create sub window of the stage.
|
|
* @param name window name of sub window
|
|
* @since 8
|
|
*/
|
|
createSubWindow(name: string): Promise<Window>;
|
|
/**
|
|
* Create sub window of the stage.
|
|
* @param name window name of sub window
|
|
* @since 8
|
|
*/
|
|
createSubWindow(name: string, callback: AsyncCallback<Window>): void;
|
|
/**
|
|
* Get sub window of the stage.
|
|
* @since 8
|
|
*/
|
|
getSubWindow(): Promise<Array<Window>>;
|
|
/**
|
|
* Get sub window of the stage.
|
|
* @since 8
|
|
*/
|
|
getSubWindow(callback: AsyncCallback<Array<Window>>): void;
|
|
/**
|
|
* Loads content
|
|
* @param path path Path of the page to which the content will be loaded
|
|
* @param storage storage The data object shared within the content instance loaded by the window
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 8
|
|
*/
|
|
loadContent(path: string, storage: ContenStorage, callback: AsyncCallback<void>): void;
|
|
/**
|
|
* Loads content
|
|
* @param path path of the page to which the content will be loaded
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 8
|
|
*/
|
|
loadContent(path: string, callback: AsyncCallback<void>): void;
|
|
/**
|
|
* Loads content
|
|
* @param path path of the page to which the content will be loaded
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 8
|
|
*/
|
|
loadContent(path: string, storage?: ContenStorage): Promise<void>;
|
|
/**
|
|
* get the windowmode of current window
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
getWindowMode(callback: AsyncCallback<WindowMode>): void;
|
|
/**
|
|
* get the windowmode of current window
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @systemapi
|
|
* @since 8
|
|
*/
|
|
getWindowMode(): Promise<WindowMode>;
|
|
/**
|
|
* window stage event callback on.
|
|
* @since 8
|
|
*/
|
|
on(eventType: 'windowStageEvent', callback: Callback<WindowStageEventType>): void;
|
|
/**
|
|
* window stage event callback off.
|
|
* @since 8
|
|
*/
|
|
off(eventType: 'windowStageEvent', callback?: Callback<WindowStageEventType>): void;
|
|
}
|
|
|
|
/**
|
|
* screen orientation
|
|
* @syscap SystemCapability.WindowManager.WindowManager.Core
|
|
* @since 9
|
|
*/
|
|
enum Orientation {
|
|
UNSPECIFIED = 0,
|
|
PORTRAIT = 1,
|
|
LANDSCAPE = 2,
|
|
PORTRAIT_INVERTED = 3,
|
|
LANDSCAPE_INVERTED = 4,
|
|
AUTO_ROTATION = 5,
|
|
AUTO_ROTATION_PORTRAIT = 6,
|
|
AUTO_ROTATION_LANDSCAPE = 7,
|
|
AUTO_ROTATION_RESTRICTED = 8,
|
|
AUTO_ROTATION_PORTRAIT_RESTRICTED = 9,
|
|
AUTO_ROTATION_LANDSCAPE_RESTRICTED = 10,
|
|
LOCKED = 11,
|
|
}
|
|
}
|
|
|
|
export default window;
|