/*
* Copyright(c) 2020 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.
*
*/
using System.ComponentModel;
using Tizen.NUI.BaseComponents;
namespace Tizen.NUI
{
///
/// 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.
/// 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.
/// 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.
/// The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the window.
///
/// 3
public class Wheel : BaseHandle
{
///
/// The default constructor.
///
/// 3
public Wheel() : this(Interop.Wheel.New(0, 0, 0u, Vector2.getCPtr(new Vector2(0.0f, 0.0f)), 0, 0u), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
///
/// The constructor.
///
/// The type of the wheel event.
/// The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).
/// Modifier keys pressed during the event (such as Shift, Alt, and Ctrl).
/// The coordinates of the cursor relative to the top-left of the screen.
/// The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise).
/// The time the wheel is being rolled.
/// 3
public Wheel(Wheel.WheelType type, int direction, uint modifiers, Vector2 point, int z, uint timeStamp) : this(Interop.Wheel.New((int)type, direction, modifiers, Vector2.getCPtr(point), z, timeStamp), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
internal Wheel(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
{
}
///
/// The type of the wheel event.
///
/// 3
public enum WheelType
{
///
/// Mouse wheel event.
///
/// 3
MouseWheel,
///
/// Custom wheel event.
///
/// 3
CustomWheel
}
///
/// The type of the wheel event.
///
/// 3
public Wheel.WheelType Type
{
get
{
return type;
}
}
///
/// The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).
///
/// 3
public int Direction
{
get
{
return direction;
}
}
///
/// Modifier keys pressed during the event (such as Shift, Alt, and Ctrl).
///
/// 3
public uint Modifiers
{
get
{
return modifiers;
}
}
///
/// The coordinates of the cursor relative to the top-left of the screen.
///
/// 3
public Vector2 Point
{
get
{
return point;
}
}
///
/// The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise).
///
/// 3
public int Z
{
get
{
return z;
}
}
///
/// The time the wheel is being rolled.
///
/// 3
public uint TimeStamp
{
get
{
return timeStamp;
}
}
private Wheel.WheelType type
{
get
{
Wheel.WheelType ret = (Wheel.WheelType)Interop.Wheel.TypeGet(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private int direction
{
get
{
int ret = Interop.Wheel.DirectionGet(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private uint modifiers
{
get
{
uint ret = Interop.Wheel.ModifiersGet(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private Vector2 point
{
get
{
global::System.IntPtr cPtr = Interop.Wheel.PointGet(SwigCPtr);
Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private int z
{
get
{
int ret = Interop.Wheel.DeltaGet(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
private uint timeStamp
{
get
{
uint ret = Interop.Wheel.TimeStampGet(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
}
///
/// Checks to see if the Shift key modifier has been supplied.
///
/// True if Shift modifier.
/// 3
public bool IsShiftModifier()
{
bool ret = Interop.Wheel.IsShiftModifier(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
///
/// Checks to see if Ctrl (control) key modifier has been supplied.
///
/// True if Ctrl modifier.
/// 3
public bool IsCtrlModifier()
{
bool ret = Interop.Wheel.IsCtrlModifier(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
///
/// Checks to see if Alt key modifier has been supplied.
///
/// True if Alt modifier.
/// 3
public bool IsAltModifier()
{
bool ret = Interop.Wheel.IsAltModifier(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
internal static Wheel GetWheelFromPtr(global::System.IntPtr cPtr)
{
Wheel ret = new Wheel(cPtr, false);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
/// This will not be public opened.
[EditorBrowsable(EditorBrowsableState.Never)]
protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
{
Interop.Wheel.DeleteWheel(swigCPtr);
}
}
}