Class Window
Definition
- Assembly:
- Tizen.NUI.dll
The window class is used internally for drawing.
The window has an orientation and indicator properties.
public class Window : BaseHandle, IDynamicResourceHandler, INameScope, System.IDisposable
- Inheritance
- Implements
-
System.IDisposable
Constructors
View SourceWindow(string, IBorderInterface, Rectangle, bool)
Creates a new Window with a specific name.
This creates an extra window in addition to the default main window
Declaration
public Window(string name, IBorderInterface borderInterface, Rectangle windowPosition = null, bool isTranslucent = false)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name for extra window. |
IBorderInterface | borderInterface | IBorderInterfaceIf borderInterface is null, defaultBorder is enabled. |
Rectangle | windowPosition | The position and size of the Window. |
bool | isTranslucent | Whether Window is translucent. |
Window(string, Rectangle, bool)
Creates a new Window with a specific name.
This creates an extra window in addition to the default main window
Declaration
public Window(string name, Rectangle windowPosition = null, bool isTranslucent = false)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name for extra window. |
Rectangle | windowPosition | The position and size of the Window. |
bool | isTranslucent | Whether Window is translucent. |
Window(string, WindowData)
Creates a new Window with a specific name using WindowData.
This creates an extra window in addition to the default main window
Declaration
public Window(string name, WindowData windowData)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name for extra window. |
WindowData | windowData | The window data |
Window(Rectangle, bool)
Creates a new Window.
This creates an extra window in addition to the default main window
Declaration
public Window(Rectangle windowPosition = null, bool isTranslucent = false)
Parameters
Type | Name | Description |
---|---|---|
Rectangle | windowPosition | The position and size of the Window. |
bool | isTranslucent | Whether Window is translucent. |
Properties
View SourceBackgroundColor
The background color property.
Declaration
public Color BackgroundColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
DispatchHoverMotion
Gets or sets the status of whether motion event of Hover can be dispatched. If a Window's DispatchHoverMotion is set to false, then it's can not will receive motion event of HoverEvent.
Declaration
public bool DispatchHoverMotion { get; set; }
Property Value
Type | Description |
---|---|
bool |
DispatchTouchMotion
Gets or sets the status of whether motion event of Touch can be dispatched. If a Window's DispatchTouchMotion is set to false, then it's can not will receive motion event of TouchEvent.
Declaration
public bool DispatchTouchMotion { get; set; }
Property Value
Type | Description |
---|---|
bool |
Dpi
The DPI property (read-only).
Retrieves the DPI of the display device to which the Window is connected.
Declaration
public Vector2 Dpi { get; }
Property Value
Type | Description |
---|---|
Vector2 |
Instance
The stage instance property (read-only).
Gets the current window.
Declaration
public static Window Instance { get; }
Property Value
Type | Description |
---|---|
Window |
IsBorderEnabled
Whether the border is enabled.
Declaration
public bool IsBorderEnabled { get; }
Property Value
Type | Description |
---|---|
bool |
LayerCount
The layer count property (read-only).
Queries the number of on-Window layers.
Declaration
public uint LayerCount { get; }
Property Value
Type | Description |
---|---|
uint |
NativeHandle
Get Native Window handle.
Window window = NUIApplication.GetDefaultWindow();
var handle = window.NativeHandle;
if(handle.IsInvalid == false)
{
IntPtr nativeHandle = handle.DangerousGetHandle();
// do something with nativeHandle
}
Declaration
public SafeHandle NativeHandle { get; }
Property Value
Type | Description |
---|---|
SafeHandle |
PartialUpdate
Gets or sets whether the window will update partial area or full area. If this value is true, window will update and render partial area. If false, full area updated.
Declaration
public bool PartialUpdate { get; set; }
Property Value
Type | Description |
---|---|
bool |
RenderingBehavior
The rendering behavior of a Window.
Declaration
public RenderingBehaviorType RenderingBehavior { get; set; }
Property Value
Type | Description |
---|---|
RenderingBehaviorType |
Size
The window size property (read-only).
Declaration
public Size2D Size { get; }
Property Value
Type | Description |
---|---|
Size2D |
Title
Gets/Sets a window title.
Declaration
public string Title { get; set; }
Property Value
Type | Description |
---|---|
string |
Type
Gets or sets a window type. Most of window type can be set to use WindowType, except for IME type. IME type can be set to use one of NUIApplication's constrcutors.
Declaration
public WindowType Type { get; set; }
Property Value
Type | Description |
---|---|
WindowType |
WindowPosition
Gets or sets a position of the window.
Declaration
public Position2D WindowPosition { get; set; }
Property Value
Type | Description |
---|---|
Position2D |
WindowPositionSize
Sets position and size of the window. This API guarantees that both moving and resizing of window will appear on the screen at once.
Declaration
public Rectangle WindowPositionSize { get; set; }
Property Value
Type | Description |
---|---|
Rectangle |
WindowPositionSizeWithBorder
Gets position and size of the border window
Declaration
public Rectangle WindowPositionSizeWithBorder { get; }
Property Value
Type | Description |
---|---|
Rectangle | The total window size including the border area in the default window. |
WindowSize
Gets or sets a size of the window.
Declaration
public Size2D WindowSize { get; set; }
Property Value
Type | Description |
---|---|
Size2D |
WindowSizeWithBorder
Gets size of the border window
Declaration
public Size2D WindowSizeWithBorder { get; }
Property Value
Type | Description |
---|---|
Size2D | The total window size including the border area in the default window. |
Methods
View SourceActivate()
Activates the window to the top of the window stack even it is iconified.
Declaration
public void Activate()
Add(View)
Add a child view to window.
Declaration
public void Add(View view)
Parameters
Type | Name | Description |
---|---|---|
View | view | the child should be added to the window. |
AddAuxiliaryHint(string, string)
Creates an auxiliary hint of the window.
Declaration
public uint AddAuxiliaryHint(string hint, string value)
Parameters
Type | Name | Description |
---|---|---|
string | hint | The auxiliary hint string. |
string | value | The value string. |
Returns
Type | Description |
---|---|
uint | The ID of created auxiliary hint, or 0 on failure. |
AddAvailableOrientation(WindowOrientation)
Adds an orientation to the list of available orientations.
Declaration
public void AddAvailableOrientation(Window.WindowOrientation orientation)
Parameters
Type | Name | Description |
---|---|---|
Window.WindowOrientation | orientation | The available orientation to add |
AddFramePresentedCallback(FrameCallbackType, int)
Adds a callback that is called when the frame is displayed on the display. A callback of the following type may be used:
void MyFunction( int frameId )
This callback will be deleted once it is called.
Declaration
public void AddFramePresentedCallback(Window.FrameCallbackType callback, int frameId)
Parameters
Type | Name | Description |
---|---|---|
Window.FrameCallbackType | callback | The function to call |
int | frameId | The Id to specify the frame. It will be passed when the callback is called. |
AddFrameRenderedCallback(FrameCallbackType, int)
Adds a callback that is called when the frame rendering is done by the graphics driver. A callback of the following type may be used:
void MyFunction( int frameId )
This callback will be deleted once it is called.
Declaration
public void AddFrameRenderedCallback(Window.FrameCallbackType callback, int frameId)
Parameters
Type | Name | Description |
---|---|---|
Window.FrameCallbackType | callback | The function to call |
int | frameId | The Id to specify the frame. It will be passed when the callback is called. |
AddFrameUpdateCallback(FrameUpdateCallbackInterface, View)
Add FrameUpdateCallback with root view. FrameUpdateCallbackInterface can only detach Views under given view.
Declaration
public void AddFrameUpdateCallback(FrameUpdateCallbackInterface frameUpdateCallback, View rootView)
Parameters
Type | Name | Description |
---|---|---|
FrameUpdateCallbackInterface | frameUpdateCallback | |
View | rootView |
Remarks
We can give rootView as null if we want to make frameUpdateCallback don't have any dependency with some view.
AddFrameUpdateCallback(FrameUpdateCallbackInterface)
Add FrameUpdateCallback
Declaration
public void AddFrameUpdateCallback(FrameUpdateCallbackInterface frameUpdateCallback)
Parameters
Type | Name | Description |
---|---|---|
FrameUpdateCallbackInterface | frameUpdateCallback |
AddLayer(Layer)
Adds a layer to the stage.
Declaration
public void AddLayer(Layer layer)
Parameters
Type | Name | Description |
---|---|---|
Layer | layer | Layer to add. |
CursorVisibleSet(bool)
Sets visibility on/off of cursor
Declaration
public void CursorVisibleSet(bool visible)
Parameters
Type | Name | Description |
---|---|---|
bool | visible | The visibility of cursor. |
Destroy()
Destroy the window immediately.
Declaration
public void Destroy()
Dispose(DisposeTypes)
Dispose for Window
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type | Name | Description |
---|---|---|
DisposeTypes | type |
Overrides
View SourceEnableFloatingMode(bool)
Enables the floating mode of window. The floating mode is to support window is moved or resized by display server. For example, if the video-player window sets the floating mode, then display server changes its geometry and handles it like a popup. The way of handling floating mode window is decided by display server. A special display server(as a Tizen display server) supports this mode.
Declaration
public void EnableFloatingMode(bool enable)
Parameters
Type | Name | Description |
---|---|---|
bool | enable | Enable floating mode or not. |
ExcludeInputRegion(Rectangle)
This function excludes input regions. It can be used multiple times and supports multiple regions. It means input region will be reduced. Nofice, should be set input area by IncludeInputRegion() before this function is used. This input is related to mouse and touch event. If device has touch screen, this function is useful. Otherwise device does not have that, we can use it after connecting mouse to the device.
Declaration
public void ExcludeInputRegion(Rectangle inputRegion)
Parameters
Type | Name | Description |
---|---|---|
Rectangle | inputRegion | The excluded region to except input events. |
FeedKey(Key)
Feeds a key event into the window.
Declaration
public void FeedKey(Key keyEvent)
Parameters
Type | Name | Description |
---|---|---|
Key | keyEvent | The key event to feed. |
FeedKeyEvent(Key)
Feed a key-event into the window.
Declaration
public static void FeedKeyEvent(Key keyEvent)
Parameters
Type | Name | Description |
---|---|---|
Key | keyEvent | The key event to feed. |
FindLayerByID(uint)
Search through this Window for a Layer with the given unique ID.
Declaration
public Layer FindLayerByID(uint id)
Parameters
Type | Name | Description |
---|---|---|
uint | id | The ID of the Layer to find. |
Returns
Type | Description |
---|---|
Layer | A handle to the Layer if found, or an empty handle if not. |
Remarks
Hidden-API
Get(View)
A helper method to get the current window where the view is added
Declaration
public static Window Get(View view)
Parameters
Type | Name | Description |
---|---|---|
View | view | The View added to the window |
Returns
Type | Description |
---|---|
Window | A Window. |
GetAuxiliaryHintId(string)
Gets an ID of the auxiliary hint string.
Declaration
public uint GetAuxiliaryHintId(string hint)
Parameters
Type | Name | Description |
---|---|---|
string | hint | The auxiliary hint string. |
Returns
Type | Description |
---|---|
uint | The ID of auxiliary hint string, or 0 on failure. |
GetAuxiliaryHintValue(uint)
Gets a value of the auxiliary hint.
Declaration
public string GetAuxiliaryHintValue(uint id)
Parameters
Type | Name | Description |
---|---|---|
uint | id | The auxiliary hint ID. |
Returns
Type | Description |
---|---|
string | The string value of the auxiliary hint ID, or an empty string if none exists. |
GetBrightness()
Gets the preferred brightness of the window.
Declaration
public int GetBrightness()
Returns
Type | Description |
---|---|
int | The preferred brightness. |
GetCurrentOrientation()
Gets current orientation of the window.
Declaration
public Window.WindowOrientation GetCurrentOrientation()
Returns
Type | Description |
---|---|
Window.WindowOrientation | The current window orientation if previously set, or none. |
GetDefaultLayer()
Gets the default ( root ) layer.
Declaration
public Layer GetDefaultLayer()
Returns
Type | Description |
---|---|
Layer | The root layer. |
GetDirection(float, float)
Calculates which direction to resize or to move.
Declaration
public Window.BorderDirection GetDirection(float xPosition, float yPosition)
Parameters
Type | Name | Description |
---|---|---|
float | xPosition | The X position. |
float | yPosition | The Y position. |
Returns
Type | Description |
---|---|
Window.BorderDirection | The BorderDirection |
GetFullScreen()
Gets whether the full screen sized window or not.
Declaration
public bool GetFullScreen()
Returns
Type | Description |
---|---|
bool | Returns true if the full screen sized window is. |
GetKeyboardHorizentalRepeatInfo(out float, out float)
Gets the keyboard repeat information of horizontal way.
Declaration
public bool GetKeyboardHorizentalRepeatInfo(out float rate, out float delay)
Parameters
Type | Name | Description |
---|---|---|
float | rate | The key repeat rate value in seconds. |
float | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
bool | True if setting the keyboard repeat succeeds. |
GetKeyboardRepeatInfo(out float, out float)
Gets the keyboard repeat information.
Declaration
public bool GetKeyboardRepeatInfo(out float rate, out float delay)
Parameters
Type | Name | Description |
---|---|---|
float | rate | The key repeat rate value in seconds. |
float | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
bool | True if setting the keyboard repeat succeeds. |
GetKeyboardVerticalRepeatInfo(out float, out float)
Gets the keyboard repeat information of vertical way.
Declaration
public bool GetKeyboardVerticalRepeatInfo(out float rate, out float delay)
Parameters
Type | Name | Description |
---|---|---|
float | rate | The key repeat rate value in seconds. |
float | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
bool | True if setting the keyboard repeat succeeds. |
GetLastHoverEvent()
Gets the last hover event the window gets.
Declaration
public Hover GetLastHoverEvent()
Returns
Type | Description |
---|---|
Hover | The last hover event the window gets. |
Remarks
We will use weak reference of last hover events. Return value will be invalidated if last hover event changed internally.
GetLastKeyEvent()
Gets the last key event the window gets.
Declaration
public Key GetLastKeyEvent()
Returns
Type | Description |
---|---|
Key | The last key event the window gets. |
Remarks
We will use weak reference of last key events. Return value will be invalidated if last key event changed internally.
GetLastTouchEvent()
Gets the last touch event the window gets.
Declaration
public Touch GetLastTouchEvent()
Returns
Type | Description |
---|---|
Touch | The last touch event the window gets. |
Remarks
We will use weak reference of last touch events. Return value will be invalidated if last touch event changed internally.
GetLayer(uint)
Retrieves the layer at a specified depth.
Declaration
public Layer GetLayer(uint depth)
Parameters
Type | Name | Description |
---|---|---|
uint | depth | The layer's depth index. |
Returns
Type | Description |
---|---|
Layer | The layer found at the given depth. |
GetNativeId()
Get native window ID
Declaration
public int GetNativeId()
Returns
Type | Description |
---|---|
int | native window ID |
GetNotificationLevel()
Gets a priority level for the specified notification window.
Declaration
public NotificationLevel GetNotificationLevel()
Returns
Type | Description |
---|---|
NotificationLevel | The notification window level. |
GetOverlayLayer()
Gets the overlay layer.
Declaration
public Layer GetOverlayLayer()
Returns
Type | Description |
---|---|
Layer | The overlay layer. |
GetParent()
Gets parent window of the window.
Declaration
public Window GetParent()
Returns
Type | Description |
---|---|
Window | The parent window of the window. |
GetPreferredOrientation()
Gets the preferred orientation.
Declaration
public Window.WindowOrientation GetPreferredOrientation()
Returns
Type | Description |
---|---|
Window.WindowOrientation | The preferred orientation if previously set, or none. |
GetRenderTaskList()
Declaration
public RenderTaskList GetRenderTaskList()
Returns
Type | Description |
---|---|
RenderTaskList |
GetScreenOffMode()
Gets the screen mode of the window.
Declaration
public ScreenOffMode GetScreenOffMode()
Returns
Type | Description |
---|---|
ScreenOffMode | The screen off mode. |
GetSupportedAuxiliaryHint(uint)
Gets the supported auxiliary hint string of the window.
Declaration
public string GetSupportedAuxiliaryHint(uint index)
Parameters
Type | Name | Description |
---|---|---|
uint | index | The index of the supported auxiliary hint lists. |
Returns
Type | Description |
---|---|
string | The auxiliary hint string of the index. |
GetSupportedAuxiliaryHintCount()
Gets the count of supported auxiliary hints of the window.
Declaration
public uint GetSupportedAuxiliaryHintCount()
Returns
Type | Description |
---|---|
uint | The number of supported auxiliary hints. |
GrabKey(int, KeyGrabMode)
Grabs the key specified by a key for a window in a GrabMode.
Details: This function can be used for following example scenarios:
- TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app.
- Mobile - When a user presses the Home key, the homescreen appears regardless of the current foreground app.
- Mobile - Using the volume up or down as zoom up or down in camera apps.
Declaration
public bool GrabKey(int DaliKey, Window.KeyGrabMode GrabMode)
Parameters
Type | Name | Description |
---|---|---|
int | DaliKey | The key code to grab. |
Window.KeyGrabMode | GrabMode | The grab mode for the key. |
Returns
Type | Description |
---|---|
bool | True if the grab succeeds. |
GrabKeyTopmost(int)
Grabs the key specified by a key for a window only when a window is the topmost window.
This function can be used for following example scenarios:
- Mobile - Using volume up or down as zoom up or down in camera apps.
Declaration
public bool GrabKeyTopmost(int DaliKey)
Parameters
Type | Name | Description |
---|---|---|
int | DaliKey | The key code to grab. |
Returns
Type | Description |
---|---|
bool | True if the grab succeeds. |
Hide()
Hides the window if it is showing.
Declaration
public void Hide()
IncludeInputRegion(Rectangle)
Includes input region. This function inlcudes input regions. It can be used multiple times and supports multiple regions. It means input region will be extended. This input is related to mouse and touch event. If device has touch screen, this function is useful. Otherwise device does not have that, we can use it after connecting mouse to the device.
Declaration
public void IncludeInputRegion(Rectangle inputRegion)
Parameters
Type | Name | Description |
---|---|---|
Rectangle | inputRegion | The included region to accept input events. |
IsFloatingModeEnabled()
Returns whether the window is floating mode or not.
Declaration
public bool IsFloatingModeEnabled()
Returns
Type | Description |
---|---|
bool | True if the window is enabled floating mode, false otherwise. |
IsFocusAcceptable()
Returns whether the window accepts a focus or not.
Declaration
public bool IsFocusAcceptable()
Returns
Type | Description |
---|---|
bool | True if the window accepts a focus, false otherwise. |
IsMaximized()
Returns whether the window is maximized or not.
Declaration
public bool IsMaximized()
Returns
Type | Description |
---|---|
bool | True if the window is maximized, false otherwise. |
IsMinimized()
Returns whether the window is minimized or not.
Declaration
public bool IsMinimized()
Returns
Type | Description |
---|---|
bool | True if the window is minimized, false otherwise. |
IsOpaqueState()
Returns whether a transparent window's visual state is opaque or not.
Declaration
public bool IsOpaqueState()
Returns
Type | Description |
---|---|
bool | True if the window's visual state is opaque, false otherwise. |
Remarks
The return value has no meaning on an opaque window.
IsVisible()
Retrieves whether the window is visible or not.
Declaration
public bool IsVisible()
Returns
Type | Description |
---|---|
bool | True if the window is visible. |
IsWindowRotating()
Query whether window is rotating or not.
Declaration
public bool IsWindowRotating()
Returns
Type | Description |
---|---|
bool | True if window is rotating, false otherwise. |
KeepRendering(float)
Keep rendering for at least the given amount of time.
Declaration
public void KeepRendering(float durationSeconds)
Parameters
Type | Name | Description |
---|---|---|
float | durationSeconds | Time to keep rendering, 0 means render at least one more frame. |
KeyboardGrab(DeviceSubClassType)
Requests grab key events according to the requested device subtype
Declaration
public bool KeyboardGrab(DeviceSubClassType deviceSubclass)
Parameters
Type | Name | Description |
---|---|---|
DeviceSubClassType | deviceSubclass | The deviceSubclass type. |
Returns
Type | Description |
---|---|
bool | True if KeyboardGrab succeeds. |
KeyboardUnGrab()
Requests ungrab key events
Declaration
public bool KeyboardUnGrab()
Returns
Type | Description |
---|---|
bool | True if KeyboardUnGrab succeeds. |
LazyFeedHover(uint)
Feeds a hover event into the window.
This is feed after a default time of 48 ms. You can also set this time.
Declaration
public void LazyFeedHover(uint time = null)
Parameters
Type | Name | Description |
---|---|---|
uint | time | The time of how much later it will be feed (default is 48ms) |
Remarks
If you want to do FeedHover after the UI is updated, it is recommended to set the time to at least 16ms. This will be a good time waiting for the UI to update.
and LazyFeedHover called within the set time are ignored. Only the last request becomes a FeedHover.
LockedPointerCursorPositionHintSet(int, int)
Sets the locked pointer cursor position hintset
Declaration
public void LockedPointerCursorPositionHintSet(int x, int y)
Parameters
Type | Name | Description |
---|---|---|
int | x | The x position. |
int | y | The y position. |
LockedPointerRegionSet(int, int, int, int)
Sets the locked pointer region.
Declaration
public void LockedPointerRegionSet(int x, int y, int width, int height)
Parameters
Type | Name | Description |
---|---|---|
int | x | The x position. |
int | y | The y position. |
int | width | The width. |
int | height | The height. |
Lower()
Lowers the window to the bottom of the window stack.
Declaration
public void Lower()
Maximize(bool)
Maximizes window's size. If this function is called with true, window will be resized with screen size. Otherwise window will be resized with previous size. It is for the window's MAX button in window's border. If window border is supported by display server, it is not necessary.
Declaration
public void Maximize(bool max)
Parameters
Type | Name | Description |
---|---|---|
bool | max | If window is maximized or unmaximized. |
Minimize(bool)
Minimizes window's size. If this function is called with true, window will be iconified. Otherwise window will be activated. It is for the window's MIN button in window border. If window border is supported by display server, it is not necessary.
Declaration
public void Minimize(bool min)
Parameters
Type | Name | Description |
---|---|---|
bool | min | If window is minimized or unminimized. |
ObjectDump()
Declaration
public void ObjectDump()
PointerConstraintsLock()
Sets the pointer constraints lock.
Declaration
public bool PointerConstraintsLock()
Returns
Type | Description |
---|---|
bool | True if PointerConstraintsLock succeeds. |
PointerConstraintsUnlock()
Sets the pointer constraints unlock.
Declaration
public bool PointerConstraintsUnlock()
Returns
Type | Description |
---|---|
bool | True if PointerConstraintsUnlock succeeds. |
PointerWarp(int, int)
Sets the pointer warp. The pointer moves to the set coordinates.
Declaration
public bool PointerWarp(int x, int y)
Parameters
Type | Name | Description |
---|---|---|
int | x | The x position. |
int | y | The y position. |
Returns
Type | Description |
---|---|
bool | True if PointerWarp succeeds. |
Raise()
Raises the window to the top of the window stack.
Declaration
public void Raise()
ReleaseSwigCPtr(HandleRef)
Declaration
protected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type | Name | Description |
---|---|---|
Tizen.System.Runtime.InteropServices.HandleRef | swigCPtr |
Overrides
View SourceRemove(View)
Remove a child view from window.
Declaration
public void Remove(View view)
Parameters
Type | Name | Description |
---|---|---|
View | view | the child to be removed. |
RemoveAuxiliaryHint(uint)
Removes an auxiliary hint of the window.
Declaration
public bool RemoveAuxiliaryHint(uint id)
Parameters
Type | Name | Description |
---|---|---|
uint | id | The ID of the auxiliary hint. |
Returns
Type | Description |
---|---|
bool | True if no error occurred, false otherwise. |
RemoveAvailableOrientation(WindowOrientation)
Removes an orientation from the list of available orientations.
Declaration
public void RemoveAvailableOrientation(Window.WindowOrientation orientation)
Parameters
Type | Name | Description |
---|---|---|
Window.WindowOrientation | orientation | The available orientation to remove. |
RemoveFrameUpdateCallback(FrameUpdateCallbackInterface)
Remove FrameUpdateCallback
Declaration
public void RemoveFrameUpdateCallback(FrameUpdateCallbackInterface frameUpdateCallback)
Parameters
Type | Name | Description |
---|---|---|
FrameUpdateCallbackInterface | frameUpdateCallback |
RemoveLayer(Layer)
Removes a layer from the stage.
Declaration
public void RemoveLayer(Layer layer)
Parameters
Type | Name | Description |
---|---|---|
Layer | layer | Layer to remove. |
RenderOnce()
Allows at least one more render, even when paused. The window should be shown, not minimised.
Declaration
public void RenderOnce()
RequestMoveToServer()
Requests to display server for the window is moved by display server. It can be work with setting window floating mode.
Declaration
public void RequestMoveToServer()
RequestResizeToServer(ResizeDirection)
Requests to display server for the window is resized by display server. It can be work with setting window floating mode.
Declaration
public void RequestResizeToServer(Window.ResizeDirection direction)
Parameters
Type | Name | Description |
---|---|---|
Window.ResizeDirection | direction | It is indicated the window's side or edge for starting point. |
SendRotationCompletedAcknowledgement()
send the Acknowledgement to complete window rotation. For this function, SetNeedsRotationCompletedAcknowledgement should be already called with true.
Declaration
public void SendRotationCompletedAcknowledgement()
SetAcceptFocus(bool)
Sets whether the window accepts a focus or not.
Declaration
public void SetAcceptFocus(bool accept)
Parameters
Type | Name | Description |
---|---|---|
bool | accept | If a focus is accepted or not. The default is true. |
SetAuxiliaryHintValue(uint, string)
Changes a value of the auxiliary hint.
Declaration
public bool SetAuxiliaryHintValue(uint id, string value)
Parameters
Type | Name | Description |
---|---|---|
uint | id | The auxiliary hint ID. |
string | value | The value string to be set. |
Returns
Type | Description |
---|---|
bool | True if no error occurred, false otherwise. |
SetAvailableOrientations(List<WindowOrientation>)
Sets available orientations of the window. This API is for setting several orientations one time.
Declaration
public void SetAvailableOrientations(List<Window.WindowOrientation> orientations)
Parameters
Type | Name | Description |
---|---|---|
List<><WindowOrientation> | orientations | The list of orientations. |
SetBrightness(int)
Sets preferred brightness of the window.
Declaration
public bool SetBrightness(int brightness)
Parameters
Type | Name | Description |
---|---|---|
int | brightness | The preferred brightness (0 to 100). |
Returns
Type | Description |
---|---|
bool | True if no error occurred, false otherwise. |
SetClass(string, string)
Sets the window name and the class string.
Declaration
public void SetClass(string name, string klass)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of the window. |
string | klass | The class of the window. |
SetFullScreen(bool)
Sets to resize window with full screen. If full screen size is set for the window, window will be resized with full screen. In addition, the full screen sized window's z-order is the highest.
Declaration
public void SetFullScreen(bool fullscreen)
Parameters
Type | Name | Description |
---|---|---|
bool | fullscreen | If fullscreen is true, set fullscreen or unset. |
SetInputRegion(Rectangle)
Sets a region to accept input events.
Declaration
public void SetInputRegion(Rectangle inputRegion)
Parameters
Type | Name | Description |
---|---|---|
Rectangle | inputRegion | The region to accept input events. |
SetKeyboardHorizentalRepeatInfo(float, float)
Sets the keyboard repeat information of horizontal way.
Declaration
public bool SetKeyboardHorizentalRepeatInfo(float rate, float delay)
Parameters
Type | Name | Description |
---|---|---|
float | rate | The key repeat rate value in seconds. |
float | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
bool | True if setting the keyboard repeat succeeds. |
SetKeyboardRepeatInfo(float, float)
Sets the keyboard repeat information.
Declaration
public bool SetKeyboardRepeatInfo(float rate, float delay)
Parameters
Type | Name | Description |
---|---|---|
float | rate | The key repeat rate value in seconds. |
float | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
bool | True if setting the keyboard repeat succeeds. |
SetKeyboardVerticalRepeatInfo(float, float)
Sets the keyboard repeat information of vertical way.
Declaration
public bool SetKeyboardVerticalRepeatInfo(float rate, float delay)
Parameters
Type | Name | Description |
---|---|---|
float | rate | The key repeat rate value in seconds. |
float | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
bool | True if setting the keyboard repeat succeeds. |
SetLayout(uint, uint, uint, uint, uint, uint)
Sets the layout of the window.
Declaration
public void SetLayout(uint numCols, uint numRows, uint column, uint row, uint colSpan, uint rowSpan)
Parameters
Type | Name | Description |
---|---|---|
uint | numCols | The number of columns in the layout. |
uint | numRows | The number of rows in the layout. |
uint | column | The column number of the window within the layout. |
uint | row | The row number of the window within the layout. |
uint | colSpan | The number of columns the window should span within the layout. |
uint | rowSpan | The number of rows the window should span within the layout. |
SetLayout(WindowLayoutType)
Sets the layout of the window.
Declaration
public void SetLayout(WindowLayoutType layoutType)
Parameters
Type | Name | Description |
---|---|---|
WindowLayoutType | layoutType | The type of layout to set for the window. |
SetMaximumSize(Size2D)
Sets window's maximum size.
It is to set the maximized size when window is maximized or the window's size is increased by RequestResizeToServer(). Although the size is set by this function, window's size can be increased over the limitation by SetPositionSize() or SetSize().
After setting, if Maximize() is called, window is resized with the setting size and move the center.
Declaration
public void SetMaximumSize(Size2D size)
Parameters
Type | Name | Description |
---|---|---|
Size2D | size | the maximum size. |
SetMimimumSize(Size2D)
Sets window's minimum size. It is to set the minimum size when window's size is decreased by RequestResizeToServer(). Although the size is set by this function, window's size can be decreased over the limitation by SetPositionSize() or SetSize().
Declaration
public void SetMimimumSize(Size2D size)
Parameters
Type | Name | Description |
---|---|---|
Size2D | size | the minimum size. |
SetNeedsRotationCompletedAcknowledgement(bool)
Sets the necessary for window rotation Acknowledgement. After this function called, SendRotationCompletedAcknowledgement() should be called to complete window rotation.
This function is supprot that application has the window rotation acknowledgement's control. It means display server waits when application's rotation work is finished. It is useful application has the other rendering engine which works asynchronous. For instance, GlView.
Declaration
public void SetNeedsRotationCompletedAcknowledgement(bool needAcknowledgement)
Parameters
Type | Name | Description |
---|---|---|
bool | needAcknowledgement | the flag is true if window rotation acknowledge is sent. |
SetNotificationLevel(NotificationLevel)
Sets a priority level for the specified notification window.
Declaration
public bool SetNotificationLevel(NotificationLevel level)
Parameters
Type | Name | Description |
---|---|---|
NotificationLevel | level | The notification window level. |
Returns
Type | Description |
---|---|
bool | True if no error occurred, false otherwise. |
SetOpaqueState(bool)
Sets a transparent window's visual state to opaque.
If a visual state of a transparent window is opaque,
then the window manager could handle it as an opaque window when calculating visibility.
Declaration
public void SetOpaqueState(bool opaque)
Parameters
Type | Name | Description |
---|---|---|
bool | opaque | Whether the window's visual state is opaque. |
Remarks
This will have no effect on an opaque window.
It doesn't change transparent window to opaque window but lets the window manager know the visual state of the window.
SetParent(Window, bool)
Sets parent window of the window. After setting that, these windows do together when raise-up, lower and iconified/deiconified. This function has the additional flag whether the child is located above or below of the parent.
Declaration
public void SetParent(Window parent, bool belowParent)
Parameters
Type | Name | Description |
---|---|---|
Window | parent | The parent window. |
bool | belowParent | The flag is whether the child is located above or below of the parent. |
SetParent(Window)
Sets parent window of the window. After setting that, these windows do together when raise-up, lower and iconified/deiconified. Initially, the window is located on top of the parent. The window can go below parent by calling Lower(). If parent's window stack is changed by calling Raise() or Lower(), child windows are located on top of the parent again.
Declaration
public void SetParent(Window parent)
Parameters
Type | Name | Description |
---|---|---|
Window | parent | The parent window. |
SetPreferredOrientation(WindowOrientation)
Sets a preferred orientation.
Declaration
public void SetPreferredOrientation(Window.WindowOrientation orientation)
Parameters
Type | Name | Description |
---|---|---|
Window.WindowOrientation | orientation | The preferred orientation. |
SetScreenOffMode(ScreenOffMode)
Sets a window's screen off mode.
Declaration
public bool SetScreenOffMode(ScreenOffMode screenOffMode)
Parameters
Type | Name | Description |
---|---|---|
ScreenOffMode | screenOffMode | The screen mode. |
Returns
Type | Description |
---|---|
bool | True if no error occurred, false otherwise. |
SetTransparency(bool)
Sets whether the window is transparent or not.
Declaration
public void SetTransparency(bool transparent)
Parameters
Type | Name | Description |
---|---|---|
bool | transparent | Whether the window is transparent or not. |
Show()
Shows the window if it is hidden.
Declaration
public void Show()
UngrabKey(int)
Ungrabs the key specified by a key for a window.
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.
Declaration
public bool UngrabKey(int DaliKey)
Parameters
Type | Name | Description |
---|---|---|
int | DaliKey | The key code to ungrab. |
Returns
Type | Description |
---|---|
bool | True if the ungrab succeeds. |
UngrabKeyTopmost(int)
Ungrabs the key specified by a key for the window.
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.
Declaration
public bool UngrabKeyTopmost(int DaliKey)
Parameters
Type | Name | Description |
---|---|---|
int | DaliKey | The key code to ungrab. |
Returns
Type | Description |
---|---|
bool | True if the ungrab succeeds. |
Unparent()
Unsets parent window of the window. After unsetting, the window is disconnected his parent window.
Declaration
public void Unparent()
VisibiltyChangedSignalEmit(bool)
VisibiltyChangedSignalEmit
Declaration
public void VisibiltyChangedSignalEmit(bool visibility)
Parameters
Type | Name | Description |
---|---|---|
bool | visibility |
Events
View SourceAccessibilityHighlight
Emits the event when the window needs to grab or clear highlight.
Declaration
public event EventHandler<Window.AccessibilityHighlightEventArgs> AccessibilityHighlight
Event Type
Type | Description |
---|---|
EventHandler<><AccessibilityHighlightEventArgs> |
AuxiliaryMessage
Auxiliary message is sent by displayer server when window's auxiliary was changed then display server sent the message. When client application added the window's auxiliary hint and if the auxiliary is changed, display server send the auxiliary message. Auxiliary message has the key, value and options.
Declaration
public event EventHandler<AuxiliaryMessageEventArgs> AuxiliaryMessage
Event Type
Type | Description |
---|---|
EventHandler<><AuxiliaryMessageEventArgs> |
FocusChanged
FocusChanged event.
Declaration
public event EventHandler<Window.FocusChangedEventArgs> FocusChanged
Event Type
Type | Description |
---|---|
EventHandler<><FocusChangedEventArgs> |
HoverEvent
An event for the hovered signal which can be used to subscribe or unsubscribe the event handler provided by the user.
The hovered signal is emitted when the hover input is received.
Declaration
public event EventHandler<Window.HoverEventArgs> HoverEvent
Event Type
Type | Description |
---|---|
EventHandler<><HoverEventArgs> |
InsetsChanged
Emits the event when the window insets changes by status bar, virtual keyboard, or clipboard appears and disappears.
Declaration
public event EventHandler<Window.InsetsChangedEventArgs> InsetsChanged
Event Type
Type | Description |
---|---|
EventHandler<><InsetsChangedEventArgs> |
InterceptKeyEvent
Intercepts KeyEvents in the window before dispatching KeyEvents to the child.
If it returns true(consumed), no KeyEvent is delivered to the child.
Declaration
public event ReturnTypeEventHandler<object, Window.KeyEventArgs, bool> InterceptKeyEvent
Event Type
Type | Description |
---|---|
ReturnTypeEventHandler<object, Window.KeyEventArgs, bool> |
InterceptTouchEvent
An event for the touched signal which can be used to subscribe or unsubscribe the event handler provided by the user.
The touched signal is emitted when the touch input is received.
This can receive touch events before child.
If it returns false, the child can receive the touch event. If it returns true, the touch event is intercepted. So child cannot receive touch event.
Declaration
public event ReturnTypeEventHandler<object, Window.TouchEventArgs, bool> InterceptTouchEvent
Event Type
Type | Description |
---|---|
ReturnTypeEventHandler<object, Window.TouchEventArgs, bool> |
InterceptWheelEvent
An event for the wheel event signal which can be used to subscribe or unsubscribe the event handler provided by the user.
The wheel event signal is emitted when the wheel input is received.
This can receive wheel events before child.
If it returns false, the child can receive the wheel event. If it returns true, the wheel event is intercepted. So child cannot receive wheel event.
Declaration
public event ReturnTypeEventHandler<object, Window.WheelEventArgs, bool> InterceptWheelEvent
Event Type
Type | Description |
---|---|
ReturnTypeEventHandler<object, Window.WheelEventArgs, bool> |
KeyboardRepeatSettingsChanged
Keyboard Repeat Settings Changed
Declaration
public event EventHandler KeyboardRepeatSettingsChanged
Event Type
Type | Description |
---|---|
EventHandler |
KeyEvent
Emits the event when the key event is received.
Declaration
public event EventHandler<Window.KeyEventArgs> KeyEvent
Event Type
Type | Description |
---|---|
EventHandler<><KeyEventArgs> |
MouseInOutEvent
MouseInOutEvent event.
Declaration
public event EventHandler<Window.MouseInOutEventArgs> MouseInOutEvent
Event Type
Type | Description |
---|---|
EventHandler<><MouseInOutEventArgs> |
MouseRelativeEvent
Emits the event when relative mouse movement occurs in the window.
Declaration
public event EventHandler<Window.MouseRelativeEventArgs> MouseRelativeEvent
Event Type
Type | Description |
---|---|
EventHandler<><MouseRelativeEventArgs> |
MoveCompleted
Emits the event when window has been moved by the display server.
To make the window move by display server, RequestMoveToServer() should be called.
After the moving job is completed, this signal will be emitted.
Declaration
public event EventHandler<WindowMoveCompletedEventArgs> MoveCompleted
Event Type
Type | Description |
---|---|
EventHandler<><WindowMoveCompletedEventArgs> |
Moved
Emits the event when window is moved by user or the display server.
Declaration
public event EventHandler<WindowMovedEventArgs> Moved
Event Type
Type | Description |
---|---|
EventHandler<><WindowMovedEventArgs> |
OrientationChanged
Window Orientation Changed event This event is for per windows
Declaration
public event EventHandler<WindowOrientationChangedEventArgs> OrientationChanged
Event Type
Type | Description |
---|---|
EventHandler<><WindowOrientationChangedEventArgs> |
PointerConstraintsEvent
Emits the event when pointer is locked/unlocked
Declaration
public event EventHandler<Window.PointerConstraintsEventArgs> PointerConstraintsEvent
Event Type
Type | Description |
---|---|
EventHandler<><PointerConstraintsEventArgs> |
ResizeCompleted
Emits the event when window has been resized by the display server.
To make the window resize by display server, RequestResizeToServer() should be called.
After the resizing job is completed, this signal will be emitted.
Declaration
public event EventHandler<WindowResizeCompletedEventArgs> ResizeCompleted
Event Type
Type | Description |
---|---|
EventHandler<><WindowResizeCompletedEventArgs> |
Resized
Emits the event when window is resized by user or the display server.
Declaration
public event EventHandler<Window.ResizedEventArgs> Resized
Event Type
Type | Description |
---|---|
EventHandler<><ResizedEventArgs> |
TouchEvent
Emits the event when the screen is touched and when the touch ends.
If there are multiple touch points then it is emitted when the first touch occurs and
when the last finger is lifted too.
Even though incoming events are interrupted, the event occurs.
Declaration
public event EventHandler<Window.TouchEventArgs> TouchEvent
Event Type
Type | Description |
---|---|
EventHandler<><TouchEventArgs> |
TransitionEffect
EffectStart
Declaration
public event EventHandler<Window.TransitionEffectEventArgs> TransitionEffect
Event Type
Type | Description |
---|---|
EventHandler<><TransitionEffectEventArgs> |
VisibilityChanged
EffectStart
Declaration
public event EventHandler<Window.VisibilityChangedEventArgs> VisibilityChanged
Event Type
Type | Description |
---|---|
EventHandler<><VisibilityChangedEventArgs> |
WheelEvent
Emits the event when the wheel event is received.
Declaration
public event EventHandler<Window.WheelEventArgs> WheelEvent
Event Type
Type | Description |
---|---|
EventHandler<><WheelEventArgs> |
WindowFocusChanged
Do not use this, that will be deprecated. Use 'FocusChanged' event instead.
Declaration
public event EventHandler<Window.FocusChangedEventArgs> WindowFocusChanged
Event Type
Type | Description |
---|---|
EventHandler<><FocusChangedEventArgs> |