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.Margin

View.ShadowStyle

View.Border

View.BorderStyle

View.OnBorderStyleChanging(CancelEventArgs<LineStyle>)

View.BorderStyleChanging

View.SetBorderStyle(LineStyle)

View.Padding

View.GetAdornmentsThickness()

View.Arrangement

View.ColorScheme

View.GetFocusColor()

View.GetHotFocusColor()

View.GetHotNormalColor()

View.GetNormalColor()

View.SetAttribute(Attribute)

View.GetAttribute()

View.RaiseAccepting(CommandContext)

View.OnAccepting(CommandEventArgs)

View.Accepting

View.RaiseSelecting(CommandContext)

View.OnSelecting(CommandEventArgs)

View.Selecting

View.RaiseHandlingHotKey()

View.OnHandlingHotKey(CommandEventArgs)

View.HandlingHotKey

View.AddCommand(Command, View.CommandImplementation)

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

View.GetSupportedCommands()

View.InvokeCommands(Command[], Key, KeyBinding?)

View.InvokeCommand(Command, Key, KeyBinding?)

View.InvokeCommand(Command, CommandContext)

View.SetContentSize(Size?)

View.GetContentSize()

View.ContentSizeTracksViewport

View.OnContentSizeChanged(SizeChangedEventArgs)

View.ContentSizeChanged

View.ContentToScreen(in Point)

View.ScreenToContent(in Point)

View.ViewportSettings

View.Viewport

View.ViewportChanged

View.OnViewportChanged(DrawEventArgs)

View.ViewportToScreen(in Rectangle)

View.ViewportToScreen(in Point)

View.ScreenToViewport(in Point)

View.GetViewportOffsetFromFrame()

View.ScrollVertical(int)

View.ScrollHorizontal(int)

View.Data

View.Id

View.Driver

View.Initialized

View.IsInitialized

View.BeginInit()

View.EndInit()

View.Enabled

View.EnabledChanged

View.OnEnabledChanged()

View.Visible

View.OnVisibleChanging()

View.VisibleChanging

View.OnVisibleChanged()

View.VisibleChanged

View.Title

View.OnTitleChanged()

View.OnTitleChanging(ref string)

View.TitleChanged

View.TitleChanging

View.ToString()

View.CursorVisibility

View.PositionCursor()

View.Diagnostics

View.GetClip()

View.SetClip(Region)

View.SetClipToScreen()

View.ExcludeFromClip(Rectangle)

View.ClipViewport()

View.Draw()

View.DrawBorderAndPadding()

View.OnDrawingBorderAndPadding()

View.OnSettingAttribute()

View.SettingAttribute

View.SetNormalAttribute()

View.OnClearingViewport()

View.ClearingViewport

View.ClearViewport()

View.OnDrawingText()

View.DrawingText

View.DrawText()

View.DrawingContent

View.OnDrawingSubviews()

View.DrawingSubviews

View.DrawSubviews()

View.OnRenderingLineCanvas()

View.LineCanvas

View.SuperViewRendersLineCanvas

View.RenderLineCanvas()

View.OnDrawComplete()

View.DrawComplete

View.NeedsDraw

View.SubViewNeedsDraw

View.SetNeedsDraw()

View.SetNeedsDraw(Rectangle)

View.SetSubViewNeedsDraw()

View.ClearNeedsDraw()

View.Move(int, int)

View.AddRune(Rune)

View.AddRune(char)

View.AddRune(int, int, Rune)

View.AddStr(string)

View.DrawHotString(string, Attribute, Attribute)

View.DrawHotString(string, bool)

View.FillRect(Rectangle, Color?)

View.FillRect(Rectangle, Rune)

View.Subviews

View.SuperView

View.IsAdded

View.Add(View)

View.Add(params View[])

View.Added

View.OnAdded(SuperViewChangedEventArgs)

View.OnRemoved(SuperViewChangedEventArgs)

View.Remove(View)

View.RemoveAll()

View.Removed

View.GetTopSuperView(View, View)

View.MoveSubviewTowardsEnd(View)

View.MoveSubviewToEnd(View)

View.MoveSubviewTowardsStart(View)

View.MoveSubviewToStart(View)

View.HotKeyChanged

View.HotKey

View.AddKeyBindingsForHotKey(Key, Key, object)

View.HotKeySpecifier

View.NewKeyDownEvent(Key)

View.OnKeyDown(Key)

View.KeyDown

View.OnKeyDownNotHandled(Key)

View.KeyDownNotHandled

View.NewKeyUpEvent(Key)

View.OnKeyUp(Key)

View.KeyUp

View.KeyBindings

View.IsHotKeyBound(Key, out View)

View.InvokeCommands(Key, KeyBindingScope)

View.Contains(in Point)

View.Frame

View.FrameToScreen()

View.ScreenToFrame(in Point)

View.X

View.Y

View.Height

View.Width

View.Layout(Size)

View.Layout()

View.SetRelativeLayout(Size)

View.OnSubviewLayout(LayoutEventArgs)

View.SubviewLayout

View.OnSubviewsLaidOut(LayoutEventArgs)

View.SubviewsLaidOut

View.NeedsLayout

View.SetNeedsLayout()

View.ValidatePosDim

View.OnMouseEnter(CancelEventArgs)

View.MouseEnter

View.OnMouseLeave()

View.MouseLeave

View.WantContinuousButtonPressed

View.WantMousePositionReports

View.NewMouseEvent(MouseEventArgs)

View.RaiseMouseEvent(MouseEventArgs)

View.OnMouseEvent(MouseEventArgs)

View.MouseEvent

View.RaiseMouseClickEvent(MouseEventArgs)

View.OnMouseClick(MouseEventArgs)

View.MouseClick

View.HighlightStyle

View.OnHighlight(CancelEventArgs<HighlightStyle>)

View.Highlight

View.AdvanceFocus(NavigationDirection, TabBehavior?)

View.OnAdvancingFocus(NavigationDirection, TabBehavior?)

View.AdvancingFocus

View.CanFocus

View.CanFocusChanged

View.FocusDeepest(NavigationDirection, TabBehavior?)

View.Focused

View.IsCurrentTop

View.MostFocused

View.OnCanFocusChanged()

View.HasFocus

View.SetFocus()

View.OnHasFocusChanging(bool, bool, View, View)

View.HasFocusChanging

View.HasFocusChanged

View.TabStop

View.OnTextChanged()

View.PreserveTrailingSpaces

View.Text

View.TextAlignment

View.TextChanged

View.TextDirection

View.TextFormatter

View.VerticalTextAlignment

View.UpdateTextFormatterText()

Responder.Dispose()

Responder.Disposing

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

TabView()

Initializes a TabView class.

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 SetNeedsDraw().

Dispose(bool)

Disposes the control and all Tabs.

EnsureSelectedTabIsVisible()

Updates TabScrollOffset to ensure that SelectedTab is visible.

EnsureValidScrollOffsets(int)

Updates TabScrollOffset to be a valid index of Tabs.

OnDrawingContent()

Called when the View's content is to be drawn. The default implementation does nothing.

OnHasFocusChanged(bool, View?, View?)

Invoked after HasFocus has changed. This method is called before the HasFocusChanged event is raised.

OnSelectedTabChanged(Tab, Tab)

Raises the SelectedTabChanged event.

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 Tab is clicked. Can be used to cancel navigation, show context menu (e.g. on right click) etc.