MouseDragViewPort Class
Definition
Section titled “Definition”Enables dragging a scrollable surface around by mouse.
public class MouseDragViewPort : MouseConsoleComponent, IComponentInheritance object → MouseConsoleComponent
Implements IComponent
Constructors
Section titled “Constructors”MouseDragViewPort()
Section titled “MouseDragViewPort()”public MouseDragViewPort()Properties
Section titled “Properties”IsEnabled
Section titled “IsEnabled”When true, enables this component.
public bool IsEnabled { get; set; }Methods
Section titled “Methods”OnAdded(IScreenObject)
Section titled “OnAdded(IScreenObject)”Called when the component is added to a host.
public override void OnAdded(IScreenObject host)Parameters
Section titled “Parameters”host IScreenObject
The host that added the component.
Exceptions
Section titled “Exceptions”Exception
Raised when the host this component is added to doesn’t implement IScreenSurface.
ProcessMouse(IScreenObject, MouseScreenObjectState, out bool)
Section titled “ProcessMouse(IScreenObject, MouseScreenObjectState, out bool)”Called by a host when the mouse is being processed.
public override void ProcessMouse(IScreenObject host, MouseScreenObjectState state, out bool handled)Parameters
Section titled “Parameters”host IScreenObject
The host calling the component.
state MouseScreenObjectState
The state of the mouse in relation to the console.
handled bool
When set to true informs the host caller that we handled the mouse and to stop others from handling.