Gorgon
Show / Hide Table of Contents

Class GorgonMouseEventArgs

Mouse event arguments.

Inheritance
object
EventArgs
GorgonMouseEventArgs
Inherited Members
EventArgs.Empty
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Gorgon.Input
Assembly: Gorgon.Input.dll
Syntax
public class GorgonMouseEventArgs : EventArgs

Constructors

| Edit this page View Source

GorgonMouseEventArgs(MouseButtons, MouseButtons, Point, int, Point, int, int, bool)

Initializes a new instance of the GorgonMouseEventArgs class.

Declaration
public GorgonMouseEventArgs(MouseButtons buttons, MouseButtons shiftButtons, Point position, int wheelPosition, Point relativePosition, int wheelDelta, int clickCount, bool isAbsolute)
Parameters
Type Name Description
MouseButtons buttons

Buttons that are pressed during mouse event.

MouseButtons shiftButtons

Buttons that are held down during the mouse event.

Point position

Position of the mouse.

int wheelPosition

Position of the wheel.

Point relativePosition

Relative position of the mouse.

int wheelDelta

Relative position of the wheel.

int clickCount

Number of clicks in a timed period.

bool isAbsolute

true to use absolute positioning, false to use relative.

Properties

| Edit this page View Source

Buttons

Property to return the buttons that were held down during a GorgonRawMouse event.

Declaration
public MouseButtons Buttons { get; }
Property Value
Type Description
MouseButtons
| Edit this page View Source

ClickCount

Property to return the number of full clicks.

Declaration
public int ClickCount { get; }
Property Value
Type Description
int
| Edit this page View Source

DoubleClick

Property to return if a double click caused the event to trigger.

Declaration
public bool DoubleClick { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsAbsolute

Property to return whether the mouse is using absolute coordinates, or relative.

Declaration
public bool IsAbsolute { get; }
Property Value
Type Description
bool
| Edit this page View Source

Position

Property to return the position of the mouse.

Declaration
public Point Position { get; }
Property Value
Type Description
Point
| Edit this page View Source

RelativePosition

Property to return the amount that the mouse has moved since the last GorgonRawMouse event.

Declaration
public Point RelativePosition { get; }
Property Value
Type Description
Point
| Edit this page View Source

ShiftButtons

Property to return the buttons that were being held down in conjunction with the Buttons during a GorgonRawMouse event.

Declaration
public MouseButtons ShiftButtons { get; }
Property Value
Type Description
MouseButtons
| Edit this page View Source

WheelDelta

Property to return the amount that the wheel has moved since the last GorgonRawMouse event.

Declaration
public int WheelDelta { get; }
Property Value
Type Description
int
Remarks

If this is no mouse wheel present, this value will return 0.

| Edit this page View Source

WheelPosition

Property to return the wheel position.

Declaration
public int WheelPosition { get; }
Property Value
Type Description
int
Remarks

If there is no mouse wheel present, this value will return 0.

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)
GorgonNullExtensions.AsNullable<T>(object)
GorgonNullExtensions.IfNull<T>(object, T)
GorgonNullExtensions.IsNull(object)
  • Edit this page
  • View Source
In this article
Back to top Copyright 2023 - Licensed under the MIT license by Michael Winsor (Tape_Worm).
Send comments on this topic to the author