Class MoveViewPortKeyboardHandler
Moves the view of an IScreenSurface with a set of specified keyboard keys.
Implements
Inherited Members
Namespace: SadConsole.Components
Assembly: SadConsole.Extended.dll
Syntax
public class MoveViewPortKeyboardHandler : KeyboardConsoleComponent, IComponentConstructors
MoveViewPortKeyboardHandler()
Creates this handler with the arrow keys.
Declaration
public MoveViewPortKeyboardHandler()MoveViewPortKeyboardHandler(Keys, Keys, Keys, Keys)
Creates this handler with the specified keys.
Declaration
public MoveViewPortKeyboardHandler(Keys left, Keys right, Keys up, Keys down)Parameters
| Type | Name | Description |
|---|---|---|
| Keys | left | The key to move left. |
| Keys | right | The key to move right. |
| Keys | up | The key to move up. |
| Keys | down | The key to move down. |
Properties
Down
The key to move down.
Declaration
public Keys Down { get; set; }Property Value
| Type | Description |
|---|---|
| Keys |
Left
The key to move left.
Declaration
public Keys Left { get; set; }Property Value
| Type | Description |
|---|---|
| Keys |
Right
The key to move right.
Declaration
public Keys Right { get; set; }Property Value
| Type | Description |
|---|---|
| Keys |
Up
The key to move up.
Declaration
public Keys Up { get; set; }Property Value
| Type | Description |
|---|---|
| Keys |
Methods
OnAdded(IScreenObject)
Called when the component is added to a host.
Declaration
public override void OnAdded(IScreenObject console)Parameters
| Type | Name | Description |
|---|---|---|
| IScreenObject | console |
Overrides
ProcessKeyboard(IScreenObject, Keyboard, out bool)
Called by a host when the keyboard is being processed.
Declaration
public override void ProcessKeyboard(IScreenObject consoleObject, Keyboard info, out bool handled)Parameters
| Type | Name | Description |
|---|---|---|
| IScreenObject | consoleObject | |
| Keyboard | info | |
| bool | handled | When set to true informs the host caller that we handled the mouse and to stop others from handling. |