Class TextModeMouseReportingEvent

Event published when a TextModeMouseReporter encodes a mouse event into a terminal byte sequence. Disabled by default due to high-frequency mouse event volume; enable via PublishEvents.

Inheritance

object

ScyllaEvent

TextModeMouseReportingEvent

Inherited Members

ScyllaEvent.IsCancelled

ScyllaEvent.StopPropagation()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Scylla.TextMode

Assembly: ScyllaTextMode.dll

Syntax

public sealed class TextModeMouseReportingEvent : ScyllaEvent

Constructors

TextModeMouseReportingEvent(byte[], TerminalMouseButton, int, int, bool, bool, TextModeMouseReporter)

Creates a new mouse reporting event.

Declaration

public TextModeMouseReportingEvent(byte[] encodedData, TerminalMouseButton button, int column, int row, bool pressed, bool motion, TextModeMouseReporter reporter)

Parameters

Type	Name	Description
byte[]	encodedData	The encoded ANSI byte sequence.
TerminalMouseButton	button	The mouse button involved.
int	column	The 1-based column coordinate.
int	row	The 1-based row coordinate.
bool	pressed	Whether this is a press event.
bool	motion	Whether this is a motion event.
TextModeMouseReporter	reporter	The mouse reporter.

Properties

Button

The mouse button involved in the event.

Declaration

public TerminalMouseButton Button { get; }

Property Value

Type	Description
TerminalMouseButton

Column

The 1-based column coordinate of the mouse event.

Declaration

public int Column { get; }

Property Value

Type	Description
int

EncodedData

The encoded ANSI byte sequence for the mouse event.

Declaration

public byte[] EncodedData { get; }

Property Value

Type	Description
byte[]

Motion

Whether this is a motion event.

Declaration

public bool Motion { get; }

Property Value

Type	Description
bool

Pressed

Whether this is a press event (true) or release event (false).

Declaration

public bool Pressed { get; }

Property Value

Type	Description
bool

Reporter

The mouse reporter that published this event.

Declaration

public TextModeMouseReporter Reporter { get; }

Property Value

Type	Description
TextModeMouseReporter

Row

The 1-based row coordinate of the mouse event.

Declaration

public int Row { get; }

Property Value

Type	Description
int