Class Wheel
Definition
- Assembly:
- Tizen.NUI.dll
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.
public class Wheel : IDisposable
- Inheritance
-
objectWheel
- Implements
-
System.IDisposable
Constructors
View SourceWheel()
The default constructor.
Declaration
public Wheel()
Wheel(WheelType, int, uint, Vector2, int, uint)
The constructor.
Declaration
public 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. |
int | direction | The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel). |
uint | 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. |
int | z | The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise). |
uint | timeStamp | The time the wheel is being rolled. |
Fields
View Sourcedisposed
A Flat to check if it is already disposed.
Declaration
protected bool disposed
Field Value
Type | Description |
---|---|
bool |
swigCMemOwn
swigCMemOwn.
Declaration
protected bool swigCMemOwn
Field Value
Type | Description |
---|---|
bool |
Properties
View SourceDirection
The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).
Declaration
public int Direction { get; }
Property Value
Type | Description |
---|---|
int |
Modifiers
Modifier keys pressed during the event (such as Shift, Alt, and Ctrl).
Declaration
public uint Modifiers { get; }
Property Value
Type | Description |
---|---|
uint |
Point
The coordinates of the cursor relative to the top-left of the screen.
Declaration
public Vector2 Point { get; }
Property Value
Type | Description |
---|---|
Vector2 |
TimeStamp
The time the wheel is being rolled.
Declaration
public uint TimeStamp { get; }
Property Value
Type | Description |
---|---|
uint |
Type
The type of the wheel event.
Declaration
public Wheel.WheelType Type { get; }
Property Value
Type | Description |
---|---|
Wheel.WheelType |
Z
The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise).
Declaration
public int Z { get; }
Property Value
Type | Description |
---|---|
int |
Methods
View SourceDispose()
Dispose.
Declaration
public void Dispose()
Dispose(DisposeTypes)
Dispose.
Declaration
protected virtual void Dispose(DisposeTypes type)
Parameters
Type | Name | Description |
---|---|---|
DisposeTypes | type | The type dispose, it could be from user, or called by DisposeQueue. |
~Wheel()
Destructor.
Declaration
protected ~Wheel()
IsAltModifier()
Checks to see if Alt key modifier has been supplied.
Declaration
public bool IsAltModifier()
Returns
Type | Description |
---|---|
bool | True if Alt modifier. |
IsCtrlModifier()
Checks to see if Ctrl (control) key modifier has been supplied.
Declaration
public bool IsCtrlModifier()
Returns
Type | Description |
---|---|
bool | True if Ctrl modifier. |
IsShiftModifier()
Checks to see if the Shift key modifier has been supplied.
Declaration
public bool IsShiftModifier()
Returns
Type | Description |
---|---|
bool | True if Shift modifier. |