Class StatusBar

A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItems. The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a statusbar.
Inheritance
System.Object
Responder
View
StatusBar
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class StatusBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Constructors

| Improve this Doc View Source

StatusBar()

Initializes a new instance of the StatusBar class.
Declaration
public StatusBar()
| Improve this Doc View Source

StatusBar(StatusItem[])

Initializes a new instance of the StatusBar class with the specified set of StatusItems. The StatusBar will be drawn on the lowest line of the terminal or SuperView (if not null).
Declaration
public StatusBar(StatusItem[] items)
Parameters
Type Name Description
StatusItem[] items A list of statusbar items.

Properties

| Improve this Doc View Source

Items

The items that compose the StatusBar
Declaration
public StatusItem[] Items { get; set; }
Property Value
Type Description
StatusItem[]
| Improve this Doc View Source

ShortcutDelimiter

Used for change the shortcut delimiter separator.
Declaration
public static ustring ShortcutDelimiter { get; set; }
Property Value
Type Description
NStack.ustring

Methods

| Improve this Doc View Source

AddItemAt(Int32, StatusItem)

Inserts a StatusItem in the specified index of Items.
Declaration
public void AddItemAt(int index, StatusItem item)
Parameters
Type Name Description
System.Int32 index The zero-based index at which item should be inserted.
StatusItem item The item to insert.
| Improve this Doc View Source

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides
| Improve this Doc View Source

MouseEvent(MouseEvent)

Declaration
public override bool MouseEvent(MouseEvent me)
Parameters
Type Name Description
MouseEvent me
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

OnEnter(View)

Declaration
public override bool OnEnter(View view)
Parameters
Type Name Description
View view
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

ProcessHotKey(KeyEvent)

Declaration
public override bool ProcessHotKey(KeyEvent kb)
Parameters
Type Name Description
KeyEvent kb
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

Redraw(Rect)

Declaration
public override void Redraw(Rect bounds)
Parameters
Type Name Description
Rect bounds
Overrides
| Improve this Doc View Source

RemoveItem(Int32)

Removes a StatusItem at specified index of Items.
Declaration
public StatusItem RemoveItem(int index)
Parameters
Type Name Description
System.Int32 index The zero-based index of the item to remove.
Returns
Type Description
StatusItem The StatusItem removed.

Implements

System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize