Class View

Inheritance

System.Object

Responder

View

Button

CheckBox

Label

MenuBar

RadioGroup

ScrollView

TextField

Toplevel

Inherited Members

Responder.CanFocus

Responder.MouseEvent(MouseEvent)

Namespace: Terminal

Assembly: Terminal.dll

Syntax

public class View : Terminal.Responder, System.Collections.IEnumerable

Constructors

View(Rect)

Declaration

public View (Terminal.Rect frame);

Parameters

Type	Name	Description
Rect	frame	To be added.

Fields

Driver

Declaration

public static Terminal.ConsoleDriver Driver;

Field Value

Type	Description
ConsoleDriver	To be added.

empty

Declaration

public static System.Collections.Generic.IList<Terminal.View> empty;

Field Value

Type	Description
System.Collections.Generic.IList<View>	To be added.

Properties

Bounds

Declaration

public Terminal.Rect Bounds { get; set; }

Property Value

Type	Description
Rect	To be added.

Focused

Returns the currently focused view inside this view, or null if nothing is focused.

Declaration

public Terminal.View Focused { get; }

Property Value

Type	Description
View	The focused.

Frame

Declaration

public Terminal.Rect Frame { get; set; }

Property Value

Type	Description
Rect	To be added.

HasFocus

Declaration

public override bool HasFocus { get; }

Property Value

Type	Description
System.Boolean	To be added.

Id

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String	To be added.

MostFocused

Declaration

public Terminal.View MostFocused { get; }

Property Value

Type	Description
View	To be added.

Subviews

Declaration

public System.Collections.Generic.IList<Terminal.View> Subviews { get; }

Property Value

Type	Description
System.Collections.Generic.IList<View>	To be added.

SuperView

Declaration

public Terminal.View SuperView { get; }

Property Value

Type	Description
View	To be added.

WantMousePositionReports

Gets or sets a value indicating whether this View want mouse position reports.

Declaration

public virtual bool WantMousePositionReports { get; set; }

Property Value

Type	Description
System.Boolean	true if want mouse position reports; otherwise, false.

Methods

Add(View)

Adds a subview to this view.

Declaration

public virtual void Add (Terminal.View view);

Parameters

Type	Name	Description
View	view	To be added.

Add(View[])

Declaration

public void Add (Terminal.View[] views);

Parameters

Type	Name	Description
View[]	views	To be added.

AddCh(Int32, Int32, Int32)

Displays the specified character in the specified column and row.

Declaration

public void AddCh (int col, int row, int ch);

Parameters

Type	Name	Description
System.Int32	col	Col.
System.Int32	row	Row.
System.Int32	ch	Ch.

ChildNeedsDisplay()

Declaration

public void ChildNeedsDisplay ();

Clear()

Clears the view region with the current color.

Declaration

public void Clear ();

Remarks

This clears the entire region used by this view.

ClearNeedsDisplay()

Declaration

protected void ClearNeedsDisplay ();

DrawFrame(Rect, Boolean)

Draws a frame in the current view, clipped by the boundary of this view

Declaration

public void DrawFrame (Terminal.Rect rect, bool fill = false);

Parameters

Type	Name	Description
Rect	rect	Rectangular region for the frame to be drawn.
System.Boolean	fill	If set to true it fill will the contents.

DrawHotString(String, Attribute, Attribute)

Utility function to draw strings that contain a hotkey

Declaration

public void DrawHotString (string text, Terminal.Attribute hotColor, Terminal.Attribute normalColor);

Parameters

Type	Name	Description
System.String	text	String to display, the underscoore before a letter flags the next letter as the hotkey.
Attribute	hotColor	Hot color.
Attribute	normalColor	Normal color.

DrawHotString(String, Boolean, ColorScheme)

Utility function to draw strings that contains a hotkey using a colorscheme and the "focused" state.

Declaration

public void DrawHotString (string text, bool focused, Terminal.ColorScheme scheme);

