Class Window
Definition
- Namespace:
- Tizen.NUI
- Assembly:
- Tizen.NUI.dll
- API Level:
- 3
The window class is used internally for drawing.
The window has an orientation and indicator properties.
C#Copypublic class Window : BaseHandle, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable
- Inheritance
- Implements
Constructors
Window(String, IBorderInterface, Rectangle, Boolean)
Creates a new Window with a specific name.
This creates an extra window in addition to the default main window
Declaration
C#Copypublic 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. |
Boolean | isTranslucent | Whether Window is translucent. |
Feature: http://tizen.org/feature/opengles.surfaceless_context
Window(String, Rectangle, Boolean)
Creates a new Window with a specific name.
This creates an extra window in addition to the default main window
Declaration
C#Copypublic 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. |
Boolean | isTranslucent | Whether Window is translucent. |
API Level: 6
Feature: http://tizen.org/feature/opengles.surfaceless_context
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
C#Copypublic Window(string name, WindowData windowData)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name for extra window. |
WindowData | windowData | The window data |
Feature: http://tizen.org/feature/opengles.surfaceless_context
Window(Rectangle, Boolean)
Creates a new Window.
This creates an extra window in addition to the default main window
Declaration
C#Copypublic Window(Rectangle windowPosition = null, bool isTranslucent = false)
Parameters
Type | Name | Description |
---|---|---|
Rectangle | windowPosition | The position and size of the Window. |
Boolean | isTranslucent | Whether Window is translucent. |
API Level: 6
Feature: http://tizen.org/feature/opengles.surfaceless_context
Properties
Declaration
C#Copypublic Color BackgroundColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
API Level: 3
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
C#Copypublic bool DispatchHoverMotion { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
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
C#Copypublic bool DispatchTouchMotion { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Dpi
The DPI property (read-only).
Retrieves the DPI of the display device to which the Window is connected.
Declaration
C#Copypublic Vector2 Dpi { get; }
Property Value
Type | Description |
---|---|
Vector2 |
API Level: 3
Declaration
C#Copypublic static Window Instance { get; }
Property Value
Type | Description |
---|---|
Window |
API Level: 3
Declaration
C#Copypublic bool IsBorderEnabled { get; }
Property Value
Type | Description |
---|---|
Boolean |
LayerCount
The layer count property (read-only).
Queries the number of on-Window layers.
Declaration
C#Copypublic uint LayerCount { get; }
Property Value
Type | Description |
---|---|
UInt32 |
API Level: 3
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
C#Copypublic SafeHandle NativeHandle { get; }
Property Value
Type | Description |
---|---|
SafeHandle |
API Level: 9
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
C#Copypublic bool PartialUpdate { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Declaration
C#Copypublic RenderingBehaviorType RenderingBehavior { get; set; }
Property Value
Type | Description |
---|---|
RenderingBehaviorType |
API Level: 5
Declaration
C#Copypublic Size2D Size { get; }
Property Value
Type | Description |
---|---|
Size2D |
API Level: 3
Declaration
C#Copypublic string Title { get; set; }
Property Value
Type | Description |
---|---|
String |
API Level: 4
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
C#Copypublic WindowType Type { get; set; }
Property Value
Type | Description |
---|---|
WindowType |
API Level: 3
Declaration
C#Copypublic Position2D WindowPosition { get; set; }
Property Value
Type | Description |
---|---|
Position2D |
API Level: 4
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
C#Copypublic Rectangle WindowPositionSize { get; set; }
Property Value
Type | Description |
---|---|
Rectangle |
Declaration
C#Copypublic Rectangle WindowPositionSizeWithBorder { get; }
Property Value
Type | Description |
---|---|
Rectangle | The total window size including the border area in the default window. |
Declaration
C#Copypublic Size2D WindowSize { get; set; }
Property Value
Type | Description |
---|---|
Size2D |
API Level: 4
Declaration
C#Copypublic Size2D WindowSizeWithBorder { get; }
Property Value
Type | Description |
---|---|
Size2D | The total window size including the border area in the default window. |
Methods
Declaration
C#Copypublic void Activate()
API Level: 3
Declaration
C#Copypublic void Add(View view)
Parameters
Type | Name | Description |
---|---|---|
View | view | the child should be added to the window. |
API Level: 3
Declaration
C#Copypublic uint AddAuxiliaryHint(string hint, string value)
Parameters
Type | Name | Description |
---|---|---|
String | hint | The auxiliary hint string. |
String | value | The value string. |
Returns
Type | Description |
---|---|
UInt32 | The ID of created auxiliary hint, or 0 on failure. |
API Level: 3
AddAvailableOrientation(Window.WindowOrientation)
Adds an orientation to the list of available orientations.
Declaration
C#Copypublic void AddAvailableOrientation(Window.WindowOrientation orientation)
Parameters
Type | Name | Description |
---|---|---|
Window.WindowOrientation | orientation | The available orientation to add |
API Level: 6
AddFramePresentedCallback(Window.FrameCallbackType, Int32)
Adds a callback that is called when the frame is displayed on the display. A callback of the following type may be used:
Copyvoid MyFunction( int frameId )
This callback will be deleted once it is called.
Declaration
C#Copypublic void AddFramePresentedCallback(Window.FrameCallbackType callback, int frameId)
Parameters
Type | Name | Description |
---|---|---|
Window.FrameCallbackType | callback | The function to call |
Int32 | frameId | The Id to specify the frame. It will be passed when the callback is called. |
AddFrameRenderedCallback(Window.FrameCallbackType, Int32)
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:
Copyvoid MyFunction( int frameId )
This callback will be deleted once it is called.
Declaration
C#Copypublic void AddFrameRenderedCallback(Window.FrameCallbackType callback, int frameId)
Parameters
Type | Name | Description |
---|---|---|
Window.FrameCallbackType | callback | The function to call |
Int32 | frameId | The Id to specify the frame. It will be passed when the callback is called. |
Declaration
C#Copypublic void AddFrameUpdateCallback(FrameUpdateCallbackInterface frameUpdateCallback)
Parameters
Type | Name | Description |
---|---|---|
FrameUpdateCallbackInterface | frameUpdateCallback |
AddFrameUpdateCallback(FrameUpdateCallbackInterface, View)
Add FrameUpdateCallback with root view. FrameUpdateCallbackInterface can only detach Views under given view.
Declaration
C#Copypublic void AddFrameUpdateCallback(FrameUpdateCallbackInterface frameUpdateCallback, View rootView)
Parameters
Type | Name | Description |
---|---|---|
FrameUpdateCallbackInterface | frameUpdateCallback | |
View | rootView |
Declaration
C#Copypublic void AddLayer(Layer layer)
Parameters
Type | Name | Description |
---|---|---|
Layer | layer | Layer to add. |
API Level: 3
Declaration
C#Copypublic void CursorVisibleSet(bool visible)
Parameters
Type | Name | Description |
---|---|---|
Boolean | visible | The visibility of cursor. |
Declaration
C#Copypublic void Destroy()
Declaration
C#Copyprotected override void Dispose(DisposeTypes type)
Parameters
Type | Name | Description |
---|---|---|
DisposeTypes | type |
Overrides
EnableFloatingMode(Boolean)
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
C#Copypublic void EnableFloatingMode(bool enable)
Parameters
Type | Name | Description |
---|---|---|
Boolean | 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
C#Copypublic void ExcludeInputRegion(Rectangle inputRegion)
Parameters
Type | Name | Description |
---|---|---|
Rectangle | inputRegion | The excluded region to except input events. |
Declaration
C#Copypublic void FeedKey(Key keyEvent)
Parameters
Type | Name | Description |
---|---|---|
Key | keyEvent | The key event to feed. |
API Level: 5
Declaration
C#Copypublic static void FeedKeyEvent(Key keyEvent)
Parameters
Type | Name | Description |
---|---|---|
Key | keyEvent | The key event to feed. |
API Level: 4
Declaration
C#Copypublic Layer FindLayerByID(uint id)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | 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
Declaration
C#Copypublic static Window Get(View view)
Parameters
Type | Name | Description |
---|---|---|
View | view | The View added to the window |
Returns
Type | Description |
---|---|
Window | A Window. |
Declaration
C#Copypublic uint GetAuxiliaryHintId(string hint)
Parameters
Type | Name | Description |
---|---|---|
String | hint | The auxiliary hint string. |
Returns
Type | Description |
---|---|
UInt32 | The ID of auxiliary hint string, or 0 on failure. |
API Level: 3
Declaration
C#Copypublic string GetAuxiliaryHintValue(uint id)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | id | The auxiliary hint ID. |
Returns
Type | Description |
---|---|
String | The string value of the auxiliary hint ID, or an empty string if none exists. |
API Level: 3
Declaration
C#Copypublic int GetBrightness()
Returns
Type | Description |
---|---|
Int32 | The preferred brightness. |
API Level: 3
Declaration
C#Copypublic Window.WindowOrientation GetCurrentOrientation()
Returns
Type | Description |
---|---|
Window.WindowOrientation | The current window orientation if previously set, or none. |
API Level: 6
Declaration
C#Copypublic Layer GetDefaultLayer()
Returns
Type | Description |
---|---|
Layer | The root layer. |
API Level: 3
Declaration
C#Copypublic Window.BorderDirection GetDirection(float xPosition, float yPosition)
Parameters
Type | Name | Description |
---|---|---|
Single | xPosition | The X position. |
Single | yPosition | The Y position. |
Returns
Type | Description |
---|---|
Window.BorderDirection | The BorderDirection |
Declaration
C#Copypublic bool GetFullScreen()
Returns
Type | Description |
---|---|
Boolean | Returns true if the full screen sized window is. |
GetKeyboardHorizentalRepeatInfo(out Single, out Single)
Gets the keyboard repeat information of horizontal way.
Declaration
C#Copypublic bool GetKeyboardHorizentalRepeatInfo(out float rate, out float delay)
Parameters
Type | Name | Description |
---|---|---|
Single | rate | The key repeat rate value in seconds. |
Single | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
Boolean | True if setting the keyboard repeat succeeds. |
Declaration
C#Copypublic bool GetKeyboardRepeatInfo(out float rate, out float delay)
Parameters
Type | Name | Description |
---|---|---|
Single | rate | The key repeat rate value in seconds. |
Single | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
Boolean | True if setting the keyboard repeat succeeds. |
API Level: 5
GetKeyboardVerticalRepeatInfo(out Single, out Single)
Gets the keyboard repeat information of vertical way.
Declaration
C#Copypublic bool GetKeyboardVerticalRepeatInfo(out float rate, out float delay)
Parameters
Type | Name | Description |
---|---|---|
Single | rate | The key repeat rate value in seconds. |
Single | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
Boolean | True if setting the keyboard repeat succeeds. |
Declaration
C#Copypublic 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.
Declaration
C#Copypublic 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.
Declaration
C#Copypublic 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.
Declaration
C#Copypublic Layer GetLayer(uint depth)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | depth | The layer's depth index. |
Returns
Type | Description |
---|---|
Layer | The layer found at the given depth. |
API Level: 3
Declaration
C#Copypublic int GetNativeId()
Returns
Type | Description |
---|---|
Int32 | native window ID |
Declaration
C#Copypublic NotificationLevel GetNotificationLevel()
Returns
Type | Description |
---|---|
NotificationLevel | The notification window level. |
API Level: 3
Declaration
C#Copypublic Layer GetOverlayLayer()
Returns
Type | Description |
---|---|
Layer | The overlay layer. |
Declaration
C#Copypublic Window GetParent()
Returns
Type | Description |
---|---|
Window | The parent window of the window. |
API Level: 6
Feature: http://tizen.org/feature/opengles.surfaceless_context
Declaration
C#Copypublic Window.WindowOrientation GetPreferredOrientation()
Returns
Type | Description |
---|---|
Window.WindowOrientation | The preferred orientation if previously set, or none. |
API Level: 6
Declaration
C#Copypublic RenderTaskList GetRenderTaskList()
Returns
Type | Description |
---|---|
RenderTaskList |
Declaration
C#Copypublic ScreenOffMode GetScreenOffMode()
Returns
Type | Description |
---|---|
ScreenOffMode | The screen off mode. |
API Level: 4
GetSupportedAuxiliaryHint(UInt32)
Gets the supported auxiliary hint string of the window.
Declaration
C#Copypublic string GetSupportedAuxiliaryHint(uint index)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | index | The index of the supported auxiliary hint lists. |
Returns
Type | Description |
---|---|
String | The auxiliary hint string of the index. |
API Level: 3
GetSupportedAuxiliaryHintCount()
Gets the count of supported auxiliary hints of the window.
Declaration
C#Copypublic uint GetSupportedAuxiliaryHintCount()
Returns
Type | Description |
---|---|
UInt32 | The number of supported auxiliary hints. |
API Level: 3
GrabKey(Int32, Window.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
C#Copypublic bool GrabKey(int DaliKey, Window.KeyGrabMode GrabMode)
Parameters
Type | Name | Description |
---|---|---|
Int32 | DaliKey | The key code to grab. |
Window.KeyGrabMode | GrabMode | The grab mode for the key. |
Returns
Type | Description |
---|---|
Boolean | True if the grab succeeds. |
API Level: 3
GrabKeyTopmost(Int32)
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
C#Copypublic bool GrabKeyTopmost(int DaliKey)
Parameters
Type | Name | Description |
---|---|---|
Int32 | DaliKey | The key code to grab. |
Returns
Type | Description |
---|---|
Boolean | True if the grab succeeds. |
API Level: 3
Declaration
C#Copypublic void Hide()
API Level: 3
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
C#Copypublic void IncludeInputRegion(Rectangle inputRegion)
Parameters
Type | Name | Description |
---|---|---|
Rectangle | inputRegion | The included region to accept input events. |
Declaration
C#Copypublic bool IsFloatingModeEnabled()
Returns
Type | Description |
---|---|
Boolean | True if the window is enabled floating mode, false otherwise. |
Declaration
C#Copypublic bool IsFocusAcceptable()
Returns
Type | Description |
---|---|
Boolean | True if the window accepts a focus, false otherwise. |
API Level: 3
Declaration
C#Copypublic bool IsMaximized()
Returns
Type | Description |
---|---|
Boolean | True if the window is maximized, false otherwise. |
Declaration
C#Copypublic bool IsMinimized()
Returns
Type | Description |
---|---|
Boolean | True if the window is minimized, false otherwise. |
Declaration
C#Copypublic bool IsOpaqueState()
Returns
Type | Description |
---|---|
Boolean | True if the window's visual state is opaque, false otherwise. |
Remarks
The return value has no meaning on an opaque window.
API Level: 3
Declaration
C#Copypublic bool IsVisible()
Returns
Type | Description |
---|---|
Boolean | True if the window is visible. |
API Level: 3
Declaration
C#Copypublic bool IsWindowRotating()
Returns
Type | Description |
---|---|
Boolean | True if window is rotating, false otherwise. |
Declaration
C#Copypublic void KeepRendering(float durationSeconds)
Parameters
Type | Name | Description |
---|---|---|
Single | durationSeconds | Time to keep rendering, 0 means render at least one more frame. |
API Level: 3
KeyboardGrab(DeviceSubClassType)
Requests grab key events according to the requested device subtype
Declaration
C#Copypublic bool KeyboardGrab(DeviceSubClassType deviceSubclass)
Parameters
Type | Name | Description |
---|---|---|
DeviceSubClassType | deviceSubclass | The deviceSubclass type. |
Returns
Type | Description |
---|---|
Boolean | True if KeyboardGrab succeeds. |
Declaration
C#Copypublic bool KeyboardUnGrab()
Returns
Type | Description |
---|---|
Boolean | True if KeyboardUnGrab succeeds. |
LazyFeedHover(UInt32)
Feeds a hover event into the window.
This is feed after a default time of 48 ms. You can also set this time.
Declaration
C#Copypublic void LazyFeedHover(uint time = null)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | 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(Int32, Int32)
Sets the locked pointer cursor position hintset
Declaration
C#Copypublic void LockedPointerCursorPositionHintSet(int x, int y)
Parameters
Type | Name | Description |
---|---|---|
Int32 | x | The x position. |
Int32 | y | The y position. |
Declaration
C#Copypublic void LockedPointerRegionSet(int x, int y, int width, int height)
Parameters
Type | Name | Description |
---|---|---|
Int32 | x | The x position. |
Int32 | y | The y position. |
Int32 | width | The width. |
Int32 | height | The height. |
Declaration
C#Copypublic void Lower()
API Level: 3
Maximize(Boolean)
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
C#Copypublic void Maximize(bool max)
Parameters
Type | Name | Description |
---|---|---|
Boolean | max | If window is maximized or unmaximized. |
Minimize(Boolean)
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
C#Copypublic void Minimize(bool min)
Parameters
Type | Name | Description |
---|---|---|
Boolean | min | If window is minimized or unminimized. |
Declaration
C#Copypublic void ObjectDump()
Declaration
C#Copypublic bool PointerConstraintsLock()
Returns
Type | Description |
---|---|
Boolean | True if PointerConstraintsLock succeeds. |
Declaration
C#Copypublic bool PointerConstraintsUnlock()
Returns
Type | Description |
---|---|
Boolean | True if PointerConstraintsUnlock succeeds. |
PointerWarp(Int32, Int32)
Sets the pointer warp. The pointer moves to the set coordinates.
Declaration
C#Copypublic bool PointerWarp(int x, int y)
Parameters
Type | Name | Description |
---|---|---|
Int32 | x | The x position. |
Int32 | y | The y position. |
Returns
Type | Description |
---|---|
Boolean | True if PointerWarp succeeds. |
Declaration
C#Copypublic void Raise()
API Level: 3
Declaration
C#Copyprotected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type | Name | Description |
---|---|---|
Tizen.System.Runtime.InteropServices.HandleRef | swigCPtr |
Overrides
Declaration
C#Copypublic void Remove(View view)
Parameters
Type | Name | Description |
---|---|---|
View | view | the child to be removed. |
API Level: 3
Declaration
C#Copypublic bool RemoveAuxiliaryHint(uint id)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | id | The ID of the auxiliary hint. |
Returns
Type | Description |
---|---|
Boolean | True if no error occurred, false otherwise. |
API Level: 3
RemoveAvailableOrientation(Window.WindowOrientation)
Removes an orientation from the list of available orientations.
Declaration
C#Copypublic void RemoveAvailableOrientation(Window.WindowOrientation orientation)
Parameters
Type | Name | Description |
---|---|---|
Window.WindowOrientation | orientation | The available orientation to remove. |
API Level: 6
Declaration
C#Copypublic void RemoveFrameUpdateCallback(FrameUpdateCallbackInterface frameUpdateCallback)
Parameters
Type | Name | Description |
---|---|---|
FrameUpdateCallbackInterface | frameUpdateCallback |
Declaration
C#Copypublic void RemoveLayer(Layer layer)
Parameters
Type | Name | Description |
---|---|---|
Layer | layer | Layer to remove. |
API Level: 3
RenderOnce()
Allows at least one more render, even when paused. The window should be shown, not minimised.
Declaration
C#Copypublic void RenderOnce()
API Level: 4
RequestMoveToServer()
Requests to display server for the window is moved by display server. It can be work with setting window floating mode.
Declaration
C#Copypublic void RequestMoveToServer()
RequestResizeToServer(Window.ResizeDirection)
Requests to display server for the window is resized by display server. It can be work with setting window floating mode.
Declaration
C#Copypublic 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
C#Copypublic void SendRotationCompletedAcknowledgement()
Declaration
C#Copypublic void SetAcceptFocus(bool accept)
Parameters
Type | Name | Description |
---|---|---|
Boolean | accept | If a focus is accepted or not. The default is true. |
API Level: 3
Declaration
C#Copypublic bool SetAuxiliaryHintValue(uint id, string value)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | id | The auxiliary hint ID. |
String | value | The value string to be set. |
Returns
Type | Description |
---|---|
Boolean | True if no error occurred, false otherwise. |
API Level: 3
SetAvailableOrientations(List<Window.WindowOrientation>)
Sets available orientations of the window. This API is for setting several orientations one time.
Declaration
C#Copypublic void SetAvailableOrientations(List<Window.WindowOrientation> orientations)
Parameters
Type | Name | Description |
---|---|---|
List<Window.WindowOrientation> | orientations | The list of orientations. |
API Level: 3
Declaration
C#Copypublic bool SetBrightness(int brightness)
Parameters
Type | Name | Description |
---|---|---|
Int32 | brightness | The preferred brightness (0 to 100). |
Returns
Type | Description |
---|---|
Boolean | True if no error occurred, false otherwise. |
API Level: 3
Declaration
C#Copypublic void SetClass(string name, string klass)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name of the window. |
String | klass | The class of the window. |
API Level: 4
SetFullScreen(Boolean)
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
C#Copypublic void SetFullScreen(bool fullscreen)
Parameters
Type | Name | Description |
---|---|---|
Boolean | fullscreen | If fullscreen is true, set fullscreen or unset. |
Declaration
C#Copypublic void SetInputRegion(Rectangle inputRegion)
Parameters
Type | Name | Description |
---|---|---|
Rectangle | inputRegion | The region to accept input events. |
API Level: 3
SetKeyboardHorizentalRepeatInfo(Single, Single)
Sets the keyboard repeat information of horizontal way.
Declaration
C#Copypublic bool SetKeyboardHorizentalRepeatInfo(float rate, float delay)
Parameters
Type | Name | Description |
---|---|---|
Single | rate | The key repeat rate value in seconds. |
Single | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
Boolean | True if setting the keyboard repeat succeeds. |
Declaration
C#Copypublic bool SetKeyboardRepeatInfo(float rate, float delay)
Parameters
Type | Name | Description |
---|---|---|
Single | rate | The key repeat rate value in seconds. |
Single | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
Boolean | True if setting the keyboard repeat succeeds. |
API Level: 5
SetKeyboardVerticalRepeatInfo(Single, Single)
Sets the keyboard repeat information of vertical way.
Declaration
C#Copypublic bool SetKeyboardVerticalRepeatInfo(float rate, float delay)
Parameters
Type | Name | Description |
---|---|---|
Single | rate | The key repeat rate value in seconds. |
Single | delay | The key repeat delay value in seconds. |
Returns
Type | Description |
---|---|
Boolean | True if setting the keyboard repeat succeeds. |
SetLayout(UInt32, UInt32, UInt32, UInt32, UInt32, UInt32)
Sets the layout of the window.
Declaration
C#Copypublic void SetLayout(uint numCols, uint numRows, uint column, uint row, uint colSpan, uint rowSpan)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | numCols | The number of columns in the layout. |
UInt32 | numRows | The number of rows in the layout. |
UInt32 | column | The column number of the window within the layout. |
UInt32 | row | The row number of the window within the layout. |
UInt32 | colSpan | The number of columns the window should span within the layout. |
UInt32 | rowSpan | The number of rows the window should span within the layout. |
Declaration
C#Copypublic 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
C#Copypublic 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
C#Copypublic void SetMimimumSize(Size2D size)
Parameters
Type | Name | Description |
---|---|---|
Size2D | size | the minimum size. |
SetNeedsRotationCompletedAcknowledgement(Boolean)
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
C#Copypublic void SetNeedsRotationCompletedAcknowledgement(bool needAcknowledgement)
Parameters
Type | Name | Description |
---|---|---|
Boolean | needAcknowledgement | the flag is true if window rotation acknowledge is sent. |
SetNotificationLevel(NotificationLevel)
Sets a priority level for the specified notification window.
Declaration
C#Copypublic bool SetNotificationLevel(NotificationLevel level)
Parameters
Type | Name | Description |
---|---|---|
NotificationLevel | level | The notification window level. |
Returns
Type | Description |
---|---|
Boolean | True if no error occurred, false otherwise. |
API Level: 3
SetOpaqueState(Boolean)
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
C#Copypublic void SetOpaqueState(bool opaque)
Parameters
Type | Name | Description |
---|---|---|
Boolean | 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.
API Level: 3
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
C#Copypublic void SetParent(Window parent)
Parameters
Type | Name | Description |
---|---|---|
Window | parent | The parent window. |
API Level: 6
Feature: http://tizen.org/feature/opengles.surfaceless_context
SetParent(Window, Boolean)
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
C#Copypublic void SetParent(Window parent, bool belowParent)
Parameters
Type | Name | Description |
---|---|---|
Window | parent | The parent window. |
Boolean | belowParent | The flag is whether the child is located above or below of the parent. |
Feature: http://tizen.org/feature/opengles.surfaceless_context
Declaration
C#Copypublic void SetPreferredOrientation(Window.WindowOrientation orientation)
Parameters
Type | Name | Description |
---|---|---|
Window.WindowOrientation | orientation | The preferred orientation. |
API Level: 6
Declaration
C#Copypublic bool SetScreenOffMode(ScreenOffMode screenOffMode)
Parameters
Type | Name | Description |
---|---|---|
ScreenOffMode | screenOffMode | The screen mode. |
Returns
Type | Description |
---|---|
Boolean | True if no error occurred, false otherwise. |
API Level: 4
Declaration
C#Copypublic void SetTransparency(bool transparent)
Parameters
Type | Name | Description |
---|---|---|
Boolean | transparent | Whether the window is transparent or not. |
API Level: 5
Declaration
C#Copypublic void Show()
API Level: 3
UngrabKey(Int32)
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
C#Copypublic bool UngrabKey(int DaliKey)
Parameters
Type | Name | Description |
---|---|---|
Int32 | DaliKey | The key code to ungrab. |
Returns
Type | Description |
---|---|
Boolean | True if the ungrab succeeds. |
API Level: 3
UngrabKeyTopmost(Int32)
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
C#Copypublic bool UngrabKeyTopmost(int DaliKey)
Parameters
Type | Name | Description |
---|---|---|
Int32 | DaliKey | The key code to ungrab. |
Returns
Type | Description |
---|---|
Boolean | True if the ungrab succeeds. |
API Level: 3
Unparent()
Unsets parent window of the window. After unsetting, the window is disconnected his parent window.
Declaration
C#Copypublic void Unparent()
API Level: 6
Feature: http://tizen.org/feature/opengles.surfaceless_context
Declaration
C#Copypublic void VisibiltyChangedSignalEmit(bool visibility)
Parameters
Type | Name | Description |
---|---|---|
Boolean | visibility |
Events
AccessibilityHighlight
Emits the event when the window needs to grab or clear highlight.
Declaration
C#Copypublic event EventHandler<Window.AccessibilityHighlightEventArgs> AccessibilityHighlight
Event Type
Type | Description |
---|---|
EventHandler<Window.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
C#Copypublic event EventHandler<AuxiliaryMessageEventArgs> AuxiliaryMessage
Event Type
Type | Description |
---|---|
EventHandler<AuxiliaryMessageEventArgs> |
Declaration
C#Copypublic event EventHandler<Window.FocusChangedEventArgs> FocusChanged
Event Type
Type | Description |
---|---|
EventHandler<Window.FocusChangedEventArgs> |
API Level: 3
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
C#Copypublic event EventHandler<Window.HoverEventArgs> HoverEvent
Event Type
Type | Description |
---|---|
EventHandler<Window.HoverEventArgs> |
InsetsChanged
Emits the event when the window insets changes by status bar, virtual keyboard, or clipboard appears and disappears.
Declaration
C#Copypublic event EventHandler<Window.InsetsChangedEventArgs> InsetsChanged
Event Type
Type | Description |
---|---|
EventHandler<Window.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
C#Copypublic event ReturnTypeEventHandler<object, Window.KeyEventArgs, bool> InterceptKeyEvent
Event Type
Type | Description |
---|---|
ReturnTypeEventHandler<Object, Window.KeyEventArgs, Boolean> |
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
C#Copypublic event ReturnTypeEventHandler<object, Window.TouchEventArgs, bool> InterceptTouchEvent
Event Type
Type | Description |
---|---|
ReturnTypeEventHandler<Object, Window.TouchEventArgs, Boolean> |
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
C#Copypublic event ReturnTypeEventHandler<object, Window.WheelEventArgs, bool> InterceptWheelEvent
Event Type
Type | Description |
---|---|
ReturnTypeEventHandler<Object, Window.WheelEventArgs, Boolean> |
Declaration
C#Copypublic event EventHandler KeyboardRepeatSettingsChanged
Event Type
Type | Description |
---|---|
EventHandler |
Declaration
C#Copypublic event EventHandler<Window.KeyEventArgs> KeyEvent
Event Type
Type | Description |
---|---|
EventHandler<Window.KeyEventArgs> |
API Level: 3
Declaration
C#Copypublic event EventHandler<Window.MouseInOutEventArgs> MouseInOutEvent
Event Type
Type | Description |
---|---|
EventHandler<Window.MouseInOutEventArgs> |
Declaration
C#Copypublic event EventHandler<Window.MouseRelativeEventArgs> MouseRelativeEvent
Event Type
Type | Description |
---|---|
EventHandler<Window.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
C#Copypublic event EventHandler<WindowMoveCompletedEventArgs> MoveCompleted
Event Type
Type | Description |
---|---|
EventHandler<WindowMoveCompletedEventArgs> |
Declaration
C#Copypublic event EventHandler<WindowMovedEventArgs> Moved
Event Type
Type | Description |
---|---|
EventHandler<WindowMovedEventArgs> |
Declaration
C#Copypublic event EventHandler<WindowOrientationChangedEventArgs> OrientationChanged
Event Type
Type | Description |
---|---|
EventHandler<WindowOrientationChangedEventArgs> |
Declaration
C#Copypublic event EventHandler<Window.PointerConstraintsEventArgs> PointerConstraintsEvent
Event Type
Type | Description |
---|---|
EventHandler<Window.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
C#Copypublic event EventHandler<WindowResizeCompletedEventArgs> ResizeCompleted
Event Type
Type | Description |
---|---|
EventHandler<WindowResizeCompletedEventArgs> |
Declaration
C#Copypublic event EventHandler<Window.ResizedEventArgs> Resized
Event Type
Type | Description |
---|---|
EventHandler<Window.ResizedEventArgs> |
API Level: 3
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
C#Copypublic event EventHandler<Window.TouchEventArgs> TouchEvent
Event Type
Type | Description |
---|---|
EventHandler<Window.TouchEventArgs> |
API Level: 3
Declaration
C#Copypublic event EventHandler<Window.TransitionEffectEventArgs> TransitionEffect
Event Type
Type | Description |
---|---|
EventHandler<Window.TransitionEffectEventArgs> |
Declaration
C#Copypublic event EventHandler<Window.VisibilityChangedEventArgs> VisibilityChanged
Event Type
Type | Description |
---|---|
EventHandler<Window.VisibilityChangedEventArgs> |
Declaration
C#Copypublic event EventHandler<Window.WheelEventArgs> WheelEvent
Event Type
Type | Description |
---|---|
EventHandler<Window.WheelEventArgs> |
API Level: 3
WindowFocusChanged
Do not use this, that will be deprecated. Use 'FocusChanged' event instead.
Declaration
C#Copypublic event EventHandler<Window.FocusChangedEventArgs> WindowFocusChanged
Event Type
Type | Description |
---|---|
EventHandler<Window.FocusChangedEventArgs> |