InputEventMouseButton

InputEventMouseButton

Back to API Reference

Namespace: Electron2D

Summary

Represents a mouse button press, release, or wheel step.

Declaration

public class Electron2D.InputEventMouseButton : Electron2D.InputEventMouse

Remarks

Wheel events use Electron2D.InputEventMouseButton.ButtonIndex values such as Electron2D.MouseButton.WheelUp and Electron2D.MouseButton.WheelDown, matching Electron2D's mouse wheel model.

Instances are mutable and are not synchronized; use them from the input dispatch thread that owns the event.

Thread Safety

Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.

Since

This class is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
ButtonIndex	Property	Gets or sets the mouse button or wheel constant.
Canceled	Property	Gets or sets whether the platform canceled this mouse button event.
DoubleClick	Property	Gets or sets whether this event represents a double-click.
Factor	Property	Gets or sets the wheel delta or high-precision scroll amount.
Pressed	Property	Gets or sets whether the button is pressed.
Electron2D.InputEventMouseButton()	Constructor	Initializes a new instance of the InputEventMouseButton type.

Member Details

ButtonIndex

Kind: Property

public Electron2D.MouseButton ButtonIndex { get; set; }

Summary

Gets or sets the mouse button or wheel constant.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current button index value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseButton

Canceled

Kind: Property

public System.Boolean Canceled { get; set; }

Summary

Gets or sets whether the platform canceled this mouse button event.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current canceled value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseButton

DoubleClick

Kind: Property

public System.Boolean DoubleClick { get; set; }

Summary

Gets or sets whether this event represents a double-click.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current double click value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseButton

Factor

Kind: Property

public System.Single Factor { get; set; }

Summary

Gets or sets the wheel delta or high-precision scroll amount.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current factor value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseButton

Pressed

Kind: Property

public System.Boolean Pressed { get; set; }

Summary

Gets or sets whether the button is pressed.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current pressed value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseButton

Electron2D.InputEventMouseButton()

Kind: Constructor

public Electron2D.InputEventMouseButton()

Summary

Initializes a new instance of the InputEventMouseButton type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.InputEventMouseButton