1 /* 2 * Copyright (c) 2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef OHOS_ROSEN_WINDOW_H 17 #define OHOS_ROSEN_WINDOW_H 18 19 #include <parcel.h> 20 #include <refbase.h> 21 #include <pixel_map.h> 22 #include <iremote_object.h> 23 24 #include "wm_common.h" 25 #include "window_option.h" 26 27 class NativeValue; 28 class NativeEngine; 29 30 namespace OHOS::MMI { 31 class PointerEvent; 32 class KeyEvent; 33 class AxisEvent; 34 } 35 36 namespace OHOS::AppExecFwk { 37 class Configuration; 38 class Ability; 39 } 40 41 namespace OHOS::AbilityRuntime { 42 class AbilityContext; 43 class Context; 44 } 45 46 namespace OHOS::Ace { 47 class UIContent; 48 class ViewportConfig; 49 } 50 51 namespace OHOS::AAFwk { 52 class Want; 53 } 54 55 namespace OHOS { 56 namespace Rosen { 57 class RSSurfaceNode; 58 class RSTransaction; 59 using NotifyNativeWinDestroyFunc = std::function<void(std::string windowName)>; 60 using SendRenderDataCallback = bool (*)(const void*, const size_t, const int32_t, const int32_t); 61 using ContentInfoCallback = std::function<void(std::string contentInfo)>; 62 63 class IWindowLifeCycle : virtual public RefBase { 64 }; 65 class IWindowChangeListener : virtual public RefBase { 66 }; 67 class IAvoidAreaChangedListener : virtual public RefBase { 68 }; 69 class IWindowDragListener : virtual public RefBase { 70 }; 71 class IDisplayMoveListener : virtual public RefBase { 72 }; 73 class IDispatchInputEventListener : virtual public RefBase { 74 }; 75 class OccupiedAreaChangeInfo : public Parcelable { 76 public: 77 virtual bool Marshalling(Parcel& parcel) const override; 78 static OccupiedAreaChangeInfo* Unmarshalling(Parcel& parcel); 79 }; 80 class IOccupiedAreaChangeListener : virtual public RefBase { 81 }; 82 class IAceAbilityHandler : virtual public RefBase { 83 }; 84 class IInputEventConsumer { 85 }; 86 class ITouchOutsideListener : virtual public RefBase { 87 }; 88 class IAnimationTransitionController : virtual public RefBase { 89 public: 90 virtual void AnimationForShown() = 0; 91 virtual void AnimationForHidden() = 0; 92 }; 93 class IScreenshotListener : virtual public RefBase { 94 }; 95 class IDialogTargetTouchListener : virtual public RefBase { 96 }; 97 class IDialogDeathRecipientListener : virtual public RefBase { 98 }; 99 static WMError DefaultCreateErrCode = WMError::WM_OK; 100 class WINDOW_EXPORT Window : public RefBase { 101 public: 102 static sptr<Window> Create(const std::string& windowName, 103 sptr<WindowOption>& option, const std::shared_ptr<AbilityRuntime::Context>& context = nullptr, 104 WMError& errCode = DefaultCreateErrCode); 105 static sptr<Window> Find(const std::string& windowName); 106 static sptr<Window> GetTopWindowWithContext(const std::shared_ptr<AbilityRuntime::Context>& context = nullptr); 107 static sptr<Window> GetTopWindowWithId(uint32_t mainWinId); 108 static std::vector<sptr<Window>> GetSubWindow(uint32_t parentId); 109 static void UpdateConfigurationForAll(const std::shared_ptr<AppExecFwk::Configuration>& configuration); 110 virtual std::shared_ptr<RSSurfaceNode> GetSurfaceNode() const = 0; 111 virtual const std::shared_ptr<AbilityRuntime::Context> GetContext() const = 0; 112 virtual Rect GetRect() const = 0; 113 virtual Rect GetRequestRect() const = 0; 114 virtual WindowType GetType() const = 0; 115 virtual WindowMode GetMode() const = 0; 116 virtual float GetAlpha() const = 0; 117 virtual const std::string& GetWindowName() const = 0; 118 virtual uint32_t GetWindowId() const = 0; 119 virtual uint32_t GetWindowFlags() const = 0; 120 virtual WindowState GetWindowState() const = 0; 121 virtual WMError SetFocusable(bool isFocusable) = 0; 122 virtual bool GetFocusable() const = 0; 123 virtual WMError SetTouchable(bool isTouchable) = 0; 124 virtual SystemBarProperty GetSystemBarPropertyByType(WindowType type) const = 0; 125 virtual bool GetTouchable() const = 0; 126 virtual bool IsLayoutFullScreen() const = 0; 127 virtual bool IsFullScreen() const = 0; 128 virtual WMError SetWindowMode(WindowMode mode) = 0; 129 virtual WMError SetWindowType(WindowType type) = 0; 130 virtual WMError SetAlpha(float alpha) = 0; 131 virtual WMError SetTransform(const Transform& trans) = 0; 132 virtual const Transform& GetTransform() const = 0; 133 virtual WMError RemoveWindowFlag(WindowFlag flag) = 0; 134 virtual WMError AddWindowFlag(WindowFlag flag) = 0; 135 virtual WMError SetWindowFlags(uint32_t flags) = 0; 136 virtual WMError GetAvoidAreaByType(AvoidAreaType type, AvoidArea& avoidArea) = 0; 137 virtual WMError SetSystemBarProperty(WindowType type, const SystemBarProperty& property) = 0; 138 virtual WMError SetFullScreen(bool status) = 0; 139 virtual WMError SetLayoutFullScreen(bool status) = 0; 140 virtual WMError Destroy() = 0; 141 virtual WMError Show(uint32_t reason = 0, bool withAnimation = false) = 0; 142 virtual WMError Hide(uint32_t reason = 0, bool withAnimation = false, bool isFromInnerkits = true) = 0; 143 virtual WMError MoveTo(int32_t x, int32_t y) = 0; 144 virtual WMError Resize(uint32_t width, uint32_t height) = 0; 145 virtual WMError SetWindowGravity(WindowGravity gravity, uint32_t percent) = 0; 146 virtual WMError SetKeepScreenOn(bool keepScreenOn) = 0; 147 virtual bool IsKeepScreenOn() const = 0; 148 virtual WMError SetTurnScreenOn(bool turnScreenOn) = 0; 149 virtual bool IsTurnScreenOn() const = 0; 150 virtual WMError SetBackgroundColor(const std::string& color) = 0; 151 virtual WMError SetTransparent(bool isTransparent) = 0; 152 virtual bool IsTransparent() const = 0; 153 virtual WMError SetBrightness(float brightness) = 0; 154 virtual float GetBrightness() const = 0; 155 virtual WMError SetCallingWindow(uint32_t windowId) = 0; 156 virtual WMError SetPrivacyMode(bool isPrivacyMode) = 0; 157 virtual bool IsPrivacyMode() const = 0; 158 virtual void SetSystemPrivacyMode(bool isSystemPrivacyMode) = 0; 159 virtual WMError BindDialogTarget(sptr<IRemoteObject> targetToken) = 0; 160 virtual WmErrorCode RaiseToAppTop() = 0; 161 virtual WMError SetSnapshotSkip(bool isSkip) = 0; 162 virtual WMError SetCornerRadius(float cornerRadius) = 0; 163 virtual WMError SetShadowRadius(float radius) = 0; 164 virtual WMError SetShadowColor(std::string color) = 0; 165 virtual WMError SetShadowOffsetX(float offsetX) = 0; 166 virtual WMError SetShadowOffsetY(float offsetY) = 0; 167 virtual WMError SetBlur(float radius) = 0; 168 virtual WMError SetBackdropBlur(float radius) = 0; 169 virtual WMError SetBackdropBlurStyle(WindowBlurStyle blurStyle) = 0; 170 virtual WMError RequestFocus() const = 0; 171 virtual bool IsFocused() const = 0; 172 virtual WMError UpdateSurfaceNodeAfterCustomAnimation(bool isAdd) = 0; 173 virtual void SetInputEventConsumer(const std::shared_ptr<IInputEventConsumer>& inputEventConsumer) = 0; 174 virtual void ConsumeKeyEvent(const std::shared_ptr<MMI::KeyEvent>& inputEvent) = 0; 175 virtual void ConsumePointerEvent(const std::shared_ptr<MMI::PointerEvent>& inputEvent) = 0; 176 virtual void RequestVsync(const std::shared_ptr<VsyncCallback>& vsyncCallback) = 0; 177 virtual int64_t GetVSyncPeriod() = 0; 178 virtual void UpdateConfiguration(const std::shared_ptr<AppExecFwk::Configuration>& configuration) = 0; 179 virtual WMError RegisterLifeCycleListener(const sptr<IWindowLifeCycle>& listener) = 0; 180 virtual WMError UnregisterLifeCycleListener(const sptr<IWindowLifeCycle>& listener) = 0; 181 virtual WMError RegisterWindowChangeListener(const sptr<IWindowChangeListener>& listener) = 0; 182 virtual WMError UnregisterWindowChangeListener(const sptr<IWindowChangeListener>& listener) = 0; 183 virtual WMError RegisterAvoidAreaChangeListener(sptr<IAvoidAreaChangedListener>& listener) = 0; 184 virtual WMError UnregisterAvoidAreaChangeListener(sptr<IAvoidAreaChangedListener>& listener) = 0; 185 virtual WMError RegisterDragListener(const sptr<IWindowDragListener>& listener) = 0; 186 virtual WMError UnregisterDragListener(const sptr<IWindowDragListener>& listener) = 0; 187 virtual WMError RegisterDisplayMoveListener(sptr<IDisplayMoveListener>& listener) = 0; 188 virtual WMError UnregisterDisplayMoveListener(sptr<IDisplayMoveListener>& listener) = 0; 189 virtual void RegisterWindowDestroyedListener(const NotifyNativeWinDestroyFunc& func) = 0; 190 virtual WMError RegisterOccupiedAreaChangeListener(const sptr<IOccupiedAreaChangeListener>& listener) = 0; 191 virtual WMError UnregisterOccupiedAreaChangeListener(const sptr<IOccupiedAreaChangeListener>& listener) = 0; 192 virtual WMError RegisterTouchOutsideListener(const sptr<ITouchOutsideListener>& listener) = 0; 193 virtual WMError UnregisterTouchOutsideListener(const sptr<ITouchOutsideListener>& listener) = 0; 194 virtual WMError RegisterAnimationTransitionController(const sptr<IAnimationTransitionController>& listener) = 0; 195 virtual WMError RegisterScreenshotListener(const sptr<IScreenshotListener>& listener) = 0; 196 virtual WMError UnregisterScreenshotListener(const sptr<IScreenshotListener>& listener) = 0; 197 virtual WMError RegisterDialogTargetTouchListener(const sptr<IDialogTargetTouchListener>& listener) = 0; 198 virtual WMError UnregisterDialogTargetTouchListener(const sptr<IDialogTargetTouchListener>& listener) = 0; 199 virtual void RegisterDialogDeathRecipientListener(const sptr<IDialogDeathRecipientListener>& listener) = 0; 200 virtual void UnregisterDialogDeathRecipientListener(const sptr<IDialogDeathRecipientListener>& listener) = 0; 201 virtual void NotifyTouchDialogTarget() = 0; 202 virtual void SetAceAbilityHandler(const sptr<IAceAbilityHandler>& handler) = 0; 203 virtual WMError SetUIContent(const std::string& contentInfo, NativeEngine* engine, 204 NativeValue* storage, bool isDistributed = false, AppExecFwk::Ability* ability = nullptr) = 0; 205 virtual std::string GetContentInfo() = 0; 206 virtual Ace::UIContent* GetUIContent() const = 0; 207 virtual void OnNewWant(const AAFwk::Want& want) = 0; 208 virtual void SetRequestedOrientation(Orientation) = 0; 209 virtual Orientation GetRequestedOrientation() = 0; 210 virtual void SetRequestModeSupportInfo(uint32_t modeSupportInfo) = 0; 211 virtual uint32_t GetRequestModeSupportInfo() const = 0; 212 virtual WMError SetTouchHotAreas(const std::vector<Rect>& rects) = 0; 213 virtual void GetRequestedTouchHotAreas(std::vector<Rect>& rects) const = 0; 214 virtual bool IsMainHandlerAvailable() const = 0; 215 virtual WMError SetAPPWindowLabel(const std::string& label) = 0; 216 virtual WMError SetAPPWindowIcon(const std::shared_ptr<Media::PixelMap>& icon) = 0; 217 virtual WMError DisableAppWindowDecor() = 0; 218 virtual WMError Minimize() = 0; 219 virtual WMError Maximize() = 0; 220 virtual WMError Recover() = 0; 221 virtual void StartMove() = 0; 222 virtual WMError Close() = 0; 223 virtual void SetNeedRemoveWindowInputChannel(bool needRemoveWindowInputChannel) = 0; 224 virtual bool IsSupportWideGamut() = 0; 225 virtual void SetColorSpace(ColorSpace colorSpace) = 0; 226 virtual ColorSpace GetColorSpace() = 0; 227 virtual void DumpInfo(const std::vector<std::string>& params, std::vector<std::string>& info) = 0; 228 virtual std::shared_ptr<Media::PixelMap> Snapshot() = 0; 229 virtual WMError NotifyMemoryLevel(int32_t level) = 0; 230 virtual bool IsAllowHaveSystemSubWindow() = 0; 231 virtual WMError SetAspectRatio(float ratio) = 0; 232 virtual WMError ResetAspectRatio() = 0; 233 virtual KeyboardAnimationConfig GetKeyboardAnimationConfig() = 0; 234 virtual void SetNeedDefaultAnimation(bool needDefaultAnimation) = 0; 235 236 virtual void SetViewportConfig(const Ace::ViewportConfig& config) = 0; 237 virtual void UpdateViewportConfig() = 0; 238 virtual void SetOrientation(Orientation orientation) = 0; 239 virtual void SetSize(int32_t width, int32_t height) = 0; 240 virtual void SetDensity(float density) = 0; 241 242 virtual void CreateSurfaceNode(const std::string name, const SendRenderDataCallback& callback) = 0; 243 virtual void SetContentInfoCallback(const ContentInfoCallback& callback) = 0; 244 virtual WMError SetResizeByDragEnabled(bool dragEnabled) = 0; 245 virtual WMError SetRaiseByClickEnabled(bool raiseEnabled) = 0; 246 virtual WmErrorCode RaiseAboveTarget(int32_t subWindowId) = 0; 247 }; 248 } 249 } 250 #endif // OHOS_ROSEN_WINDOW_H