Class TabView

Namespace

Terminal.Gui

Assembly

Terminal.Gui.dll

Control that hosts multiple sub views, presenting a single one at once

public class TabView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Inheritance

object

Responder

View

TabView

Implements

IDisposable

ISupportInitializeNotification

ISupportInitialize

Inherited Members

View.Added

View.Removed

View.Enter

View.Leave

View.MouseEnter

View.MouseLeave

View.MouseClick

View.CanFocusChanged

View.EnabledChanged

View.VisibleChanged

View.HotKeyChanged

View.HotKey

View.HotKeySpecifier

View.Shortcut

View.ShortcutTag

View.ShortcutAction

View.Data

View.Driver

View.Subviews

View.TabIndexes

View.TabIndex

View.TabStop

View.CanFocus

View.Id

View.IsCurrentTop

View.WantMousePositionReports

View.WantContinuousButtonPressed

View.Frame

View.LayoutStyle

View.Bounds

View.X

View.Y

View.Width

View.Height

View.ForceValidatePosDim

View.GetMinWidthHeight(out Size)

View.SetMinWidthHeight()

View.TextFormatter

View.SuperView

View.UpdateTextFormatterText()

View.ProcessResizeView()

View.SetNeedsDisplay()

View.ClearLayoutNeeded()

View.SetNeedsDisplay(Rect)

View.SetChildNeedsDisplay()

View.Add(View)

View.Add(params View[])

View.RemoveAll()

View.Remove(View)

View.BringSubviewToFront(View)

View.SendSubviewToBack(View)

View.SendSubviewBackwards(View)

View.BringSubviewForward(View)

View.Clear()

View.Clear(Rect)

View.ScreenToView(int, int)

View.ClipToBounds()

View.SetClip(Rect)

View.DrawFrame(Rect, int, bool)

View.DrawHotString(ustring, Attribute, Attribute)

View.DrawHotString(ustring, bool, ColorScheme)

View.Move(int, int, bool)

View.PositionCursor()

View.HasFocus

View.OnAdded(View)

View.OnRemoved(View)

View.OnEnter(View)

View.OnLeave(View)

View.Focused

View.MostFocused

View.ColorScheme

View.AddRune(int, int, Rune)

View.ClearNeedsDisplay()

View.DrawContent

View.OnDrawContent(Rect)

View.DrawContentComplete

View.OnDrawContentComplete(Rect)

View.SetFocus()

View.KeyPress

View.InvokeKeybindings(KeyEvent)

View.AddKeyBinding(Key, params Command[])

View.ReplaceKeyBinding(Key, Key)

View.ContainsKeyBinding(Key)

View.ClearKeybindings()

View.ClearKeybinding(Key)

View.ClearKeybinding(params Command[])

View.AddCommand(Command, Func<bool?>)

View.GetSupportedCommands()

View.GetKeyFromCommand(params Command[])

View.ProcessHotKey(KeyEvent)

View.ProcessColdKey(KeyEvent)

View.KeyDown

View.OnKeyDown(KeyEvent)

View.KeyUp

View.OnKeyUp(KeyEvent)

View.EnsureFocus()

View.FocusFirst()

View.FocusLast()

View.FocusPrev()

View.FocusNext()

View.LayoutStarted

View.LayoutComplete

View.Initialized

View.LayoutSubviews()

View.Text

View.AutoSize

View.PreserveTrailingSpaces

View.TextAlignment

View.VerticalTextAlignment

View.TextDirection

View.IsInitialized

View.IsAdded

View.Enabled

View.ClearOnVisibleFalse

View.Visible

View.Border

View.IgnoreBorderPropertyOnRedraw

View.ToString()

View.GetAutoSize()

View.GetHotKeySpecifierLength(bool)

View.GetTextFormatterBoundsSize()

View.GetBoundsTextFormatterSize()

View.OnMouseEnter(MouseEvent)

View.OnMouseLeave(MouseEvent)

View.OnMouseEvent(MouseEvent)

View.OnMouseClick(View.MouseEventArgs)

View.OnCanFocusChanged()

View.OnEnabledChanged()

View.OnVisibleChanged()

View.BeginInit()

View.EndInit()

View.SetWidth(int, out int)

View.SetHeight(int, out int)

View.GetCurrentWidth(out int)

View.GetCurrentHeight(out int)

View.GetNormalColor()

View.GetFocusColor()

View.GetHotNormalColor()

View.GetTopSuperView()

Responder.MouseEvent(MouseEvent)

Responder.Dispose()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

TabView()

Initializes a TabView class using Computed layout.

Fields

DefaultMaxTabTextWidth

The default MaxTabTextWidth to set on new TabView controls

Properties

MaxTabTextWidth

The maximum number of characters to render in a Tab header. This prevents one long tab from pushing out all the others.

SelectedTab

The currently selected member of Tabs chosen by the user

Style

Render choices for how to display tabs. After making changes, call ApplyStyleChanges()

TabScrollOffset

When there are too many tabs to render, this indicates the first tab to render on the screen.

Tabs

All tabs currently hosted by the control

Methods

AddTab(Tab, bool)

Adds the given tab to Tabs

ApplyStyleChanges()

Updates the control to use the latest state settings in Style. This can change the size of the client area of the tab (for rendering the selected tab's content). This method includes a call to SetNeedsDisplay()

Dispose(bool)

Disposes the control and all Tabs

EnsureSelectedTabIsVisible()

Updates TabScrollOffset to ensure that SelectedTab is visible

EnsureValidScrollOffsets()

Updates TabScrollOffset to be a valid index of Tabs

OnSelectedTabChanged(Tab, Tab)

Raises the SelectedTabChanged event

ProcessKey(KeyEvent)

If the view is focused, gives the view a chance to process the keystroke.

Redraw(Rect)

Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.

RemoveTab(Tab)

Removes the given tab from Tabs. Caller is responsible for disposing the tab's hosted View if appropriate.

SwitchTabBy(int)

Changes the SelectedTab by the given amount.
Positive for right, negative for left. If no tab is currently selected then the first tab will become selected

Events

SelectedTabChanged

Event for when SelectedTab changes

TabClicked

Event fired when a TabView.Tab is clicked. Can be used to cancel navigation, show context menu (e.g. on right click) etc.