Class Wheel
Definition
- Namespace:
- Tizen.NUI
- Assembly:
- Tizen.NUI.dll
- API Level:
- 3
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.
C#Copypublic class Wheel : BaseHandle, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable
- Inheritance
- Implements
Constructors
Declaration
C#Copypublic Wheel()
API Level: 3
Declaration
C#Copypublic Wheel(Wheel.WheelType type, int direction, uint modifiers, Vector2 point, int z, uint timeStamp)
Parameters
Type | Name | Description |
---|---|---|
Wheel.WheelType | type | The type of the wheel event. |
Int32 | direction | The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel). |
UInt32 | modifiers | Modifier keys pressed during the event (such as Shift, Alt, and Ctrl). |
Vector2 | point | The coordinates of the cursor relative to the top-left of the screen. |
Int32 | z | The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise). |
UInt32 | timeStamp | The time the wheel is being rolled. |
API Level: 3
Properties
Direction
The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).
Declaration
C#Copypublic int Direction { get; }
Property Value
Type | Description |
---|---|
Int32 |
API Level: 3
Declaration
C#Copypublic uint Modifiers { get; }
Property Value
Type | Description |
---|---|
UInt32 |
API Level: 3
Declaration
C#Copypublic Vector2 Point { get; }
Property Value
Type | Description |
---|---|
Vector2 |
API Level: 3
Declaration
C#Copypublic uint TimeStamp { get; }
Property Value
Type | Description |
---|---|
UInt32 |
API Level: 3
Declaration
C#Copypublic Wheel.WheelType Type { get; }
Property Value
Type | Description |
---|---|
Wheel.WheelType |
API Level: 3
Z
The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise).
Declaration
C#Copypublic int Z { get; }
Property Value
Type | Description |
---|---|
Int32 |
API Level: 3
Methods
Declaration
C#Copypublic bool IsAltModifier()
Returns
Type | Description |
---|---|
Boolean | True if Alt modifier. |
API Level: 3
Declaration
C#Copypublic bool IsCtrlModifier()
Returns
Type | Description |
---|---|
Boolean | True if Ctrl modifier. |
API Level: 3
Declaration
C#Copypublic bool IsShiftModifier()
Returns
Type | Description |
---|---|
Boolean | True if Shift modifier. |
API Level: 3
Declaration
C#Copyprotected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
Type | Name | Description |
---|---|---|
Tizen.System.Runtime.InteropServices.HandleRef | swigCPtr |