-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
using System;
using System.Runtime.InteropServices;
using Tizen.NUI.BaseComponents;
+ using System.ComponentModel;
/// <summary>
- /// The window class is used internally for drawing.<br>
- /// A Window has an orientation and indicator properties.<br>
+ /// The window class is used internally for drawing.<br />
+ /// The window has an orientation and indicator properties.<br />
/// </summary>
public class Window : BaseHandle
{
}
/// <summary>
- /// To make Window instance be disposed.
+ /// To make the window instance be disposed.
/// </summary>
protected override void Dispose(DisposeTypes type)
{
}
/// <summary>
- /// Sets whether window accepts focus or not.
+ /// Sets whether the window accepts a focus or not.
/// </summary>
- /// <param name="accept">If focus is accepted or not. Default is true.</param>
+ /// <param name="accept">If a focus is accepted or not. The default is true.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetAcceptFocus(bool accept)
{
NDalicPINVOKE.SetAcceptFocus(swigCPtr, accept);
}
/// <summary>
- /// Returns whether window accepts focus or not.
+ /// Returns whether the window accepts a focus or not.
/// </summary>
- /// <returns>True if the window accept focus, false otherwise</returns>
+ /// <returns>True if the window accepts a focus, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsFocusAcceptable()
{
- return NDalicPINVOKE.IsFocusAcceptable(swigCPtr);
+ bool ret = NDalicPINVOKE.IsFocusAcceptable(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+
+ return ret;
}
/// <summary>
/// Shows the window if it is hidden.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Show()
{
NDalicPINVOKE.Show(swigCPtr);
/// <summary>
/// Hides the window if it is showing.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Hide()
{
NDalicPINVOKE.Hide(swigCPtr);
/// <summary>
/// Retrieves whether the window is visible or not.
/// </summary>
- /// <returns>true, if the windoe is visible</returns>
+ /// <returns>True if the window is visible.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsVisible()
{
bool temp = NDalicPINVOKE.IsVisible(swigCPtr);
/// Gets the count of supported auxiliary hints of the window.
/// </summary>
/// <returns>The number of supported auxiliary hints.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetSupportedAuxiliaryHintCount() {
uint ret = NDalicPINVOKE.GetSupportedAuxiliaryHintCount(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// </summary>
/// <param name="index">The index of the supported auxiliary hint lists.</param>
/// <returns>The auxiliary hint string of the index.</returns>
+ /// <since_tizen> 3 </since_tizen>
public string GetSupportedAuxiliaryHint(uint index) {
string ret = NDalicPINVOKE.GetSupportedAuxiliaryHint(swigCPtr, index);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <param name="hint">The auxiliary hint string.</param>
/// <param name="value">The value string.</param>
/// <returns>The ID of created auxiliary hint, or 0 on failure.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint AddAuxiliaryHint(string hint, string value) {
uint ret = NDalicPINVOKE.AddAuxiliaryHint(swigCPtr, hint, value);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// </summary>
/// <param name="id">The ID of the auxiliary hint.</param>
/// <returns>True if no error occurred, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool RemoveAuxiliaryHint(uint id) {
bool ret = NDalicPINVOKE.RemoveAuxiliaryHint(swigCPtr, id);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <param name="id">The auxiliary hint ID.</param>
/// <param name="value">The value string to be set.</param>
/// <returns>True if no error occurred, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool SetAuxiliaryHintValue(uint id, string value) {
bool ret = NDalicPINVOKE.SetAuxiliaryHintValue(swigCPtr, id, value);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// </summary>
/// <param name="id">The auxiliary hint ID.</param>
/// <returns>The string value of the auxiliary hint ID, or an empty string if none exists.</returns>
+ /// <since_tizen> 3 </since_tizen>
public string GetAuxiliaryHintValue(uint id) {
string ret = NDalicPINVOKE.GetAuxiliaryHintValue(swigCPtr, id);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// </summary>
/// <param name="hint">The auxiliary hint string.</param>
/// <returns>The ID of auxiliary hint string, or 0 on failure.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetAuxiliaryHintId(string hint) {
uint ret = NDalicPINVOKE.GetAuxiliaryHintId(swigCPtr, hint);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// Sets a region to accept input events.
/// </summary>
/// <param name="inputRegion">The region to accept input events.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetInputRegion(Rectangle inputRegion) {
NDalicPINVOKE.SetInputRegion(swigCPtr, Rectangle.getCPtr(inputRegion));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Gets/Sets a window type.
+ /// Gets or sets a window type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public WindowType Type
{
get
/// </summary>
/// <param name="level">The notification window level.</param>
/// <returns>True if no error occurred, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool SetNotificationLevel(NotificationLevel level) {
bool ret = NDalicPINVOKE.SetNotificationLevel(swigCPtr, (int)level);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// Gets a priority level for the specified notification window.
/// </summary>
/// <returns>The notification window level.</returns>
+ /// <since_tizen> 3 </since_tizen>
public NotificationLevel GetNotificationLevel() {
NotificationLevel ret = (NotificationLevel)NDalicPINVOKE.GetNotificationLevel(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// Sets a transparent window's visual state to opaque.
/// </summary>
/// <param name="opaque">Whether the window's visual state is opaque.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetOpaqueState(bool opaque) {
NDalicPINVOKE.SetOpaqueState(swigCPtr, opaque);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// Returns whether a transparent window's visual state is opaque or not.
/// </summary>
/// <returns>True if the window's visual state is opaque, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsOpaqueState() {
bool ret = NDalicPINVOKE.IsOpaqueState(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// </summary>
/// <param name="screenMode">The screen mode.</param>
/// <returns>True if no error occurred, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool SetScreenMode(ScreenMode screenMode) {
bool ret = NDalicPINVOKE.SetScreenMode(swigCPtr, (int)screenMode);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Gets a screen mode of the window.
+ /// Gets the screen mode of the window.
/// </summary>
/// <returns>The screen mode.</returns>
+ /// <since_tizen> 3 </since_tizen>
public ScreenMode GetScreenMode() {
ScreenMode ret = (ScreenMode)NDalicPINVOKE.GetScreenMode(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// </summary>
/// <param name="brightness">The preferred brightness (0 to 100).</param>
/// <returns>True if no error occurred, false otherwise.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool SetBrightness(int brightness) {
bool ret = NDalicPINVOKE.SetBrightness(swigCPtr, brightness);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Gets preffered brightness of the window.
+ /// Gets the preferred brightness of the window.
/// </summary>
- /// <returns>The preffered brightness.</returns>
+ /// <returns>The preferred brightness.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int GetBrightness() {
int ret = NDalicPINVOKE.GetBrightness(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <summary>
+ /// The focus changed event argument.
+ /// </summary>
public class FocusChangedEventArgs : EventArgs
{
+ /// <summary>
+ /// FocusGained flag.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool FocusGained
{
get;
private delegate void WindowFocusChangedEventCallbackType(bool focusGained);
private event EventHandler<FocusChangedEventArgs> _windowFocusChangedEventHandler;
+ /// <summary>
+ /// FocusChanged event.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<FocusChangedEventArgs> FocusChanged
{
add
/// <summary>
/// Gets/Sets a window title.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public string Title
{
get
}
/// <summary>
- /// Sets the window name and class string.
+ /// Sets the window name and the class string.
/// </summary>
- /// <param name="name">The name of the window</param>
- /// <param name="klass">The class of the window</param>
+ /// <param name="name">The name of the window.</param>
+ /// <param name="klass">The class of the window.</param>
+ /// <since_tizen> 4 </since_tizen>
public void SetClass(string name, string klass)
{
NDalicPINVOKE.Window_SetClass(swigCPtr, name, klass);
}
/// <summary>
- /// Raises window to the top of Window stack.
+ /// Raises the window to the top of the window stack.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Raise()
{
NDalicPINVOKE.Window_Raise(swigCPtr);
}
/// <summary>
- /// Lowers window to the bottom of Window stack.
+ /// Lowers the window to the bottom of the window stack.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Lower()
{
NDalicPINVOKE.Window_Lower(swigCPtr);
}
/// <summary>
- /// Activates window to the top of Window stack even it is iconified.
+ /// Activates the window to the top of the window stack even it is iconified.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Activate()
{
NDalicPINVOKE.Window_Activate(swigCPtr);
}
/// <summary>
- /// Get default ( root ) layer.
+ /// Gets the default ( root ) layer.
/// </summary>
- /// <returns>The root layer</returns>
+ /// <returns>The root layer.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Layer GetDefaultLayer()
{
return this.GetRootLayer();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Add a child view to window.
+ /// </summary>
+ /// <param name="view">the child should be added to the window.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Add(View view)
{
NDalicPINVOKE.Stage_Add(stageCPtr, View.getCPtr(view));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Remove a child view from window.
+ /// </summary>
+ /// <param name="view">the child to be removed.</param>
+ /// <since_tizen> 3 </since_tizen>
public void Remove(View view)
{
NDalicPINVOKE.Stage_Remove(stageCPtr, View.getCPtr(view));
return ret;
}
+ /// <summary>
+ /// Retrieves the layer at a specified depth.
+ /// </summary>
+ /// <param name="depth">The layer's depth index.</param>
+ /// <returns>The layer found at the given depth.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Layer GetLayer(uint depth)
{
IntPtr cPtr = NDalicPINVOKE.Stage_GetLayer(stageCPtr, depth);
/// <summary>
/// Keep rendering for at least the given amount of time.
/// </summary>
- /// <param name="durationSeconds">Time to keep rendering, 0 means render at least one more frame</param>
+ /// <param name="durationSeconds">Time to keep rendering, 0 means render at least one more frame.</param>
+ /// <since_tizen> 3 </since_tizen>
public void KeepRendering(float durationSeconds)
{
NDalicPINVOKE.Stage_KeepRendering(stageCPtr, durationSeconds);
private static readonly Window instance = Application.Instance.GetWindow();
/// <summary>
- /// Stage instance property (read-only).<br>
- /// Gets the current Window.<br>
+ /// The stage instance property (read-only).<br />
+ /// Gets the current window.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static Window Instance
{
get
}
/// <summary>
- /// Grabs the key specified by a key for a window only when a window is the topmost window. <br>
- /// This function can be used for following example scenarios: <br>
- /// - Mobile - Using volume up/down as zoom up/down in camera apps. <br>
+ /// Grabs the key specified by a key for a window only when a window is the topmost window.<br />
+ /// This function can be used for following example scenarios: <br />
+ /// - Mobile - Using volume up or down as zoom up or down in camera apps.<br />
/// </summary>
- /// <param name="DaliKey">The key code to grab</param>
- /// <returns>true if the grab succeeds</returns>
+ /// <param name="DaliKey">The key code to grab.</param>
+ /// <returns>True if the grab succeeds.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool GrabKeyTopmost(int DaliKey)
{
bool ret = NDalicManualPINVOKE.GrabKeyTopmost(HandleRef.ToIntPtr(this.swigCPtr), DaliKey);
}
/// <summary>
- /// Ungrabs the key specified by a key for a window. <br>
- /// 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>
+ /// Ungrabs the key specified by a key for the window.<br />
+ /// 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 />
/// </summary>
- /// <param name="DaliKey">The key code to ungrab</param>
- /// <returns>true if the ungrab succeeds</returns>
+ /// <param name="DaliKey">The key code to ungrab.</param>
+ /// <returns>True if the ungrab succeeds.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool UngrabKeyTopmost(int DaliKey)
{
bool ret = NDalicManualPINVOKE.UngrabKeyTopmost(HandleRef.ToIntPtr(this.swigCPtr), DaliKey);
}
/// <summary>
- /// Grabs the key specified by a key for a window in a GrabMode. <br>
- /// Details: This function can be used for following example scenarios: <br>
- /// - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app. <br>
- /// - Mobile - When a user presses Home key, the homescreen appears regardless of current foreground app. <br>
- /// - Mobile - Using volume up/down as zoom up/down in camera apps. <br>
+ /// Grabs the key specified by a key for a window in a GrabMode. <br />
+ /// Details: This function can be used for following example scenarios: <br />
+ /// - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app. <br />
+ /// - Mobile - When a user presses the Home key, the homescreen appears regardless of the current foreground app. <br />
+ /// - Mobile - Using the volume up or down as zoom up or down in camera apps. <br />
/// </summary>
- /// <param name="DaliKey">The key code to grab</param>
- /// <param name="GrabMode">The grab mode for the key</param>
- /// <returns>true if the grab succeeds</returns>
+ /// <param name="DaliKey">The key code to grab.</param>
+ /// <param name="GrabMode">The grab mode for the key.</param>
+ /// <returns>True if the grab succeeds.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool GrabKey(int DaliKey, KeyGrabMode GrabMode)
{
bool ret = NDalicManualPINVOKE.GrabKey(HandleRef.ToIntPtr(this.swigCPtr), DaliKey, (int)GrabMode);
}
/// <summary>
- /// Ungrabs the key specified by a key for a window. <br>
- /// 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>
+ /// Ungrabs the key specified by a key for a window.<br />
+ /// 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 />
/// </summary>
- /// <param name="DaliKey">The key code to ungrab</param>
- /// <returns>true if the ungrab succeeds</returns>
+ /// <param name="DaliKey">The key code to ungrab.</param>
+ /// <returns>True if the ungrab succeeds.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool UngrabKey(int DaliKey)
{
bool ret = NDalicManualPINVOKE.UngrabKey(HandleRef.ToIntPtr(this.swigCPtr), DaliKey);
return ret;
}
- public System.IntPtr GetNativeWindowHandler()
+ internal System.IntPtr GetNativeWindowHandler()
{
System.IntPtr ret = NDalicManualPINVOKE.GetNativeWindowHandler(HandleRef.ToIntPtr(this.swigCPtr));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum WindowOrientation
{
+ /// <summary>
+ /// Portrait orientation. The height of the display area is greater than the width.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Portrait = 0,
+ /// <summary>
+ /// Landscape orientation. A wide view area is needed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
Landscape = 90,
+ /// <summary>
+ /// Portrait inverse orientation.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
PortraitInverse = 180,
+ /// <summary>
+ /// Landscape inverse orientation.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
LandscapeInverse = 270
}
/// <summary>
- /// Enumeration for key grab mode for platform-level APIs.
+ /// Enumeration for the key grab mode for platform-level APIs.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum KeyGrabMode
{
/// <summary>
- /// Grab a key only when on the top of the grabbing-window stack mode.
+ /// Grabs a key only when on the top of the grabbing-window stack mode.
/// </summary>
Topmost = 0,
/// <summary>
- /// Grab a key together with the other client window(s) mode.
+ /// Grabs a key together with the other client window(s) mode.
/// </summary>
Shared,
/// <summary>
- /// Grab 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.
+ /// 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.
/// </summary>
OverrideExclusive,
/// <summary>
- /// Grab a key exclusively regardless of the grabbing-window's position on the window stack mode.
+ /// Grabs a key exclusively regardless of the grabbing-window's position on the window stack mode.
/// </summary>
Exclusive
};
}
/// <summary>
- /// Touch event argument.
+ /// The touch event argument.
/// </summary>
public class TouchEventArgs : EventArgs
{
/// <summary>
/// Touch.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Touch Touch
{
get
private EventCallbackDelegateType1 _stageTouchCallbackDelegate;
/// <summary>
- /// This is emitted when the screen is touched and when the touch ends.<br>
+ /// This event is emitted when the screen is touched and when the touch ends.<br />
/// If there are multiple touch points, then this will be emitted when the first touch occurs and
- /// then when the last finger is lifted.<br>
- /// An interrupted event will also be emitted (if it occurs).<br>
+ /// then when the last finger is lifted.<br />
+ /// An interrupted event will also be emitted (if it occurs).<br />
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<TouchEventArgs> TouchEvent
{
add
/// <summary>
/// Wheel.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Wheel Wheel
{
get
private EventCallbackDelegateType1 _stageWheelCallbackDelegate;
/// <summary>
- /// Event emitted when wheel event is received.
+ /// This event is emitted when the wheel event is received.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<WheelEventArgs> WheelEvent
{
add
private Key _key;
/// <summary>
- /// Key
+ /// Key.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Key Key
{
get
private EventCallbackDelegateType1 _stageKeyCallbackDelegate;
/// <summary>
- /// Event emitted when key event is received.
+ /// This event is emitted when the key event is received.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<KeyEventArgs> KeyEvent
{
add
}
}
+ /// <summary>
+ /// This resized event arguments.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public class ResizedEventArgs : EventArgs
{
Size2D _windowSize;
+ /// <summary>
+ /// This window size.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Size2D WindowSize
{
get
private delegate void WindowResizedEventCallbackType(IntPtr windowSize);
private event EventHandler<ResizedEventArgs> _windowResizedEventHandler;
+ /// <summary>
+ /// This event is emitted when the window resized.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public event EventHandler<ResizedEventArgs> Resized
{
add
}
/// <summary>
- /// Window size property (read-only).
+ /// The window size property (read-only).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Size2D Size
{
get
}
/// <summary>
- /// Background color property.
+ /// The background color property.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Color BackgroundColor
{
set
}
/// <summary>
- /// Dpi property (read-only).<br>
- /// Retrieves the DPI of the display device to which the Window is connected.<br>
+ /// The DPI property (read-only).<br />
+ /// Retrieves the DPI of the display device to which the Window is connected.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Dpi
{
get
}
/// <summary>
- /// Layer count property (read-only).<br>
- /// Queries the number of on-Window layers.<br>
+ /// The layer count property (read-only).<br />
+ /// Queries the number of on-Window layers.<br />
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint LayerCount
{
get
/// <summary>
- /// Add layer to the Stage.
+ /// Adds a layer to the stage.
/// </summary>
- /// <param name="layer">Layer to add</param>
+ /// <param name="layer">Layer to add.</param>
+ /// <since_tizen> 3 </since_tizen>
public void AddLayer(Layer layer)
{
NDalicPINVOKE.Stage_Add(stageCPtr, Layer.getCPtr(layer));
}
/// <summary>
- /// Remove layer from the Stage.
+ /// Removes a layer from the stage.
/// </summary>
- /// <param name="layer">Layer to remove</param>
+ /// <param name="layer">Layer to remove.</param>
+ /// <since_tizen> 4 </since_tizen>
public void RemoveLayer(Layer layer)
{
NDalicPINVOKE.Stage_Remove(stageCPtr, Layer.getCPtr(layer));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- [Obsolete("Please do not use! this will be deprecated")]
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ [EditorBrowsable(EditorBrowsableState.Never)]
public class WindowFocusChangedEventArgs : EventArgs
{
+ /// <summary>
+ /// Please do not use! this will be deprecated
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool FocusGained
{
get;
private delegate void WindowFocusChangedEventCallbackType2(bool focusGained);
private event EventHandler<WindowFocusChangedEventArgs> _windowFocusChangedEventHandler2;
+ /// <summary>
+ /// Please do not use! this will be deprecated. Please use 'FocusChanged' event instead.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
[Obsolete("Please do not use! this will be deprecated. Please use 'FocusChanged' event instead")]
public event EventHandler<WindowFocusChangedEventArgs> WindowFocusChanged
{
}
/// <summary>
- /// Gets/Sets a size of the window.
+ /// Gets or sets a size of the window.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Size2D WindowSize
{
get
}
/// <summary>
- /// Gets/Sets a position of the window.
+ /// Gets or sets a position of the window.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public Position2D WindowPosition
{
get
}
}
+ /// <summary>
+ /// Feed a key-event into the window.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
public static void FeedKeyEvent(Key keyEvent)
{
NDalicManualPINVOKE.Window_FeedKeyEvent(Key.getCPtr(keyEvent));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Allows at least one more render, even when paused.
+ /// The window should be shown, not minimised.
+ /// </summary>
+ /// <since_tizen> 4 </since_tizen>
+ public void RenderOnce()
+ {
+ NDalicManualPINVOKE.Window_RenderOnce(swigCPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+ }
+
}
-}
+}
\ No newline at end of file
projects / platform / core / csapi / tizenfx.git / blobdiff