2 * Copyright(c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 extern alias TizenSystemInformation;
19 using TizenSystemInformation.Tizen.System;
22 using System.ComponentModel;
23 using System.Collections.Generic;
24 using System.Runtime.InteropServices;
26 using Tizen.NUI.BaseComponents;
31 /// The window class is used internally for drawing.<br />
32 /// The window has an orientation and indicator properties.<br />
34 /// <since_tizen> 3 </since_tizen>
35 public partial class Window : BaseHandle
37 private HandleRef stageCPtr;
38 private Layer rootLayer;
39 private string windowTitle;
40 private List<Layer> childLayers = new List<Layer>();
41 private LayoutController localController;
43 static internal bool IsSupportedMultiWindow()
45 bool isSupported = false;
46 Information.TryGetValue("http://tizen.org/feature/opengles.surfaceless_context", out isSupported);
50 internal Window(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
52 if (Interop.Stage.IsInstalled())
54 stageCPtr = new global::System.Runtime.InteropServices.HandleRef(this, Interop.Stage.GetCurrent());
56 localController = new LayoutController(this);
57 NUILog.Debug("layoutController id:" + localController.GetId());
62 /// A helper method to get the current window where the view is added
64 /// <param name="view">The View added to the window</param>
65 /// <returns>A Window.</returns>
66 [EditorBrowsable(EditorBrowsableState.Never)]
67 static public Window Get(View view)
71 NUILog.Error("if there is no view, it can not get a window");
75 Window ret = Registry.GetManagedBaseHandleFromNativePtr(Interop.Window.Get(View.getCPtr(view))) as Window;
76 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
81 /// Creates a new Window.<br />
82 /// This creates an extra window in addition to the default main window<br />
84 /// <param name="windowPosition">The position and size of the Window.</param>
85 /// <param name="isTranslucent">Whether Window is translucent.</param>
86 /// <returns>A new Window.</returns>
87 /// <since_tizen> 6 </since_tizen>
88 /// <feature> http://tizen.org/feature/opengles.surfaceless_context </feature>
89 /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
90 public Window(Rectangle windowPosition = null, bool isTranslucent = false) : this(Interop.Window.New(Rectangle.getCPtr(windowPosition), "", isTranslucent), true)
92 if (IsSupportedMultiWindow() == false)
94 NUILog.Error("This device does not support surfaceless_context. So Window cannot be created. ");
96 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
100 /// Creates a new Window with a specific name.<br />
101 /// This creates an extra window in addition to the default main window<br />
103 /// <param name="name">The name for extra window. </param>
104 /// <param name="windowPosition">The position and size of the Window.</param>
105 /// <param name="isTranslucent">Whether Window is translucent.</param>
106 /// <returns>A new Window.</returns>
107 /// <since_tizen> 6 </since_tizen>
108 /// <feature> http://tizen.org/feature/opengles.surfaceless_context </feature>
109 /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
110 public Window(string name, Rectangle windowPosition = null, bool isTranslucent = false) : this(Interop.Window.New(Rectangle.getCPtr(windowPosition), name, isTranslucent), true)
112 if (IsSupportedMultiWindow() == false)
114 NUILog.Error("This device does not support surfaceless_context. So Window cannot be created. ");
116 this.windowTitle = name;
117 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
121 /// Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.
123 /// <since_tizen> 3 </since_tizen>
124 public enum WindowOrientation
127 /// Portrait orientation. The height of the display area is greater than the width.
129 /// <since_tizen> 3 </since_tizen>
132 /// Landscape orientation. A wide view area is needed.
134 /// <since_tizen> 3 </since_tizen>
137 /// Portrait inverse orientation.
139 /// <since_tizen> 3 </since_tizen>
140 PortraitInverse = 180,
142 /// Landscape inverse orientation.
144 /// <since_tizen> 3 </since_tizen>
145 LandscapeInverse = 270,
147 /// No orientation. It is for the preferred orientation
148 /// Especially, NoOrientationPreference only has the effect for the preferred orientation.
149 /// It is used to unset the preferred orientation with SetPreferredOrientation.
151 [EditorBrowsable(EditorBrowsableState.Never)]
152 NoOrientationPreference = -1
156 /// Enumeration for the key grab mode for platform-level APIs.
158 /// <since_tizen> 3 </since_tizen>
159 public enum KeyGrabMode
162 /// Grabs a key only when on the top of the grabbing-window stack mode.
166 /// Grabs a key together with the other client window(s) mode.
170 /// Grabs a key exclusively regardless of the grabbing-window's position on the window stack with the possibility of overriding the grab by the other client window mode.
174 /// Grabs a key exclusively regardless of the grabbing-window's position on the window stack mode.
180 /// Enumeration for transition effect's state.
182 [Obsolete("Please do not use! This will be removed. Please use Window.EffectState instead!")]
183 [EditorBrowsable(EditorBrowsableState.Never)]
184 public enum EffectStates
189 [Obsolete("Please do not use! This will be removed. Please use Window.EffectState.None instead!")]
190 [EditorBrowsable(EditorBrowsableState.Never)]
193 /// Transition effect is started.
195 [Obsolete("Please do not use! This will be removed. Please use Window.EffectState.Start instead!")]
196 [EditorBrowsable(EditorBrowsableState.Never)]
199 /// Transition effect is ended.
201 [Obsolete("Please do not use! This will be removed. Please use Window.EffectState.End instead!")]
202 [EditorBrowsable(EditorBrowsableState.Never)]
207 /// Enumeration for transition effect's state.
209 [EditorBrowsable(EditorBrowsableState.Never)]
210 public enum EffectState
215 [EditorBrowsable(EditorBrowsableState.Never)]
218 /// Transition effect is started.
220 [EditorBrowsable(EditorBrowsableState.Never)]
223 /// Transition effect is ended.
225 [EditorBrowsable(EditorBrowsableState.Never)]
230 /// Enumeration for transition effect's type.
232 [Obsolete("Please do not use! This will be removed. Please use Window.EffectType instead!")]
233 [EditorBrowsable(EditorBrowsableState.Never)]
234 public enum EffectTypes
239 [Obsolete("Please do not use! This will be removed. Please use Window.EffectType.None instead!")]
240 [EditorBrowsable(EditorBrowsableState.Never)]
243 /// Window show effect.
245 [Obsolete("Please do not use! This will be removed. Please use Window.EffectType.Show instead!")]
246 [EditorBrowsable(EditorBrowsableState.Never)]
249 /// Window hide effect.
251 [Obsolete("Please do not use! This will be removed. Please use Window.EffectType.Hide instead!")]
252 [EditorBrowsable(EditorBrowsableState.Never)]
257 /// Enumeration for transition effect's type.
259 [EditorBrowsable(EditorBrowsableState.Never)]
260 public enum EffectType
265 [EditorBrowsable(EditorBrowsableState.Never)]
268 /// Window show effect.
270 [EditorBrowsable(EditorBrowsableState.Never)]
273 /// Window hide effect.
275 [EditorBrowsable(EditorBrowsableState.Never)]
280 /// Enumeration for result of window operation.
282 internal enum OperationResult
285 /// Failed for unknown reason
293 /// Permission denied
297 /// The operation is not supported.
303 /// Enumeration for window resized mode by display server.
305 [EditorBrowsable(EditorBrowsableState.Never)]
306 public enum ResizeDirection
309 /// Start resizing window to the top-left edge.
311 [EditorBrowsable(EditorBrowsableState.Never)]
314 /// Start resizing window to the top side.
316 [EditorBrowsable(EditorBrowsableState.Never)]
319 /// Start resizing window to the top-right edge.
321 [EditorBrowsable(EditorBrowsableState.Never)]
324 /// Start resizing window to the left side.
326 [EditorBrowsable(EditorBrowsableState.Never)]
329 /// Start resizing window to the right side.
331 [EditorBrowsable(EditorBrowsableState.Never)]
334 /// Start resizing window to the bottom-left edge.
336 [EditorBrowsable(EditorBrowsableState.Never)]
339 /// Start resizing window to the bottom side.
341 [EditorBrowsable(EditorBrowsableState.Never)]
344 /// Start resizing window to the bottom-right edge.
346 [EditorBrowsable(EditorBrowsableState.Never)]
352 /// The stage instance property (read-only).<br />
353 /// Gets the current window.<br />
355 /// <since_tizen> 3 </since_tizen>
356 public static Window Instance { get; internal set; }
359 /// Gets or sets a window type.
360 /// Most of window type can be set to use WindowType, except for IME type.
361 /// IME type can be set to use one of NUIApplication's constrcutors.
363 /// <since_tizen> 3 </since_tizen>
364 public WindowType Type
368 WindowType ret = (WindowType)Interop.Window.GetType(SwigCPtr);
369 if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
374 Interop.Window.SetType(SwigCPtr, (int)value);
375 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
380 /// Gets/Sets a window title.
382 /// <since_tizen> 4 </since_tizen>
392 SetClass(windowTitle, "");
397 /// The rendering behavior of a Window.
399 /// <since_tizen> 5 </since_tizen>
400 public RenderingBehaviorType RenderingBehavior
404 return GetRenderingBehavior();
408 SetRenderingBehavior(value);
413 /// The window size property (read-only).
415 /// <since_tizen> 3 </since_tizen>
420 Size2D ret = GetSize();
426 /// The background color property.
428 /// <since_tizen> 3 </since_tizen>
429 public Color BackgroundColor
433 SetBackgroundColor(value);
437 Color ret = GetBackgroundColor();
443 /// The DPI property (read-only).<br />
444 /// Retrieves the DPI of the display device to which the Window is connected.<br />
446 /// <since_tizen> 3 </since_tizen>
456 /// The layer count property (read-only).<br />
457 /// Queries the number of on-Window layers.<br />
459 /// <since_tizen> 3 </since_tizen>
460 public uint LayerCount
464 return GetLayerCount();
469 /// Gets or sets a size of the window.
471 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
472 /// <since_tizen> 4 </since_tizen>
473 public Size2D WindowSize
477 return GetWindowSize();
481 SetWindowSize(value);
486 /// Gets or sets a position of the window.
488 /// <exception cref="ArgumentNullException"> Thrown when value is null. </exception>
489 /// <since_tizen> 4 </since_tizen>
490 public Position2D WindowPosition
494 return GetPosition();
503 /// Sets position and size of the window. This API guarantees that
504 /// both moving and resizing of window will appear on the screen at once.
506 [EditorBrowsable(EditorBrowsableState.Never)]
507 public Rectangle WindowPositionSize
511 Position2D position = GetPosition();
512 Size2D size = GetSize();
513 Rectangle ret = new Rectangle(position.X, position.Y, size.Width, size.Height);
519 SetPositionSize(value);
523 internal static Vector4 DEFAULT_BACKGROUND_COLOR
527 global::System.IntPtr cPtr = Interop.Stage.DefaultBackgroundColorGet();
528 Vector4 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector4(cPtr, false);
529 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
534 internal static Vector4 DEBUG_BACKGROUND_COLOR
538 global::System.IntPtr cPtr = Interop.Stage.DebugBackgroundColorGet();
539 Vector4 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector4(cPtr, false);
540 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
545 internal List<Layer> LayersChildren
554 /// Get the LayoutController for this Window.
556 internal LayoutController LayoutController
560 return localController;
565 /// Feed a key-event into the window.
567 /// <param name="keyEvent">The key event to feed.</param>
568 /// <since_tizen> 4 </since_tizen>
569 [Obsolete("Please do not use! This will be deprecated! Please use FeedKey(Key keyEvent) instead!")]
570 public static void FeedKeyEvent(Key keyEvent)
572 Interop.Window.FeedKeyEvent(Key.getCPtr(keyEvent));
573 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
577 /// Sets whether the window accepts a focus or not.
579 /// <param name="accept">If a focus is accepted or not. The default is true.</param>
580 /// <since_tizen> 3 </since_tizen>
581 public void SetAcceptFocus(bool accept)
583 Interop.Window.SetAcceptFocus(SwigCPtr, accept);
584 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
588 /// Returns whether the window accepts a focus or not.
590 /// <returns>True if the window accepts a focus, false otherwise.</returns>
591 /// <since_tizen> 3 </since_tizen>
592 public bool IsFocusAcceptable()
594 bool ret = Interop.Window.IsFocusAcceptable(SwigCPtr);
595 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
601 /// Shows the window if it is hidden.
603 /// <since_tizen> 3 </since_tizen>
606 Interop.Window.Show(SwigCPtr);
607 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
611 /// Hides the window if it is showing.
613 /// <since_tizen> 3 </since_tizen>
616 Interop.Window.Hide(SwigCPtr);
617 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
621 /// Retrieves whether the window is visible or not.
623 /// <returns>True if the window is visible.</returns>
624 /// <since_tizen> 3 </since_tizen>
625 public bool IsVisible()
627 bool temp = Interop.Window.IsVisible(SwigCPtr);
628 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
633 /// Gets the count of supported auxiliary hints of the window.
635 /// <returns>The number of supported auxiliary hints.</returns>
636 /// <since_tizen> 3 </since_tizen>
637 public uint GetSupportedAuxiliaryHintCount()
639 uint ret = Interop.Window.GetSupportedAuxiliaryHintCount(SwigCPtr);
640 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
645 /// Gets the supported auxiliary hint string of the window.
647 /// <param name="index">The index of the supported auxiliary hint lists.</param>
648 /// <returns>The auxiliary hint string of the index.</returns>
649 /// <since_tizen> 3 </since_tizen>
650 public string GetSupportedAuxiliaryHint(uint index)
652 string ret = Interop.Window.GetSupportedAuxiliaryHint(SwigCPtr, index);
653 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
658 /// Creates an auxiliary hint of the window.
660 /// <param name="hint">The auxiliary hint string.</param>
661 /// <param name="value">The value string.</param>
662 /// <returns>The ID of created auxiliary hint, or 0 on failure.</returns>
663 /// <since_tizen> 3 </since_tizen>
664 public uint AddAuxiliaryHint(string hint, string value)
666 uint ret = Interop.Window.AddAuxiliaryHint(SwigCPtr, hint, value);
667 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
672 /// Removes an auxiliary hint of the window.
674 /// <param name="id">The ID of the auxiliary hint.</param>
675 /// <returns>True if no error occurred, false otherwise.</returns>
676 /// <since_tizen> 3 </since_tizen>
677 public bool RemoveAuxiliaryHint(uint id)
679 bool ret = Interop.Window.RemoveAuxiliaryHint(SwigCPtr, id);
680 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
685 /// Changes a value of the auxiliary hint.
687 /// <param name="id">The auxiliary hint ID.</param>
688 /// <param name="value">The value string to be set.</param>
689 /// <returns>True if no error occurred, false otherwise.</returns>
690 /// <since_tizen> 3 </since_tizen>
691 public bool SetAuxiliaryHintValue(uint id, string value)
693 bool ret = Interop.Window.SetAuxiliaryHintValue(SwigCPtr, id, value);
694 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
699 /// Gets a value of the auxiliary hint.
701 /// <param name="id">The auxiliary hint ID.</param>
702 /// <returns>The string value of the auxiliary hint ID, or an empty string if none exists.</returns>
703 /// <since_tizen> 3 </since_tizen>
704 public string GetAuxiliaryHintValue(uint id)
706 string ret = Interop.Window.GetAuxiliaryHintValue(SwigCPtr, id);
707 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
712 /// Gets an ID of the auxiliary hint string.
714 /// <param name="hint">The auxiliary hint string.</param>
715 /// <returns>The ID of auxiliary hint string, or 0 on failure.</returns>
716 /// <since_tizen> 3 </since_tizen>
717 public uint GetAuxiliaryHintId(string hint)
719 uint ret = Interop.Window.GetAuxiliaryHintId(SwigCPtr, hint);
720 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
725 /// Sets a region to accept input events.
727 /// <param name="inputRegion">The region to accept input events.</param>
728 /// <since_tizen> 3 </since_tizen>
729 public void SetInputRegion(Rectangle inputRegion)
731 Interop.Window.IncludeInputRegion(SwigCPtr, Rectangle.getCPtr(inputRegion));
732 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
736 /// Sets a priority level for the specified notification window.
738 /// <param name="level">The notification window level.</param>
739 /// <returns>True if no error occurred, false otherwise.</returns>
740 /// <since_tizen> 3 </since_tizen>
741 public bool SetNotificationLevel(NotificationLevel level)
743 var ret = (OperationResult)Interop.Window.SetNotificationLevel(SwigCPtr, (int)level);
744 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
745 return ret == OperationResult.Succeed;
749 /// Gets a priority level for the specified notification window.
751 /// <returns>The notification window level.</returns>
752 /// <since_tizen> 3 </since_tizen>
753 public NotificationLevel GetNotificationLevel()
755 NotificationLevel ret = (NotificationLevel)Interop.Window.GetNotificationLevel(SwigCPtr);
756 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
761 /// Sets a transparent window's visual state to opaque. <br />
762 /// If a visual state of a transparent window is opaque, <br />
763 /// then the window manager could handle it as an opaque window when calculating visibility.
765 /// <param name="opaque">Whether the window's visual state is opaque.</param>
766 /// <remarks>This will have no effect on an opaque window. <br />
767 /// It doesn't change transparent window to opaque window but lets the window manager know the visual state of the window.
769 /// <since_tizen> 3 </since_tizen>
770 public void SetOpaqueState(bool opaque)
772 Interop.Window.SetOpaqueState(SwigCPtr, opaque);
773 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
777 /// Returns whether a transparent window's visual state is opaque or not.
779 /// <returns>True if the window's visual state is opaque, false otherwise.</returns>
780 /// <remarks> The return value has no meaning on an opaque window. </remarks>
781 /// <since_tizen> 3 </since_tizen>
782 public bool IsOpaqueState()
784 bool ret = Interop.Window.IsOpaqueState(SwigCPtr);
785 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
790 /// Sets a window's screen off mode.
792 /// <param name="screenOffMode">The screen mode.</param>
793 /// <returns>True if no error occurred, false otherwise.</returns>
794 /// <since_tizen> 4 </since_tizen>
795 public bool SetScreenOffMode(ScreenOffMode screenOffMode)
797 var ret = (OperationResult)Interop.Window.SetScreenOffMode(SwigCPtr, (int)screenOffMode);
798 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
799 return ret == OperationResult.Succeed;
803 /// Gets the screen mode of the window.
805 /// <returns>The screen off mode.</returns>
806 /// <since_tizen> 4 </since_tizen>
807 public ScreenOffMode GetScreenOffMode()
809 ScreenOffMode ret = (ScreenOffMode)Interop.Window.GetScreenOffMode(SwigCPtr);
810 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
815 /// Sets preferred brightness of the window.
817 /// <param name="brightness">The preferred brightness (0 to 100).</param>
818 /// <returns>True if no error occurred, false otherwise.</returns>
819 /// <since_tizen> 3 </since_tizen>
820 public bool SetBrightness(int brightness)
822 var ret = (OperationResult)Interop.Window.SetBrightness(SwigCPtr, brightness);
823 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
824 return ret == OperationResult.Succeed;
828 /// Gets the preferred brightness of the window.
830 /// <returns>The preferred brightness.</returns>
831 /// <since_tizen> 3 </since_tizen>
832 public int GetBrightness()
834 int ret = Interop.Window.GetBrightness(SwigCPtr);
835 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
840 /// Sets the window name and the class string.
842 /// <param name="name">The name of the window.</param>
843 /// <param name="klass">The class of the window.</param>
844 /// <since_tizen> 4 </since_tizen>
845 public void SetClass(string name, string klass)
847 Interop.Window.SetClass(SwigCPtr, name, klass);
848 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
852 /// Raises the window to the top of the window stack.
854 /// <since_tizen> 3 </since_tizen>
857 Interop.Window.Raise(SwigCPtr);
858 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
862 /// Lowers the window to the bottom of the window stack.
864 /// <since_tizen> 3 </since_tizen>
867 Interop.Window.Lower(SwigCPtr);
868 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
872 /// Activates the window to the top of the window stack even it is iconified.
874 /// <since_tizen> 3 </since_tizen>
875 public void Activate()
877 Interop.Window.Activate(SwigCPtr);
878 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
882 /// Gets the default ( root ) layer.
884 /// <returns>The root layer.</returns>
885 /// <since_tizen> 3 </since_tizen>
886 public Layer GetDefaultLayer()
888 return this.GetRootLayer();
892 /// Add a child view to window.
894 /// <param name="view">the child should be added to the window.</param>
895 /// <since_tizen> 3 </since_tizen>
896 public void Add(View view)
898 Interop.Actor.Add(Layer.getCPtr(GetRootLayer()), View.getCPtr(view));
899 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
900 this.GetRootLayer().AddViewToLayerList(view); // Maintain the children list in the Layer
903 view.InternalParent = this.GetRootLayer();
908 /// Remove a child view from window.
910 /// <param name="view">the child to be removed.</param>
911 /// <since_tizen> 3 </since_tizen>
912 public void Remove(View view)
914 Interop.Actor.Remove(Layer.getCPtr(GetRootLayer()), View.getCPtr(view));
915 this.GetRootLayer().RemoveViewFromLayerList(view); // Maintain the children list in the Layer
918 view.InternalParent = null;
923 /// Retrieves the layer at a specified depth.
925 /// <param name="depth">The layer's depth index.</param>
926 /// <returns>The layer found at the given depth.</returns>
927 /// <since_tizen> 3 </since_tizen>
928 public Layer GetLayer(uint depth)
930 if (depth < LayersChildren?.Count)
932 Layer ret = LayersChildren?[Convert.ToInt32(depth)];
942 /// Destroy the window immediately.
944 [EditorBrowsable(EditorBrowsableState.Never)]
945 public void Destroy()
951 /// Keep rendering for at least the given amount of time.
953 /// <param name="durationSeconds">Time to keep rendering, 0 means render at least one more frame.</param>
954 /// <since_tizen> 3 </since_tizen>
955 public void KeepRendering(float durationSeconds)
957 Interop.Stage.KeepRendering(stageCPtr, durationSeconds);
958 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
962 /// Grabs the key specified by a key for a window only when a window is the topmost window.<br />
963 /// This function can be used for following example scenarios: <br />
964 /// - Mobile - Using volume up or down as zoom up or down in camera apps.<br />
966 /// <param name="DaliKey">The key code to grab.</param>
967 /// <returns>True if the grab succeeds.</returns>
968 /// <since_tizen> 3 </since_tizen>
969 public bool GrabKeyTopmost(int DaliKey)
971 bool ret = Interop.Window.GrabKeyTopmost(HandleRef.ToIntPtr(this.SwigCPtr), DaliKey);
972 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
977 /// Ungrabs the key specified by a key for the window.<br />
978 /// Note: If this function is called between key down and up events of a grabbed key, an application doesn't receive the key up event.<br />
980 /// <param name="DaliKey">The key code to ungrab.</param>
981 /// <returns>True if the ungrab succeeds.</returns>
982 /// <since_tizen> 3 </since_tizen>
983 public bool UngrabKeyTopmost(int DaliKey)
985 bool ret = Interop.Window.UngrabKeyTopmost(HandleRef.ToIntPtr(this.SwigCPtr), DaliKey);
986 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
991 /// Grabs the key specified by a key for a window in a GrabMode. <br />
992 /// Details: This function can be used for following example scenarios: <br />
993 /// - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app. <br />
994 /// - Mobile - When a user presses the Home key, the homescreen appears regardless of the current foreground app. <br />
995 /// - Mobile - Using the volume up or down as zoom up or down in camera apps. <br />
997 /// <param name="DaliKey">The key code to grab.</param>
998 /// <param name="GrabMode">The grab mode for the key.</param>
999 /// <returns>True if the grab succeeds.</returns>
1000 /// <since_tizen> 3 </since_tizen>
1001 public bool GrabKey(int DaliKey, KeyGrabMode GrabMode)
1003 bool ret = Interop.Window.GrabKey(HandleRef.ToIntPtr(this.SwigCPtr), DaliKey, (int)GrabMode);
1004 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1009 /// Ungrabs the key specified by a key for a window.<br />
1010 /// Note: If this function is called between key down and up events of a grabbed key, an application doesn't receive the key up event. <br />
1012 /// <param name="DaliKey">The key code to ungrab.</param>
1013 /// <returns>True if the ungrab succeeds.</returns>
1014 /// <since_tizen> 3 </since_tizen>
1015 public bool UngrabKey(int DaliKey)
1017 bool ret = Interop.Window.UngrabKey(HandleRef.ToIntPtr(this.SwigCPtr), DaliKey);
1018 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1023 /// Sets the keyboard repeat information.
1025 /// <param name="rate">The key repeat rate value in seconds.</param>
1026 /// <param name="delay">The key repeat delay value in seconds.</param>
1027 /// <returns>True if setting the keyboard repeat succeeds.</returns>
1028 /// <since_tizen> 5 </since_tizen>
1029 public bool SetKeyboardRepeatInfo(float rate, float delay)
1031 bool ret = Interop.Window.SetKeyboardRepeatInfo(rate, delay);
1032 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1037 /// Gets the keyboard repeat information.
1039 /// <param name="rate">The key repeat rate value in seconds.</param>
1040 /// <param name="delay">The key repeat delay value in seconds.</param>
1041 /// <returns>True if setting the keyboard repeat succeeds.</returns>
1042 /// <since_tizen> 5 </since_tizen>
1043 public bool GetKeyboardRepeatInfo(out float rate, out float delay)
1045 bool ret = Interop.Window.GetKeyboardRepeatInfo(out rate, out delay);
1046 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1051 /// Adds a layer to the stage.
1053 /// <param name="layer">Layer to add.</param>
1054 /// <exception cref="ArgumentNullException"> Thrown when layer is null. </exception>
1055 /// <since_tizen> 3 </since_tizen>
1056 public void AddLayer(Layer layer)
1062 /// Removes a layer from the stage.
1064 /// <param name="layer">Layer to remove.</param>
1065 /// <exception cref="ArgumentNullException"> Thrown when layer is null. </exception>
1066 /// <since_tizen> 3 </since_tizen>
1067 public void RemoveLayer(Layer layer)
1073 /// Feeds a key event into the window.
1075 /// <param name="keyEvent">The key event to feed.</param>
1076 /// <since_tizen> 5 </since_tizen>
1077 public void FeedKey(Key keyEvent)
1079 Interop.Window.FeedKeyEvent(Key.getCPtr(keyEvent));
1080 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1084 /// Allows at least one more render, even when paused.
1085 /// The window should be shown, not minimised.
1087 /// <since_tizen> 4 </since_tizen>
1088 public void RenderOnce()
1090 Interop.Window.RenderOnce(SwigCPtr);
1091 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1095 /// Sets whether the window is transparent or not.
1097 /// <param name="transparent">Whether the window is transparent or not.</param>
1098 /// <since_tizen> 5 </since_tizen>
1099 public void SetTransparency(bool transparent)
1101 Interop.Window.SetTransparency(SwigCPtr, transparent);
1102 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1104 // Setting transparency of the window should request a relayout of the tree in the case the window changes from fully transparent.
1108 /// Sets parent window of the window.
1109 /// After setting that, these windows do together when raise-up, lower and iconified/deiconified.
1110 /// Initially, the window is located on top of the parent. The window can go below parent by calling Lower().
1111 /// If parent's window stack is changed by calling Raise() or Lower(), child windows are located on top of the parent again.
1113 /// <param name="parent">The parent window.</param>
1114 /// <since_tizen> 6 </since_tizen>
1115 /// <feature> http://tizen.org/feature/opengles.surfaceless_context </feature>
1116 /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
1117 public void SetParent(Window parent)
1119 if (IsSupportedMultiWindow() == false)
1121 NUILog.Error("This device does not support surfaceless_context. So Window cannot be created. ");
1123 Interop.Window.SetParent(SwigCPtr, Window.getCPtr(parent));
1124 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1128 /// Sets parent window of the window.
1129 /// After setting that, these windows do together when raise-up, lower and iconified/deiconified.
1130 /// This function has the additional flag whether the child is located above or below of the parent.
1132 /// <param name="parent">The parent window.</param>
1133 /// <param name="belowParent">The flag is whether the child is located above or below of the parent.</param>
1134 /// <feature> http://tizen.org/feature/opengles.surfaceless_context </feature>
1135 /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
1136 [EditorBrowsable(EditorBrowsableState.Never)]
1137 public void SetParent(Window parent, bool belowParent)
1139 if (IsSupportedMultiWindow() == false)
1141 NUILog.Error("This device does not support surfaceless_context. So Window cannot be created. ");
1143 Interop.Window.SetParentWithStack(SwigCPtr, Window.getCPtr(parent), belowParent);
1144 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1148 /// Unsets parent window of the window.
1149 /// After unsetting, the window is disconnected his parent window.
1151 /// <since_tizen> 6 </since_tizen>
1152 /// <feature> http://tizen.org/feature/opengles.surfaceless_context </feature>
1153 /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
1154 public void Unparent()
1156 if (IsSupportedMultiWindow() == false)
1158 NUILog.Error("Fail to create window. because this device does not support opengles.surfaceless_context.");
1160 Interop.Window.Unparent(SwigCPtr);
1161 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1165 /// Gets parent window of the window.
1167 /// <returns>The parent window of the window.</returns>
1168 /// <since_tizen> 6 </since_tizen>
1169 /// <feature> http://tizen.org/feature/opengles.surfaceless_context </feature>
1170 /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
1171 [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1721: Property names should not match get methods")]
1172 public Window GetParent()
1174 if (IsSupportedMultiWindow() == false)
1176 NUILog.Error("This device does not support surfaceless_context. So Window cannot be created. ");
1178 Window ret = Registry.GetManagedBaseHandleFromNativePtr(Interop.Window.GetParent(SwigCPtr)) as Window;
1179 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1183 /// This will be public opened in tizen_next after ACR done. Before ACR, need to be hidden as inhouse API.
1184 [EditorBrowsable(EditorBrowsableState.Never)]
1185 public void ObjectDump()
1187 Layer rootLayer = GetRootLayer();
1188 foreach (View view in rootLayer.Children)
1194 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Window obj)
1196 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.SwigCPtr;
1199 internal static bool IsInstalled()
1201 bool ret = Interop.Stage.IsInstalled();
1202 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1207 /// Adds an orientation to the list of available orientations.
1209 /// <param name="orientation">The available orientation to add</param>
1210 /// <since_tizen> 6 </since_tizen>
1211 public void AddAvailableOrientation(Window.WindowOrientation orientation)
1213 Interop.Window.AddAvailableOrientation(SwigCPtr, (int)orientation);
1214 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1218 /// Removes an orientation from the list of available orientations.
1220 /// <param name="orientation">The available orientation to remove.</param>
1221 /// <since_tizen> 6 </since_tizen>
1222 public void RemoveAvailableOrientation(Window.WindowOrientation orientation)
1224 Interop.Window.RemoveAvailableOrientation(SwigCPtr, (int)orientation);
1225 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1229 /// Sets a preferred orientation.
1231 /// <param name="orientation">The preferred orientation.</param>
1232 /// <since_tizen> 6 </since_tizen>
1233 public void SetPreferredOrientation(Window.WindowOrientation orientation)
1235 Interop.Window.SetPreferredOrientation(SwigCPtr, (int)orientation);
1236 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1240 /// Gets the preferred orientation.
1242 /// <since_tizen> 6 </since_tizen>
1243 /// <returns>The preferred orientation if previously set, or none.</returns>
1244 public Window.WindowOrientation GetPreferredOrientation()
1246 Window.WindowOrientation ret = (Window.WindowOrientation)Interop.Window.GetPreferredOrientation(SwigCPtr);
1247 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1252 /// Gets current orientation of the window.
1254 /// <since_tizen> 6 </since_tizen>
1255 /// <returns>The current window orientation if previously set, or none.</returns>
1256 [EditorBrowsable(EditorBrowsableState.Never)]
1257 public Window.WindowOrientation GetCurrentOrientation()
1259 Window.WindowOrientation ret = (Window.WindowOrientation)Interop.Window.GetCurrentOrientation(SwigCPtr);
1260 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1265 /// Sets available orientations of the window.
1266 /// This API is for setting several orientations one time.
1268 /// <param name="orientations">The list of orientations.</param>
1269 /// <since_tizen> 6 </since_tizen>
1270 [EditorBrowsable(EditorBrowsableState.Never)]
1271 public void SetAvailableOrientations(List<Window.WindowOrientation> orientations)
1273 if (null == orientations)
1275 throw new ArgumentNullException(nameof(orientations));
1278 PropertyArray orientationArray = new PropertyArray();
1279 for (int i = 0; i < orientations.Count; i++)
1281 PropertyValue value = new PropertyValue((int)orientations[i]);
1282 orientationArray.PushBack(value);
1286 Interop.Window.SetAvailableOrientations(SwigCPtr, PropertyArray.getCPtr(orientationArray), orientations.Count);
1287 orientationArray.Dispose();
1288 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1292 /// Get native window ID
1294 /// <returns>native window ID</returns>
1295 [EditorBrowsable(EditorBrowsableState.Never)]
1296 public int GetNativeId()
1298 int ret = Interop.Window.GetNativeId(SwigCPtr);
1299 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1303 internal Any GetNativeHandle()
1305 Any ret = new Any(Interop.WindowInternal.WindowGetNativeHandle(SwigCPtr), true);
1306 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1310 internal void Add(Layer layer)
1314 throw new ArgumentNullException(nameof(layer));
1316 Interop.Window.Add(SwigCPtr, Layer.getCPtr(layer));
1317 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1319 LayersChildren?.Add(layer);
1320 layer.SetWindow(this);
1323 internal void Remove(Layer layer)
1327 throw new ArgumentNullException(nameof(layer));
1329 Interop.Window.Remove(SwigCPtr, Layer.getCPtr(layer));
1330 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1332 LayersChildren?.Remove(layer);
1333 layer.SetWindow(null);
1336 internal Vector2 GetSize()
1338 var val = new Uint16Pair(Interop.Window.GetSize(SwigCPtr), true);
1339 Vector2 ret = new Vector2(val.GetWidth(), val.GetHeight());
1340 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1344 /// This will be public opened in next tizen after ACR done. Before ACR, need to be hidden as inhouse API.
1345 [EditorBrowsable(EditorBrowsableState.Never)]
1346 public RenderTaskList GetRenderTaskList()
1348 RenderTaskList ret = new RenderTaskList(Interop.Stage.GetRenderTaskList(stageCPtr), true);
1349 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1354 /// Queries the number of on-window layers.
1356 /// <returns>The number of layers.</returns>
1357 /// <remarks>Note that a default layer is always provided (count >= 1).</remarks>
1358 internal uint GetLayerCount()
1360 if (LayersChildren == null || LayersChildren.Count < 0)
1363 return (uint)LayersChildren.Count;
1366 internal Layer GetRootLayer()
1368 // Window.IsInstalled() is actually true only when called from event thread and
1369 // Core has been initialized, not when Stage is ready.
1370 if (rootLayer == null && Window.IsInstalled())
1372 rootLayer = new Layer(Interop.Window.GetRootLayer(SwigCPtr), true);
1373 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1374 LayersChildren?.Add(rootLayer);
1375 rootLayer.SetWindow(this);
1380 internal void SetBackgroundColor(Vector4 color)
1382 Interop.Window.SetBackgroundColor(SwigCPtr, Vector4.getCPtr(color));
1383 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1386 internal Vector4 GetBackgroundColor()
1388 Vector4 ret = new Vector4(Interop.Window.GetBackgroundColor(SwigCPtr), true);
1389 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1393 internal Vector2 GetDpi()
1395 Vector2 ret = new Vector2(Interop.Stage.GetDpi(stageCPtr), true);
1396 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1400 internal ObjectRegistry GetObjectRegistry()
1402 ObjectRegistry ret = new ObjectRegistry(Interop.Stage.GetObjectRegistry(stageCPtr), true);
1403 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1407 internal void SetRenderingBehavior(RenderingBehaviorType renderingBehavior)
1409 Interop.Stage.SetRenderingBehavior(stageCPtr, (int)renderingBehavior);
1410 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1413 internal RenderingBehaviorType GetRenderingBehavior()
1415 RenderingBehaviorType ret = (RenderingBehaviorType)Interop.Stage.GetRenderingBehavior(stageCPtr);
1416 if (NDalicPINVOKE.SWIGPendingException.Pending)
1417 throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1421 internal void SetWindowSize(Size2D size)
1425 throw new ArgumentNullException(nameof(size));
1427 var val = new Uint16Pair((uint)size.Width, (uint)size.Height);
1428 Interop.Window.SetSize(SwigCPtr, Uint16Pair.getCPtr(val));
1430 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1431 // Resetting Window size should request a relayout of the tree.
1434 internal Size2D GetWindowSize()
1436 var val = new Uint16Pair(Interop.Window.GetSize(SwigCPtr), true);
1437 Size2D ret = new Size2D(val.GetWidth(), val.GetHeight());
1438 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1442 internal void SetPosition(Position2D position)
1444 if (null == position)
1446 throw new ArgumentNullException(nameof(position));
1448 var val = new Uint16Pair((uint)position.X, (uint)position.Y);
1449 Interop.Window.SetPosition(SwigCPtr, Uint16Pair.getCPtr(val));
1451 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1452 // Setting Position of the window should request a relayout of the tree.
1455 internal Position2D GetPosition()
1457 var val = new Uint16Pair(Interop.Window.GetPosition(SwigCPtr), true);
1458 Position2D ret = new Position2D(val.GetX(), val.GetY());
1460 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1464 internal void SetPositionSize(Rectangle positionSize)
1466 Interop.Window.SetPositionSize(SwigCPtr, Rectangle.getCPtr(positionSize));
1468 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1470 // Setting Position of the window should request a relayout of the tree.
1474 /// Enables the floating mode of window.
1475 /// The floating mode is to support window is moved or resized by display server.
1476 /// For example, if the video-player window sets the floating mode,
1477 /// then display server changes its geometry and handles it like a popup.
1478 /// The way of handling floating mode window is decided by display server.
1479 /// A special display server(as a Tizen display server) supports this mode.
1481 /// <param name="enable">Enable floating mode or not.</param>
1482 [EditorBrowsable(EditorBrowsableState.Never)]
1483 public void EnableFloatingMode(bool enable)
1485 Interop.Window.EnableFloatingMode(SwigCPtr, enable);
1486 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1490 /// Requests to display server for the window is moved by display server.
1491 /// It can be work with setting window floating mode.
1493 [EditorBrowsable(EditorBrowsableState.Never)]
1494 public void RequestMoveToServer()
1496 Interop.Window.RequestMoveToServer(SwigCPtr);
1497 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1501 /// Requests to display server for the window is resized by display server.
1502 /// It can be work with setting window floating mode.
1504 /// <param name="direction">It is indicated the window's side or edge for starting point.</param>
1505 [EditorBrowsable(EditorBrowsableState.Never)]
1506 public void RequestResizeToServer(ResizeDirection direction)
1508 Interop.Window.RequestResizeToServer(SwigCPtr, (int)direction);
1509 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1513 /// Includes input region.
1514 /// This function inlcudes input regions.
1515 /// It can be used multiple times and supports multiple regions.
1516 /// It means input region will be extended.
1517 /// This input is related to mouse and touch event.
1518 /// If device has touch screen, this function is useful.
1519 /// Otherwise device does not have that, we can use it after connecting mouse to the device.
1521 /// <param name="inputRegion">The included region to accept input events.</param>
1522 [EditorBrowsable(EditorBrowsableState.Never)]
1523 public void IncludeInputRegion(Rectangle inputRegion)
1525 Interop.Window.IncludeInputRegion(SwigCPtr, Rectangle.getCPtr(inputRegion));
1526 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1530 /// This function excludes input regions.
1531 /// It can be used multiple times and supports multiple regions.
1532 /// It means input region will be reduced.
1533 /// Nofice, should be set input area by IncludeInputRegion() before this function is used.
1534 /// This input is related to mouse and touch event.
1535 /// If device has touch screen, this function is useful.
1536 /// Otherwise device does not have that, we can use it after connecting mouse to the device.
1538 /// <param name="inputRegion">The excluded region to except input events.</param>
1539 [EditorBrowsable(EditorBrowsableState.Never)]
1540 public void ExcludeInputRegion(Rectangle inputRegion)
1542 Interop.Window.ExcludeInputRegion(SwigCPtr, Rectangle.getCPtr(inputRegion));
1543 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1547 /// Add FrameUpdateCallback
1549 [EditorBrowsable(EditorBrowsableState.Never)]
1550 public void AddFrameUpdateCallback(FrameUpdateCallbackInterface frameUpdateCallback)
1552 frameUpdateCallback?.AddFrameUpdateCallback(stageCPtr, Layer.getCPtr(GetRootLayer()));
1556 /// Remove FrameUpdateCallback
1558 [EditorBrowsable(EditorBrowsableState.Never)]
1559 public void RemoveFrameUpdateCallback(FrameUpdateCallbackInterface frameUpdateCallback)
1561 frameUpdateCallback?.RemoveFrameUpdateCallback(stageCPtr);
1565 /// Dispose for Window
1567 [EditorBrowsable(EditorBrowsableState.Never)]
1568 protected override void Dispose(DisposeTypes type)
1575 if (type == DisposeTypes.Explicit)
1578 //Release your own managed resources here.
1579 //You should release all of your own disposable objects here.
1581 if (rootLayer != null)
1583 rootLayer.Dispose();
1586 localController?.Dispose();
1588 foreach (var layer in childLayers)
1596 childLayers.Clear();
1599 this.DisconnectNativeSignals();
1604 /// This will not be public opened.
1605 [EditorBrowsable(EditorBrowsableState.Never)]
1606 protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
1608 Interop.Window.DeleteWindow(swigCPtr);
1611 private static Dictionary<int, internalHookCallbackType> frameCallbackList = new Dictionary<int, internalHookCallbackType>();
1613 private static readonly object locker = new object();
1615 private static int key = 0;
1617 private static FrameCallbackType internalHookFrameCallback = OnInternalHookFrameCallback;
1619 private struct internalHookCallbackType
1621 public FrameCallbackType userCallback;
1625 private static void OnInternalHookFrameCallback(int id)
1629 if (frameCallbackList.ContainsKey(id))
1631 if (frameCallbackList[id].userCallback != null)
1633 frameCallbackList[id].userCallback.Invoke(frameCallbackList[id].frameId);
1634 frameCallbackList.Remove(id);
1638 NUILog.Error($"found userCallback is NULL");
1639 frameCallbackList.Remove(id);
1645 private int AddInterHookCallback(FrameCallbackType callback, int frameId)
1647 if (null == callback)
1649 throw new ArgumentNullException(nameof(callback), "FrameCallbackType should not be null");
1651 var assignedKey = 0;
1656 frameCallbackList.Add(assignedKey, new internalHookCallbackType()
1658 userCallback = callback,
1666 /// Type of callback which is called when the frame rendering is done by graphics driver or when the frame is displayed on display.
1668 /// <param name="frameId">The Id to specify the frame. It will be passed when the callback is called.</param>
1669 [EditorBrowsable(EditorBrowsableState.Never)]
1670 public delegate void FrameCallbackType(int frameId);
1673 /// Adds a callback that is called when the frame rendering is done by the graphics driver.
1674 /// A callback of the following type may be used:
1676 /// void MyFunction( int frameId )
1678 /// This callback will be deleted once it is called.
1680 /// Ownership of the callback is passed onto this class
1683 /// <param name="callback">The function to call</param>
1684 /// <param name="frameId">The Id to specify the frame. It will be passed when the callback is called.</param>
1685 /// <exception cref="ArgumentNullException">This exception can occur by the callback is null.</exception>
1686 [EditorBrowsable(EditorBrowsableState.Never)]
1687 public void AddFrameRenderedCallback(FrameCallbackType callback, int frameId)
1689 var assignedKey = AddInterHookCallback(callback, frameId);
1690 Interop.WindowInternal.AddFrameRenderedCallback(SwigCPtr, new HandleRef(this, Marshal.GetFunctionPointerForDelegate<Delegate>(internalHookFrameCallback)), assignedKey);
1692 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1696 /// Adds a callback that is called when the frame is displayed on the display.
1697 /// A callback of the following type may be used:
1699 /// void MyFunction( int frameId )
1701 /// This callback will be deleted once it is called.
1703 /// Ownership of the callback is passed onto this class
1706 /// <param name="callback">The function to call</param>
1707 /// <param name="frameId">The Id to specify the frame. It will be passed when the callback is called.</param>
1708 /// <exception cref="ArgumentNullException">This exception can occur by the callback is null.</exception>
1709 [EditorBrowsable(EditorBrowsableState.Never)]
1710 public void AddFramePresentedCallback(FrameCallbackType callback, int frameId)
1712 var assignedKey = AddInterHookCallback(callback, frameId);
1713 Interop.WindowInternal.AddFramePresentedCallback(SwigCPtr, new HandleRef(this, Marshal.GetFunctionPointerForDelegate<Delegate>(internalHookFrameCallback)), assignedKey);
1715 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
1719 /// Search through this Window for a Layer with the given unique ID.
1721 /// <param name="id">The ID of the Layer to find.</param>
1722 /// <remarks>Hidden-API</remarks>
1723 /// <returns>A handle to the Layer if found, or an empty handle if not.</returns>
1724 [EditorBrowsable(EditorBrowsableState.Never)]
1725 public Layer FindLayerByID(uint id)
1727 Layer defaultLayer = this.GetDefaultLayer();
1728 IntPtr cPtr = Interop.Actor.FindChildById(defaultLayer.SwigCPtr, id);
1729 Layer ret = this.GetInstanceSafely<Layer>(cPtr);
1731 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();