Parameters

Type	Name	Description
System.String	text	String to display, the underscoore before a letter flags the next letter as the hotkey.
System.Boolean	focused	If set to true this uses the focused colors from the color scheme, otherwise the regular ones.
ColorScheme	scheme	The color scheme to use.

EnsureFocus()

Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.

Declaration

public void EnsureFocus ();

FocusFirst()

Focuses the first focusable subview if one exists.

Declaration

public void FocusFirst ();

FocusLast()

Focuses the last focusable subview if one exists.

Declaration

public void FocusLast ();

FocusNext()

Focuses the next view.

Declaration

public bool FocusNext ();

Returns

Type	Description
System.Boolean	true, if next was focused, false otherwise.

FocusPrev()

Focuses the previous view.

Declaration

public bool FocusPrev ();

Returns

Type	Description
System.Boolean	true, if previous was focused, false otherwise.

GetEnumerator()

Declaration

[System.Runtime.CompilerServices.IteratorStateMachine(typeof(Terminal.View/<GetEnumerator>d__23))]
public System.Collections.IEnumerator GetEnumerator ();

Returns

Type	Description
System.Collections.IEnumerator	To be added.

LayoutSubviews()

Declaration

public virtual void LayoutSubviews ();

Move(Int32, Int32)

This moves the cursor to the specified column and row in the view.

Declaration

public void Move (int col, int row);

Parameters

Type	Name	Description
System.Int32	col	Col.
System.Int32	row	Row.

PositionCursor()

Positions the cursor in the right position based on the currently focused view in the chain.

Declaration

public virtual void PositionCursor ();

ProcessColdKey(KeyEvent)

Declaration

public override bool ProcessColdKey (Terminal.KeyEvent kb);

Parameters

Type	Name	Description
KeyEvent	kb	To be added.

Returns

Type	Description
System.Boolean	To be added.

ProcessHotKey(KeyEvent)

Declaration

public override bool ProcessHotKey (Terminal.KeyEvent kb);

Parameters

Type	Name	Description
KeyEvent	kb	To be added.

Returns

Type	Description
System.Boolean	To be added.

ProcessKey(KeyEvent)

Declaration

public override bool ProcessKey (Terminal.KeyEvent kb);

Parameters

Type	Name	Description
KeyEvent	kb	To be added.

Returns

Type	Description
System.Boolean	To be added.

Redraw(Rect)

Performs a redraw of this view and its subviews, only redraws the views that have been flagged for a re-display.

Declaration

public virtual void Redraw (Terminal.Rect region);

Parameters

Type	Name	Description
Rect	region	To be added.

Remarks

The region argument is relative to the view itself.

Remove(View)

Removes a widget from this container.

Declaration

public virtual void Remove (Terminal.View view);

Parameters

Type	Name	Description
View	view	To be added.

RemoveAll()

Removes all the widgets from this container.

Declaration

public virtual void RemoveAll ();

ScreenToView(Int32, Int32)

Converts a point from screen coordinates into the view coordinate space.

Declaration

public Terminal.Point ScreenToView (int x, int y);

Parameters

Type	Name	Description
System.Int32	x	X screen-coordinate point.
System.Int32	y	Y screen-coordinate point.

Returns

Type	Description
Point	The mapped point.

SetFocus(View)

Focuses the specified sub-view.

Declaration

public void SetFocus (Terminal.View view);

Parameters

Type	Name	Description
View	view	View.

SetNeedsDisplay()

Invoke to flag that this view needs to be redisplayed, by any code that alters the state of the view.

Declaration

public void SetNeedsDisplay ();

SetNeedsDisplay(Rect)

Declaration

public void SetNeedsDisplay (Terminal.Rect region);

Parameters

Type	Name	Description
Rect	region	To be added.

ToString()

Declaration

public override string ToString ();

Returns

Type	Description
System.String	To be added.