InputConsoleComponent Class
Definition
Section titled “Definition”A base class that implements ProcessMouse(IScreenObject, MouseScreenObjectState, out bool) and ProcessKeyboard(IScreenObject, Keyboard, out bool) of IComponent.
public abstract class InputConsoleComponent : IComponentInheritance object
Implements IComponent
Constructors
Section titled “Constructors”InputConsoleComponent()
Section titled “InputConsoleComponent()”protected InputConsoleComponent()Properties
Section titled “Properties”SortOrder
Section titled “SortOrder”Indicates priority to other components.
public uint SortOrder { get; set; }Methods
Section titled “Methods”ProcessKeyboard(IScreenObject, Keyboard, out bool)
Section titled “ProcessKeyboard(IScreenObject, Keyboard, out bool)”Called by a host when the keyboard is being processed.
public abstract void ProcessKeyboard(IScreenObject host, Keyboard keyboard, out bool handled)Parameters
Section titled “Parameters”host IScreenObject
The host calling the component.
keyboard Keyboard
The state of the keyboard.
handled bool
When set to true informs the host caller that we handled the mouse and to stop others from handling.
ProcessMouse(IScreenObject, MouseScreenObjectState, out bool)
Section titled “ProcessMouse(IScreenObject, MouseScreenObjectState, out bool)”Called by a host when the mouse is being processed.
public abstract 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.
OnAdded(IScreenObject)
Section titled “OnAdded(IScreenObject)”Called when the component is added to a host.
public virtual void OnAdded(IScreenObject host)Parameters
Section titled “Parameters”host IScreenObject
The host that added the component.
OnRemoved(IScreenObject)
Section titled “OnRemoved(IScreenObject)”Called when the component is removed from the host.
public virtual void OnRemoved(IScreenObject host)Parameters
Section titled “Parameters”host IScreenObject
The host that removed the component.