Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 91 additions & 62 deletions SadConsole/SadConsole.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11828,6 +11828,11 @@
The controls added which contain a <see cref="P:SadConsole.UI.Controls.ControlBase.Name"/> value.
</summary>
</member>
<member name="M:SadConsole.UI.ControlHost.#ctor">
<summary>
Constructs a ControlHost object.
</summary>
</member>
<member name="P:SadConsole.UI.ControlHost.Item(System.Int32)">
<summary>
Gets a control by index.
Expand Down Expand Up @@ -11961,6 +11966,11 @@
<param name="newControl">The control that should be focused.</param>
<param name="oldControl">The control that currently has focus.</param>
</member>
<member name="E:SadConsole.UI.ControlHost.FocusedControlChangedEvent">
<summary>
Event raised when the focused control is changed.
</summary>
</member>
<member name="M:SadConsole.UI.ControlHost.CanFocusControl(SadConsole.UI.Controls.ControlBase)">
<summary>
Determins if a control is enabled and <see cref="P:SadConsole.UI.Controls.ControlBase.CanFocus"/> is <see langword="true"/>.
Expand Down Expand Up @@ -12060,64 +12070,6 @@
<member name="M:SadConsole.UI.ControlHost.OnDeserialized(System.Runtime.Serialization.StreamingContext)">
<inheritdoc/>
</member>
<member name="T:SadConsole.UI.ControlsConsole">
<summary>
A basic console that can contain controls.
</summary>
</member>
<member name="P:SadConsole.UI.ControlsConsole.Controls">
<summary>
The controls host holding all the controls.
</summary>
</member>
<member name="M:SadConsole.UI.ControlsConsole.#ctor(System.Int32,System.Int32)">
<summary>
Creates a new console.
</summary>
<param name="width">The width in cells of the surface.</param>
<param name="height">The height in cells of the surface.</param>
</member>
<member name="M:SadConsole.UI.ControlsConsole.#ctor(System.Int32,System.Int32,SadConsole.ColoredGlyphBase[])">
<summary>
Creates a new screen object that can render a surface. Uses the specified cells to generate the surface.
</summary>
<param name="width">The width in cells of the surface.</param>
<param name="height">The height in cells of the surface.</param>
<param name="initialCells">The initial cells to seed the surface.</param>
</member>
<member name="M:SadConsole.UI.ControlsConsole.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Creates a new console with the specified width and height, with <see cref="F:SadRogue.Primitives.Color.Transparent"/> for the background and <see cref="F:SadRogue.Primitives.Color.White"/> for the foreground.
</summary>
<param name="width">The visible width of the console in cells.</param>
<param name="height">The visible height of the console in cells.</param>
<param name="bufferWidth">The total width of the console in cells.</param>
<param name="bufferHeight">The total height of the console in cells.</param>
</member>
<member name="M:SadConsole.UI.ControlsConsole.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,SadConsole.ColoredGlyphBase[])">
<summary>
Creates a console with the specified width and height, with <see cref="F:SadRogue.Primitives.Color.Transparent"/> for the background and <see cref="F:SadRogue.Primitives.Color.White"/> for the foreground.
</summary>
<param name="width">The width of the console in cells.</param>
<param name="height">The height of the console in cells.</param>
<param name="bufferWidth">The total width of the console in cells.</param>
<param name="bufferHeight">The total height of the console in cells.</param>
<param name="initialCells">The cells to seed the console with. If <see langword="null"/>, creates the cells for you.</param>
</member>
<member name="M:SadConsole.UI.ControlsConsole.#ctor(SadConsole.ICellSurface,SadConsole.IFont,System.Nullable{SadRogue.Primitives.Point})">
<summary>
Creates a new console using the existing surface.
</summary>
<param name="surface">The surface.</param>
<param name="font">The font to use with the surface.</param>
<param name="fontSize">The font size.</param>
</member>
<member name="M:SadConsole.UI.ControlsConsole.ToString">
<summary>
Returns the value "Console (Controls)".
</summary>
<returns>The string "Console (Controls)".</returns>
</member>
<member name="T:SadConsole.UI.Controls.Button">
<summary>
Simple button control with a height of 1.
Expand Down Expand Up @@ -12242,11 +12194,12 @@
</summary>
<param name="focus">When <see langword="true"/>, focuses the button before clicking.</param>
</member>
<member name="M:SadConsole.UI.Controls.ButtonBase.ProcessKeyboard(SadConsole.Input.Keyboard)">
<member name="M:SadConsole.UI.Controls.ButtonBase.ProcessKeyboard(SadConsole.Input.Keyboard,SadConsole.UI.Controls.ControlBase)">
<summary>
Detects if the SPACE or ENTER keys are pressed and calls the <see cref="E:SadConsole.UI.Controls.ButtonBase.Click"/> method.
</summary>
<param name="info"></param>
<param name="origin"></param>
</member>
<member name="M:SadConsole.UI.Controls.ButtonBase.OnMouseIn(SadConsole.UI.Controls.ControlBase.ControlMouseState)">
<inheritdoc />
Expand Down Expand Up @@ -12742,8 +12695,19 @@
<member name="M:SadConsole.UI.Controls.ControlBase.ProcessKeyboard(SadConsole.Input.Keyboard)">
<summary>
Called when the keyboard is used on this control.
This function is called only if the <see cref="P:SadConsole.UI.Controls.ControlBase.KeyboardHandler"/> declines
to handle the keyboard input.
</summary>
<param name="state">The state of the keyboard.</param>
</member>
<member name="M:SadConsole.UI.Controls.ControlBase.ProcessKeyboard(SadConsole.Input.Keyboard,SadConsole.UI.Controls.ControlBase)">
<summary>
Called when the keyboard is used on this control.
Overriding this method is primarily for composite controls that need to
handle keyboard input
</summary>
<param name="state">The state of the keyboard.</param>
<param name="origin"></param>
</member>
<member name="M:SadConsole.UI.Controls.ControlBase.ProcessMouse(SadConsole.Input.MouseScreenObjectState)">
<summary>
Expand Down Expand Up @@ -13597,9 +13561,6 @@
<member name="M:SadConsole.UI.Controls.Panel.OnMouseExit(SadConsole.UI.Controls.ControlBase.ControlMouseState)">
<inheritdoc/>
</member>
<member name="M:SadConsole.UI.Controls.Panel.ProcessKeyboard(SadConsole.Input.Keyboard)">
<inheritdoc/>
</member>
<member name="M:SadConsole.UI.Controls.Panel.OnIsDirtyChanged">
<summary>
When <see cref="P:SadConsole.UI.Controls.ControlBase.IsDirty"/> is set to <see langword="true"/>, changes the child controls to also be dirty.
Expand Down Expand Up @@ -14694,6 +14655,74 @@
<member name="M:SadConsole.UI.Controls.ToggleSwitch.UpdateAndRedraw(System.TimeSpan)">
<inheritdoc/>
</member>
<member name="T:SadConsole.UI.ControlsConsole">
<summary>
A basic console that can contain controls.
</summary>
</member>
<member name="P:SadConsole.UI.ControlsConsole.Controls">
<summary>
The controls host holding all the controls.
</summary>
</member>
<member name="M:SadConsole.UI.ControlsConsole.#ctor(System.Int32,System.Int32)">
<summary>
Creates a new console.
</summary>
<param name="width">The width in cells of the surface.</param>
<param name="height">The height in cells of the surface.</param>
</member>
<member name="M:SadConsole.UI.ControlsConsole.#ctor(System.Int32,System.Int32,SadConsole.ColoredGlyphBase[])">
<summary>
Creates a new screen object that can render a surface. Uses the specified cells to generate the surface.
</summary>
<param name="width">The width in cells of the surface.</param>
<param name="height">The height in cells of the surface.</param>
<param name="initialCells">The initial cells to seed the surface.</param>
</member>
<member name="M:SadConsole.UI.ControlsConsole.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Creates a new console with the specified width and height, with <see cref="F:SadRogue.Primitives.Color.Transparent"/> for the background and <see cref="F:SadRogue.Primitives.Color.White"/> for the foreground.
</summary>
<param name="width">The visible width of the console in cells.</param>
<param name="height">The visible height of the console in cells.</param>
<param name="bufferWidth">The total width of the console in cells.</param>
<param name="bufferHeight">The total height of the console in cells.</param>
</member>
<member name="M:SadConsole.UI.ControlsConsole.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,SadConsole.ColoredGlyphBase[])">
<summary>
Creates a console with the specified width and height, with <see cref="F:SadRogue.Primitives.Color.Transparent"/> for the background and <see cref="F:SadRogue.Primitives.Color.White"/> for the foreground.
</summary>
<param name="width">The width of the console in cells.</param>
<param name="height">The height of the console in cells.</param>
<param name="bufferWidth">The total width of the console in cells.</param>
<param name="bufferHeight">The total height of the console in cells.</param>
<param name="initialCells">The cells to seed the console with. If <see langword="null"/>, creates the cells for you.</param>
</member>
<member name="M:SadConsole.UI.ControlsConsole.#ctor(SadConsole.ICellSurface,SadConsole.IFont,System.Nullable{SadRogue.Primitives.Point})">
<summary>
Creates a new console using the existing surface.
</summary>
<param name="surface">The surface.</param>
<param name="font">The font to use with the surface.</param>
<param name="fontSize">The font size.</param>
</member>
<member name="M:SadConsole.UI.ControlsConsole.ToString">
<summary>
Returns the value "Console (Controls)".
</summary>
<returns>The string "Console (Controls)".</returns>
</member>
<member name="T:SadConsole.UI.Handlers.FocusDirection">
<summary>

</summary>
</member>
<member name="P:SadConsole.UI.Handlers.TabFocusHandler.Container">
<summary>
The container this handler operates on.
</summary>
</member>
<member name="T:SadConsole.UI.KeyPressEventArgs">
<summary>
Event arguments to indicate that a key is being pressed on a control that allows keyboard key cancelling.
Expand Down
Loading