Interface IMouseHeldDown

Namespace

Terminal.Gui.ViewBase

Assembly

Terminal.Gui.dll

Handler for raising periodic events while the mouse is held down. Typically, mouse button only needs to be pressed down in a view to begin this event after which it can be moved elsewhere.

Common use cases for this includes holding a button down to increase a counter (e.g. in NumericUpDown).

public interface IMouseHeldDown : IDisposable

Inherited Members

IDisposable.Dispose()

Methods

Start()

Call to indicate that the mouse has been pressed down and any relevant actions should be undertaken (start timers, GrabMouse(View?) etc).

Stop()

Call to indicate that the mouse has been released and any relevant actions should be undertaken (stop timers, UngrabMouse() etc).

Events

MouseIsHeldDownTick

Periodically raised when the mouse is pressed down inside the view View.