Class MouseConsoleComponent
A base class that implements ProcessMouse(IScreenObject, MouseScreenObjectState, out bool) of IComponent.
Implements
Inherited Members
Namespace: SadConsole.Components
Assembly: SadConsole.dll
Syntax
public abstract class MouseConsoleComponent : IComponentConstructors
MouseConsoleComponent()
Declaration
protected MouseConsoleComponent()Properties
SortOrder
Indicates priority to other components.
Declaration
public uint SortOrder { get; set; }Property Value
| Type | Description |
|---|---|
| uint |
Methods
OnAdded(IScreenObject)
Called when the component is added to a host.
Declaration
public virtual void OnAdded(IScreenObject host)Parameters
| Type | Name | Description |
|---|---|---|
| IScreenObject | host | The host that added the component. |
OnRemoved(IScreenObject)
Called when the component is removed from the host.
Declaration
public virtual void OnRemoved(IScreenObject host)Parameters
| Type | Name | Description |
|---|---|---|
| IScreenObject | host | The host that removed the component. |
ProcessMouse(IScreenObject, MouseScreenObjectState, out bool)
Called by a host when the mouse is being processed.
Declaration
public abstract void ProcessMouse(IScreenObject host, MouseScreenObjectState state, out bool handled)Parameters
| Type | Name | Description |
|---|---|---|
| IScreenObject | host | The host calling the component. |
| MouseScreenObjectState | state | The state of the mouse in relation to the console. |
| bool | handled | When set to true informs the host caller that we handled the mouse and to stop others from handling. |