Show / Hide Table of Contents

Class Mouse

Adds mouse-related extension methods for IScreenObject.

Inheritance
object
Mouse
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: SadConsole.Quick
Assembly: SadConsole.dll
Syntax
public static class Mouse

Methods

RemoveMouseHook(IScreenObject, Func<IScreenObject, MouseScreenObjectState, bool>)

Removes the specified handler that was added with WithMouse(IScreenObject, Func<IScreenObject, MouseScreenObjectState, bool>).

Declaration
public static IScreenObject RemoveMouseHook(this IScreenObject screenObject, Func<IScreenObject, MouseScreenObjectState, bool> handler)
Parameters
Type Name Description
IScreenObject screenObject

The object to use.

Func<IScreenObject, MouseScreenObjectState, bool> handler

The handler callback.

Returns
Type Description
IScreenObject

RemoveMouseHooks(IScreenObject)

Removes all of the mouse hooks added with WithMouse(IScreenObject, Func<IScreenObject, MouseScreenObjectState, bool>).

Declaration
public static IScreenObject RemoveMouseHooks(this IScreenObject screenObject)
Parameters
Type Name Description
IScreenObject screenObject

The object to use.

Returns
Type Description
IScreenObject

WithMouse(IScreenObject, Func<IScreenObject, MouseScreenObjectState, bool>)

Adds a mouse handler to a IScreenObject.

Declaration
public static IScreenObject WithMouse(this IScreenObject screenObject, Func<IScreenObject, MouseScreenObjectState, bool> handler)
Parameters
Type Name Description
IScreenObject screenObject

The object to use.

Func<IScreenObject, MouseScreenObjectState, bool> handler

The handler callback.

Returns
Type Description
IScreenObject
In this article

Back to top

Back to top Generated by DocFX