Class Wheel

    Definition

    Namespace:
    Tizen.NUI
    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 : BaseHandle, INotifyPropertyChanged, IDisposable
    Inheritance
    object
    BindableObject
    Tizen.NUI.Binding.Element
    BaseHandle
    Wheel
    Implements
    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable

    Constructors

    View Source

    Wheel()

    The default constructor of Wheel class.

    Declaration
    public Wheel()
    View Source

    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.

    Properties

    View Source

    Direction

    The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel).

    Declaration
    public int Direction { get; }
    Property Value
    Type Description
    int
    View Source

    Modifiers

    Modifier keys pressed during the event (such as Shift, Alt, and Ctrl).

    Declaration
    public uint Modifiers { get; }
    Property Value
    Type Description
    uint
    View Source

    Point

    The coordinates of the cursor relative to the top-left of the screen.

    Declaration
    public Vector2 Point { get; }
    Property Value
    Type Description
    Vector2
    View Source

    TimeStamp

    The time the wheel is being rolled.

    Declaration
    public uint TimeStamp { get; }
    Property Value
    Type Description
    uint
    View Source

    Type

    The type of the wheel event.

    Declaration
    public Wheel.WheelType Type { get; }
    Property Value
    Type Description
    Wheel.WheelType
    View Source

    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 Source

    IsAltModifier()

    Checks to see if Alt key modifier has been supplied.

    Declaration
    public bool IsAltModifier()
    Returns
    Type Description
    bool

    True if Alt modifier.

    View Source

    IsCtrlModifier()

    Checks to see if Ctrl (control) key modifier has been supplied.

    Declaration
    public bool IsCtrlModifier()
    Returns
    Type Description
    bool

    True if Ctrl modifier.

    View Source

    IsShiftModifier()

    Checks to see if the Shift key modifier has been supplied.

    Declaration
    public bool IsShiftModifier()
    Returns
    Type Description
    bool

    True if Shift modifier.

    Implements

    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX