using Tizen.NUI.BaseComponents;
/// <summary>
/// Hover events are a collection of points at a specific moment in time.<br>
- /// When a multi event occurs, each point represents the points that are currently being
+ /// When a multi-event occurs, each point represents the points that are currently being
/// hovered or the points where a hover has stopped.<br>
/// </summary>
public class Hover : global::System.IDisposable
/// <summary>
/// The time (in ms) that the hover event occurred.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint Time
{
get
}
/// <summary>
- /// Returns the ID of the device used for the Point specified.<br>
+ /// Returns the ID of the device used for the point specified.<br>
/// Each point has a unique device ID which specifies the device used for that
/// point. This is returned by this method.<br>
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The Device ID of this poin</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The device ID of this point.</returns>
+ /// <since_tizen> 3 </since_tizen>
public int GetDeviceId(uint point)
{
if (point < points.Count)
}
/// <summary>
- /// Retrieves the State of the point specified.
+ /// Retrieves the state of the point specified.
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The state of the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The state of the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public PointStateType GetState(uint point)
{
if (point < points.Count)
/// <summary>
/// Retrieves the view that was underneath the point specified.
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The view that was underneath the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The view that was underneath the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public View GetHitView(uint point)
{
if (point < points.Count)
}
/// <summary>
- /// Retrieves the co-ordinates relative to the top-left of the hit-view at the point specified.
+ /// Retrieves the coordinates relative to the top-left of the hit-view at the point specified.
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The co-ordinates relative to the top-left of the hit-view of the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The coordinates relative to the top-left of the hit-view of the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetLocalPosition(uint point)
{
if (point < points.Count)
}
/// <summary>
- /// Retrieves the co-ordinates relative to the top-left of the screen of the point specified.
+ /// Retrieves the coordinates relative to the top-left of the screen of the point specified.
/// </summary>
- /// <param name="point">The point required</param>
- /// <returns>The co-ordinates relative to the top-left of the screen of the point specified</returns>
+ /// <param name="point">The point required.</param>
+ /// <returns>The coordinates relative to the top-left of the screen of the point specified.</returns>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 GetScreenPosition(uint point)
{
if (point < points.Count)
}
/// <summary>
- /// Default constructor.
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Hover() : this(NDalicPINVOKE.new_Hover__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="time">The time the event occurred</param>
+ /// <param name="time">The time the event occurred.</param>
internal Hover(uint time) : this(NDalicPINVOKE.new_Hover__SWIG_1(time), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
/// <summary>
/// Returns the total number of points.
/// </summary>
- /// <returns>Total number of Points</returns>
+ /// <returns>Total number of points.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetPointCount()
{
uint ret = NDalicPINVOKE.Hover_GetPointCount(swigCPtr);
}
-}
+}
\ No newline at end of file