|
Tizen Native API
4.0
|
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. More...
Public Types | |
| enum | Type |
| Enumeration for specifying the type of the wheel event. More... | |
Public Member Functions | |
| WheelEvent () | |
| Default constructor. | |
| WheelEvent (Type type, int direction, unsigned int modifiers, Vector2 point, int z, unsigned int timeStamp) | |
| Constructor. | |
| ~WheelEvent () | |
| Destructor. | |
| bool | IsShiftModifier () const |
| Checks to see if Shift key modifier has been supplied. | |
| bool | IsCtrlModifier () const |
| Checks to see if Ctrl (control) key modifier has been supplied. | |
| bool | IsAltModifier () const |
| Checks to see if Alt key modifier has been supplied. | |
Public Attributes | |
| Type | type |
| Type of the event. | |
| int | direction |
| The direction in which the wheel is being rolled. | |
| unsigned int | modifiers |
| Modifier keys pressed during the event (such as shift, alt and control). | |
| Vector2 | point |
| The co-ordinates of the cursor relative to the top-left of the screen when the wheel is being rolled. | |
| int | z |
| The offset of the wheel rolling, where positive value means rolling down or clockwise and negative value means rolling up or counter-clockwise. | |
| unsigned int | timeStamp |
| The time when the wheel is being rolled. | |
Detailed Description
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 control 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 type. The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the stage.
- Since:
- 3.0, DALi version 1.0.0
Member Enumeration Documentation
Constructor & Destructor Documentation
Default constructor.
- Since:
- 3.0, DALi version 1.0.0
| Dali::WheelEvent::WheelEvent | ( | Type | type, |
| int | direction, | ||
| unsigned int | modifiers, | ||
| Vector2 | point, | ||
| int | z, | ||
| unsigned int | timeStamp | ||
| ) |
Constructor.
- Since:
- 3.0, DALi version 1.0.0
- Parameters:
-
[in] type The type of the wheel event [in] direction The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel) [in] modifiers Modifier keys pressed during the event (such as shift, alt and control) [in] point The co-ordinates of the cursor relative to the top-left of the screen [in] z The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise) [in] timeStamp The time the wheel is being rolled
Destructor.
- Since:
- 3.0, DALi version 1.0.0
Member Function Documentation
| bool Dali::WheelEvent::IsAltModifier | ( | ) | const |
Checks to see if Alt key modifier has been supplied.
- Since:
- 3.0, DALi version 1.0.0
- Returns:
- True if alt modifier
| bool Dali::WheelEvent::IsCtrlModifier | ( | ) | const |
Checks to see if Ctrl (control) key modifier has been supplied.
- Since:
- 3.0, DALi version 1.0.0
- Returns:
- True if ctrl modifier
| bool Dali::WheelEvent::IsShiftModifier | ( | ) | const |
Checks to see if Shift key modifier has been supplied.
- Since:
- 3.0, DALi version 1.0.0
- Returns:
- True if shift modifier
Member Data Documentation
The direction in which the wheel is being rolled.
0 means the default vertical wheel, and 1 means horizontal wheel.
Type of the event.
- See also:
- Type