Struct UioHookEvent

Namespace

SharpHook.Data

Assembly

SharpHook.dll

Represents an event which can be raised by libuiohook.

[ExcludeFromCodeCoverage]
public struct UioHookEvent : IEquatable<UioHookEvent>

Implements

IEquatable<UioHookEvent>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

This is a union-like struct and the data it contains depends on the type of the event.

The Keyboard field is available for the events of the following types:

• KeyTyped
• KeyPressed
• KeyReleased

The Mouse field is available for the events of the following types:

• MouseClicked
• MousePressed
• MouseReleased
• MouseMoved
• MouseDragged

The Wheel field is available for the events of the following type:

• MouseWheel

Fields

Keyboard

The event data if this event is keyboard-related.

public KeyboardEventData Keyboard

Field Value

KeyboardEventData

The event data if this event is keyboard-related.

Mask

The mask of the event.

public EventMask Mask

Field Value

EventMask

The mask of the event.

Mouse

The event data if this event is mouse-related.

public MouseEventData Mouse

Field Value

MouseEventData

The event data if this event is mouse-related.

Time

The UNIX timestamp of the event.

public ulong Time

Field Value

ulong

The UNIX timestamp of the event.

Type

The type of the event.

public EventType Type

Field Value

EventType

The type of the event.

Wheel

The event data if this event is mouse wheel-related.

public MouseWheelEventData Wheel

Field Value

MouseWheelEventData

The event data if this event is mouse wheel-related.

Methods

Equals(UioHookEvent)

Compares this object to another object for equality.

public readonly bool Equals(UioHookEvent e)

Parameters

e UioHookEvent

The object to compare

Returns

bool

true if the objects are equal. Otherwise, false.

Equals(object?)

Compares this object to another object for equality.

public override readonly bool Equals(object? obj)

Parameters

obj object

The object to compare

Returns

bool

true if the objects are equal. Otherwise, false.

GetHashCode()

Gets the hash code of this object.

public override readonly int GetHashCode()

Returns

int

The hash code of this object.

ToString()

Returns the string representation of this object.

public override readonly string ToString()

Returns

string

The string representation of this object.

Operators

operator ==(UioHookEvent, UioHookEvent)

Compares two objects for equality.

public static bool operator ==(UioHookEvent left, UioHookEvent right)

Parameters

left UioHookEvent

The first object to compare

right UioHookEvent

The second object to compare

Returns

bool

true if the objects are equal. Otherwise, false.

operator !=(UioHookEvent, UioHookEvent)

Compares two objects for inequality.

public static bool operator !=(UioHookEvent left, UioHookEvent right)

Parameters

left UioHookEvent

The first object to compare

right UioHookEvent

The second object to compare

Returns

bool

true if the objects are not equal. Otherwise, false.

See Also

EventType

EventMask

KeyboardEventData

MouseEventData

MouseWheelEventData