-/** 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
{
/// <summary>
- /// The wheel event structure is used to store a wheel rolling, it facilitates processing of the wheel rolling and passing to other libraries like Toolkit.<br>
- /// There is a key modifier which relates to keys like alt, shift and control functions are supplied to check if they have been pressed when the wheel is being rolled.<br>
- /// We support a mouse device and there may be another custom device that support the wheel event. The device type is specified as \e type.<br>
- /// The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the window.<br>
+ /// The wheel event structure is used to store a wheel rolling, it facilitates processing of the wheel rolling and passing to other libraries like Toolkit.<br />
+ /// There is a key modifier which relates to keys like Alt, Shift, and Ctrl functions are supplied to check if they have been pressed when the wheel is being rolled.<br />
+ /// We support a mouse device and there may be another custom device that support the wheel event. The device type is specified as \e type.<br />
+ /// The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the window.<br />
/// </summary>
public class Wheel : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// swigCMemOwn.
+ /// </summary>
protected bool swigCMemOwn;
internal Wheel(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
protected bool disposed = false;
+ /// <summary>
+ /// Destructor.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Wheel()
{
if(!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <param name="type">The type dispose, it could be from user, or called by DisposeQueue.</param>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
}
/// <summary>
- /// The type of the wheel event
+ /// The type of the wheel event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Wheel.WheelType Type
{
get
}
/// <summary>
- /// he direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)
+ /// The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Direction
{
get
}
/// <summary>
- /// Modifier keys pressed during the event (such as shift, alt and control)
+ /// Modifier keys pressed during the event (such as Shift, Alt, and Ctrl).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint Modifiers
{
get
}
/// <summary>
- /// The co-ordinates of the cursor relative to the top-left of the screen
+ /// The coordinates of the cursor relative to the top-left of the screen.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Vector2 Point
{
get
}
/// <summary>
- /// The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)
+ /// The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise).
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int Z
{
get
}
/// <summary>
- /// The time the wheel is being rolled
+ /// The time the wheel is being rolled.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public uint TimeStamp
{
get
}
/// <summary>
- /// Default constructor.
+ /// The default constructor.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Wheel() : this(NDalicPINVOKE.new_Wheel__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Constructor.
+ /// The constructor.
/// </summary>
- /// <param name="type">The type of the wheel event</param>
- /// <param name="direction">The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)</param>
- /// <param name="modifiers">Modifier keys pressed during the event (such as shift, alt and control)</param>
- /// <param name="point">The co-ordinates of the cursor relative to the top-left of the screen</param>
- /// <param name="z">The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)</param>
- /// <param name="timeStamp">The time the wheel is being rolled</param>
+ /// <param name="type">The type of the wheel event.</param>
+ /// <param name="direction">The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).</param>
+ /// <param name="modifiers">Modifier keys pressed during the event (such as Shift, Alt, and Ctrl).</param>
+ /// <param name="point">The coordinates of the cursor relative to the top-left of the screen.</param>
+ /// <param name="z">The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise).</param>
+ /// <param name="timeStamp">The time the wheel is being rolled.</param>
+ /// <since_tizen> 3 </since_tizen>
public Wheel(Wheel.WheelType type, int direction, uint modifiers, Vector2 point, int z, uint timeStamp) : this(NDalicPINVOKE.new_Wheel__SWIG_1((int)type, direction, modifiers, Vector2.getCPtr(point), z, timeStamp), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
/// <summary>
- /// Checks to see if Shift key modifier has been supplied.
+ /// Checks to see if the Shift key modifier has been supplied.
/// </summary>
- /// <returns>True if shift modifier</returns>
+ /// <returns>True if Shift modifier.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsShiftModifier()
{
bool ret = NDalicPINVOKE.Wheel_IsShiftModifier(swigCPtr);
/// <summary>
/// Checks to see if Ctrl (control) key modifier has been supplied.
/// </summary>
- /// <returns>True if ctrl modifier</returns>
+ /// <returns>True if Ctrl modifier.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsCtrlModifier()
{
bool ret = NDalicPINVOKE.Wheel_IsCtrlModifier(swigCPtr);
/// <summary>
/// Checks to see if Alt key modifier has been supplied.
/// </summary>
- /// <returns>True if alt modifier</returns>
+ /// <returns>True if Alt modifier.</returns>
+ /// <since_tizen> 3 </since_tizen>
public bool IsAltModifier()
{
bool ret = NDalicPINVOKE.Wheel_IsAltModifier(swigCPtr);
}
/// <summary>
- /// The type of the wheel event
+ /// The type of the wheel event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum WheelType
{
+ /// <summary>
+ /// Mouse wheel event.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
MouseWheel,
+
+ /// <summary>
+ /// Custom wheel event.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
CustomWheel
}
}
-}
+}
\ No newline at end of file
projects / platform / core / csapi / tizenfx.git / blobdiff