xref: /foundation/window/window_manager/interfaces/innerkits/wm/window.h

509 static WMError DefaultCreateErrCode = WMError::WM_OK;
522         WMError& errCode = DefaultCreateErrCode);
535         const sptr<IRemoteObject>& iSession, WMError& errCode = DefaultCreateErrCode,
548         const std::shared_ptr<OHOS::AbilityRuntime::Context>& context, WMError& errCode = DefaultCreateErrCode);
683     virtual WMError SetFocusable(bool isFocusable) { return WMError::WM_OK; }
696     virtual WMError SetTouchable(bool isTouchable) { return WMError::WM_OK; }
728      * @return WMError
730     virtual WMError SetWindowType(WindowType type) { return WMError::WM_OK; }
735      * @return WMError
737     virtual WMError SetWindowMode(WindowMode mode) { return WMError::WM_OK; }
742      * @return WMError
744     virtual WMError SetTopmost(bool topmost) { return WMError::WM_OK; }
755      * @return WMError
757     virtual WMError SetMainWindowTopmost(bool isTopmost) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
770     virtual WMError SetAlpha(float alpha) { return WMError::WM_OK; }
775      * @return WMError
777     virtual WMError SetTransform(const Transform& trans) { return WMError::WM_OK; }
794     virtual WMError AddWindowFlag(WindowFlag flag) { return WMError::WM_OK; }
801     virtual WMError RemoveWindowFlag(WindowFlag flag) { return WMError::WM_OK; }
808     virtual WMError SetWindowFlags(uint32_t flags) { return WMError::WM_OK; }
814      * @return WMError
816     virtual WMError SetSystemBarProperty(WindowType type, const SystemBarProperty& property) { return WMError::WM_OK; }
822      * @return WMError
824     virtual WMError GetAvoidAreaByType(AvoidAreaType type, AvoidArea& avoidArea) { return WMError::WM_OK; }
829      * @return WMError
831     virtual WMError SetLayoutFullScreen(bool status) { return WMError::WM_OK; }
837      * @return WMError
839     virtual WMError SetTitleAndDockHoverShown(bool isTitleHoverShown = true,
842         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
848      * @return WMError
850     virtual WMError SetFullScreen(bool status) { return WMError::WM_OK; }
854      * @return WMError
856     virtual WMError Destroy() { return WMError::WM_OK; }
865     virtual WMError Show(uint32_t reason = 0, bool withAnimation = false,
866                          bool withFocus = true) { return WMError::WM_OK; }
875     virtual WMError Hide(uint32_t reason = 0, bool withAnimation = false, bool isFromInnerkits = true)
877         return WMError::WM_OK;
882      * @return WMError
884     virtual WMError NotifyDrawingCompleted() { return WMError::WM_OK; }
890      * @return WMError
892     virtual WMError MoveTo(int32_t x, int32_t y, bool isMoveToGlobal = false) { return WMError::WM_OK; }
898      * @return WMError
900     virtual WMError MoveToAsync(int32_t x, int32_t y) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
906      * @return WMError
908     virtual WMError Resize(uint32_t width, uint32_t height) { return WMError::WM_OK; }
914      * @return WMError
916     virtual WMError ResizeAsync(uint32_t width, uint32_t height) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
922      * @return WMError
924     virtual WMError SetWindowGravity(WindowGravity gravity, uint32_t percent) { return WMError::WM_OK; }
929      * @return WMError
931     virtual WMError SetKeepScreenOn(bool keepScreenOn) { return WMError::WM_OK; }
944     virtual WMError SetTurnScreenOn(bool turnScreenOn) { return WMError::WM_OK; }
957     virtual WMError SetBackgroundColor(const std::string& color) { return WMError::WM_OK; }
964     virtual WMError SetTransparent(bool isTransparent) { return WMError::WM_OK; }
977     virtual WMError SetBrightness(float brightness) { return WMError::WM_OK; }
990     virtual WMError SetCallingWindow(uint32_t windowId) { return WMError::WM_OK; }
997     virtual WMError SetPrivacyMode(bool isPrivacyMode) { return WMError::WM_OK; }
1016     virtual WMError BindDialogTarget(sptr<IRemoteObject> targetToken) { return WMError::WM_OK; }
1023     virtual WMError SetDialogBackGestureEnabled(bool isEnabled)
1025         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
1032     virtual WMError RaiseToAppTop() { return WMError::WM_OK; }
1039     virtual WMError SetSnapshotSkip(bool isSkip) { return WMError::WM_OK; }
1048     virtual WMError SetCornerRadius(float cornerRadius) { return WMError::WM_OK; }
1055     virtual WMError SetShadowRadius(float radius) { return WMError::WM_OK; }
1062     virtual WMError SetShadowColor(std::string color) { return WMError::WM_OK; }
1069     virtual WMError SetShadowOffsetX(float offsetX) { return WMError::WM_OK; }
1076     virtual WMError SetShadowOffsetY(float offsetY) { return WMError::WM_OK; }
1083     virtual WMError SetBlur(float radius) { return WMError::WM_OK; }
1090     virtual WMError SetBackdropBlur(float radius) { return WMError::WM_OK; }
1097     virtual WMError SetBackdropBlurStyle(WindowBlurStyle blurStyle) { return WMError::WM_OK; }
1104     virtual WMError RequestFocus() const { return WMError::WM_OK; }
1110     virtual WMError RequestFocusByClient(bool isFocused) const { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1123     virtual WMError UpdateSurfaceNodeAfterCustomAnimation(bool isAdd) { return WMError::WM_OK; }
1181     virtual WMError RegisterLifeCycleListener(const sptr<IWindowLifeCycle>& listener) { return WMError::WM_OK; }
1188     virtual WMError UnregisterLifeCycleListener(const sptr<IWindowLifeCycle>& listener) { return WMError::WM_OK; }
1195     virtual WMError RegisterWindowChangeListener(const sptr<IWindowChangeListener>& listener)
1197         return WMError::WM_OK;
1205     virtual WMError UnregisterWindowChangeListener(const sptr<IWindowChangeListener>& listener)
1207         return WMError::WM_OK;
1215     virtual WMError RegisterAvoidAreaChangeListener(sptr<IAvoidAreaChangedListener>& listener)
1217         return WMError::WM_OK;
1225     virtual WMError UnregisterAvoidAreaChangeListener(sptr<IAvoidAreaChangedListener>& listener)
1227         return WMError::WM_OK;
1235     virtual WMError RegisterDragListener(const sptr<IWindowDragListener>& listener) { return WMError::WM_OK; }
1242     virtual WMError UnregisterDragListener(const sptr<IWindowDragListener>& listener) { return WMError::WM_OK; }
1249     virtual WMError RegisterDisplayMoveListener(sptr<IDisplayMoveListener>& listener) { return WMError::WM_OK; }
1256     virtual WMError UnregisterDisplayMoveListener(sptr<IDisplayMoveListener>& listener) { return WMError::WM_OK; }
1274     virtual WMError RegisterOccupiedAreaChangeListener(const sptr<IOccupiedAreaChangeListener>& listener)
1276         return WMError::WM_OK;
1284     virtual WMError UnregisterOccupiedAreaChangeListener(const sptr<IOccupiedAreaChangeListener>& listener)
1286         return WMError::WM_OK;
1294     virtual WMError RegisterTouchOutsideListener(const sptr<ITouchOutsideListener>& listener) { return WMError::WM_OK; }
1301     virtual WMError UnregisterTouchOutsideListener(const sptr<ITouchOutsideListener>& listener)
1303         return WMError::WM_OK;
1311     virtual WMError RegisterAnimationTransitionController(const sptr<IAnimationTransitionController>& listener)
1313         return WMError::WM_OK;
1321     virtual WMError RegisterScreenshotListener(const sptr<IScreenshotListener>& listener) { return WMError::WM_OK; }
1328     virtual WMError UnregisterScreenshotListener(const sptr<IScreenshotListener>& listener) { return WMError::WM_OK; }
1335     virtual WMError RegisterDialogTargetTouchListener(const sptr<IDialogTargetTouchListener>& listener)
1337         return WMError::WM_OK;
1345     virtual WMError UnregisterDialogTargetTouchListener(const sptr<IDialogTargetTouchListener>& listener)
1347         return WMError::WM_OK;
1379      * @return WMError
1381     virtual WMError NapiSetUIContent(const std::string& contentInfo, napi_env env, napi_value storage,
1385         return WMError::WM_OK;
1395      * @return WMError
1397     virtual WMError SetUIContentByName(const std::string& contentInfo, napi_env env, napi_value storage,
1400         return WMError::WM_OK;
1409      * @return WMError
1411     virtual WMError SetUIContentByAbc(const std::string& abcPath, napi_env env, napi_value storage,
1414         return WMError::WM_OK;
1428      * @return WMError.
1430     virtual WMError SetRestoredRouterStack(const std::string& routerStack)
1432         return WMError::WM_OK;
1483     virtual WMError SetTouchHotAreas(const std::vector<Rect>& rects) { return WMError::WM_OK; }
1502     virtual WMError SetAPPWindowLabel(const std::string& label) { return WMError::WM_OK; }
1509     virtual WMError SetAPPWindowIcon(const std::shared_ptr<Media::PixelMap>& icon) { return WMError::WM_OK; }
1515     virtual WMError DisableAppWindowDecor() { return WMError::WM_OK; }
1525      * @return WMError
1527     virtual WMError Maximize() { return WMError::WM_OK; }
1535     virtual WMError Maximize(MaximizePresentation presentation)
1537         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
1543      * @return WMError
1545     virtual WMError MaximizeFloating() {return WMError::WM_OK;}
1549      * @return WMError
1551     virtual WMError Minimize() { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1555      * @return WMError
1557     virtual WMError Recover() { return WMError::WM_OK; }
1563      * @return WMError
1565     virtual WMError Restore() { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1570      * @return WMError
1572     virtual WMError Close() { return WMError::WM_OK; }
1601      * @return WMError
1603     virtual WMError SetGlobalMaximizeMode(MaximizeMode mode) {return WMError::WM_OK;}
1645     virtual WMError NotifyMemoryLevel(int32_t level) { return WMError::WM_OK; }
1658      * @return WMError
1660     virtual WMError SetAspectRatio(float ratio) { return WMError::WM_OK; }
1663      * @return WMError
1665     virtual WMError ResetAspectRatio() { return WMError::WM_OK; }
1679      * @return WMError
1681     virtual WMError TransferAbilityResult(uint32_t resultCode, const AAFwk::Want& want) { return WMError::WM_OK; }
1684      * @return WMError
1686     virtual WMError TransferExtensionData(const AAFwk::WantParams& wantParams) { return WMError::WM_OK; }
1709     virtual WMError SetResizeByDragEnabled(bool dragEnabled) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1716     virtual WMError SetRaiseByClickEnabled(bool raiseEnabled) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1722     virtual WMError RaiseAboveTarget(int32_t subWindowId) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1730     virtual WMError HideNonSystemFloatingWindows(bool shouldHide) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1765     virtual WMError SetTextFieldAvoidInfo(double textFieldPositionY, double textFieldHeight) { return WMError::WM_OK; }
1772     virtual WMError TransferAccessibilityEvent(const Accessibility::AccessibilityEventInfo& info,
1773         int64_t uiExtensionIdLevel) { return WMError::WM_OK; };
1780     virtual WMError NotifyPrepareClosePiPWindow() { return WMError::WM_OK; }
1823     virtual WMError RegisterWindowVisibilityChangeListener(const IWindowVisibilityListenerSptr& listener)
1825         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
1834     virtual WMError UnregisterWindowVisibilityChangeListener(const IWindowVisibilityListenerSptr& listener)
1836         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
1843      * @return WMError.
1845     virtual WMError GetWindowLimits(WindowLimits& windowLimits) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1851      * @return WMError.
1853     virtual WMError SetWindowLimits(WindowLimits& windowLimits) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1861     virtual WMError RegisterWindowNoInteractionListener(const IWindowNoInteractionListenerSptr& listener)
1863         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
1872     virtual WMError UnregisterWindowNoInteractionListener(const IWindowNoInteractionListenerSptr& listener)
1874         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
1883     virtual WMError RegisterWindowStatusChangeListener(const sptr<IWindowStatusChangeListener>& listener)
1885         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
1893     virtual WMError UnregisterWindowStatusChangeListener(const sptr<IWindowStatusChangeListener>& listener)
1895         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
1903      * @return WMError
1905     virtual WMError SetSpecificBarProperty(WindowType type, const SystemBarProperty& property)
1907         return WMError::WM_OK;
1915      * @return WMError
1917     virtual WMError SetSystemBarProperties(const std::map<WindowType, SystemBarProperty>& properties,
1920         return WMError::WM_OK;
1927      * @return WMError
1929     virtual WMError GetSystemBarProperties(std::map<WindowType, SystemBarProperty>& properties)
1931         return WMError::WM_OK;
1940     virtual WMError SetSingleFrameComposerEnabled(bool enable) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1948     virtual WMError SetDecorVisible(bool isVisible) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1957     virtual WMError SetWindowContainerColor(const std::string& activeColor, const std::string& inactiveColor)
1959         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
1968     virtual WMError EnableDrag(bool enableDrag) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1979     virtual WMError SetTitleButtonVisible(bool isMaximizeVisible, bool isMinimizeVisible, bool isSplitVisible,
1982         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
1991     virtual WMError SetDecorHeight(int32_t decorHeight) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
1998     virtual WMError GetDecorHeight(int32_t& height) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2004      * @return WMError.
2006     virtual WMError GetTitleButtonArea(TitleButtonRect& titleButtonRect)
2008         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2017     virtual WMError RegisterWindowTitleButtonRectChangeListener(
2020         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2029     virtual WMError UnregisterWindowTitleButtonRectChangeListener(
2032         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2041     virtual WMError SetDefaultDensityEnabled(bool enabled) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2061      * @return WMError
2063     virtual WMError HideNonSecureWindows(bool shouldHide)
2065         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2072      * @return WMError
2074     virtual WMError SetWaterMarkFlag(bool isEnable)
2076         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2083      * @return WMError
2085     virtual WMError HidePrivacyContentForHost(bool needHide)
2087         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2095      * @return WMError
2097     virtual WMError SetSubWindowModal(bool isModal, ModalityType modalityType = ModalityType::WINDOW_MODALITY)
2099         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2106      * @return WMError
2108     virtual WMError Recover(uint32_t reason) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2122      * @return WMError WM_OK means set success, others means failed.
2124     virtual WMError SetLandscapeMultiWindow(bool isLandscapeMultiWindow) { return WMError::WM_OK; }
2132     virtual WMError RegisterSubWindowCloseListeners(
2133         const sptr<ISubWindowCloseListener>& listener) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2141     virtual WMError UnregisterSubWindowCloseListeners(
2142         const sptr<ISubWindowCloseListener>& listener) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2150     virtual WMError RegisterMainWindowCloseListeners(
2151         const sptr<IMainWindowCloseListener>& listener) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2159     virtual WMError UnregisterMainWindowCloseListeners(
2160         const sptr<IMainWindowCloseListener>& listener) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2168     virtual WMError RegisterSwitchFreeMultiWindowListener(
2169         const sptr<ISwitchFreeMultiWindowListener>& listener) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2177     virtual WMError UnregisterSwitchFreeMultiWindowListener(
2178         const sptr<ISwitchFreeMultiWindowListener>& listener) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2186     virtual WMError SetWindowMask(const std::vector<std::vector<uint32_t>>& windowMask)
2188         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2197     virtual WMError RegisterKeyboardPanelInfoChangeListener(const sptr<IKeyboardPanelInfoChangeListener>& listener)
2199         return WMError::WM_OK;
2208     virtual WMError UnregisterKeyboardPanelInfoChangeListener(const sptr<IKeyboardPanelInfoChangeListener>& listener)
2210         return WMError::WM_OK;
2225      * @return WMError
2227     virtual WMError SetKeyEventFilter(KeyEventFilterFunc KeyEventFilterFunc)
2229         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2235      * @return WMError
2237     virtual WMError ClearKeyEventFilter() { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;}
2245     virtual WMError RegisterWindowRectChangeListener(const sptr<IWindowRectChangeListener>& listener)
2247         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2256     virtual WMError UnregisterWindowRectChangeListener(const sptr<IWindowRectChangeListener>& listener)
2258         return WMError::WM_ERROR_DEVICE_NOT_SUPPORT;
2266     virtual WMError GetCallingWindowWindowStatus(WindowStatus& windowStatus) const
2268         return WMError::WM_OK;
2276     virtual WMError GetCallingWindowRect(Rect& rect) const
2278         return WMError::WM_OK;
2286     virtual WMError SetGrayScale(float grayScale) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2293     virtual WMError AdjustKeyboardLayout(const KeyboardLayoutParams& params) { return WMError::WM_OK; }
2308     virtual WMError SetImmersiveModeEnabledState(bool enable) { return WMError::WM_OK; }
2335      * @return WMError.
2337     virtual WMError GetWindowStatus(WindowStatus& windowStatus) { return WMError::WM_ERROR_DEVICE_NOT_SUPPORT; }
2345     virtual WMError SetContinueState(int32_t continueState) { return WMError::WM_DO_NOTHING; }
2402     virtual WMError SetGestureBackEnabled(bool enable) { return WMError::WM_OK; }

Indexes created Thu Nov 07 10:32:03 CST 2024