namespace Terminal.Gui;
public partial class View
{
private string _text;
///
/// Gets or sets whether trailing spaces at the end of word-wrapped lines are preserved or not when
/// is enabled. If trailing spaces at the end of wrapped
/// lines will be removed when is formatted for display. The default is .
///
public virtual bool PreserveTrailingSpaces
{
get => TextFormatter.PreserveTrailingSpaces;
set
{
if (TextFormatter.PreserveTrailingSpaces != value)
{
TextFormatter.PreserveTrailingSpaces = value;
TextFormatter.NeedsFormat = true;
}
}
}
/// The text displayed by the .
///
/// The text will be drawn before any subviews are drawn.
///
/// The text will be drawn starting at the view origin (0, 0) and will be formatted according to
/// and .
///
///
/// The text will word-wrap to additional lines if it does not fit horizontally. If 's height
/// is 1, the text will be clipped.
///
/// If is true, the will be adjusted to fit the text.
/// When the text changes, the is fired.
///
public virtual string Text
{
get => _text;
set
{
if (value == _text)
{
return;
}
string old = _text;
_text = value;
UpdateTextFormatterText ();
OnResizeNeeded ();
#if DEBUG
if (_text is { } && string.IsNullOrEmpty (Id))
{
Id = _text;
}
#endif
OnTextChanged (old, Text);
}
}
///
/// Called when the has changed. Fires the event.
///
///
///
public void OnTextChanged (string oldValue, string newValue)
{
TextChanged?.Invoke (this, new StateEventArgs (oldValue, newValue));
}
///
/// Text changed event, raised when the text has changed.
///
public event EventHandler> TextChanged;
///
/// Gets or sets how the View's is aligned horizontally when drawn. Changing this property will
/// redisplay the .
///
///
/// If is true, the will be adjusted to fit the text.
///
/// The text alignment.
public virtual TextAlignment TextAlignment
{
get => TextFormatter.Alignment;
set
{
TextFormatter.Alignment = value;
UpdateTextFormatterText ();
OnResizeNeeded ();
}
}
///
/// Gets or sets the direction of the View's . Changing this property will redisplay the
/// .
///
///
/// If is true, the will be adjusted to fit the text.
///
/// The text alignment.
public virtual TextDirection TextDirection
{
get => TextFormatter.Direction;
set
{
UpdateTextDirection (value);
TextFormatter.Direction = value;
}
}
/// Gets the used to format .
public TextFormatter TextFormatter { get; init; } = new ();
///
/// Gets or sets how the View's is aligned vertically when drawn. Changing this property will
/// redisplay the .
///
///
/// If is true, the will be adjusted to fit the text.
///
/// The text alignment.
public virtual VerticalTextAlignment VerticalTextAlignment
{
get => TextFormatter.VerticalAlignment;
set
{
TextFormatter.VerticalAlignment = value;
SetNeedsDisplay ();
}
}
///
/// Gets the Frame dimensions required to fit within using the text
/// specified by the property and accounting for any
/// characters.
///
/// The the needs to be set to fit the text.
public Size GetAutoSize ()
{
var x = 0;
var y = 0;
if (IsInitialized)
{
x = Bounds.X;
y = Bounds.Y;
}
Rectangle rect = TextFormatter.CalcRect (x, y, TextFormatter.Text, TextFormatter.Direction);
int newWidth = rect.Size.Width
- GetHotKeySpecifierLength ()
+ (Margin == null
? 0
: Margin.Thickness.Horizontal
+ Border.Thickness.Horizontal
+ Padding.Thickness.Horizontal);
int newHeight = rect.Size.Height
- GetHotKeySpecifierLength (false)
+ (Margin == null
? 0
: Margin.Thickness.Vertical + Border.Thickness.Vertical + Padding.Thickness.Vertical);
return new (newWidth, newHeight);
}
///
/// Gets the width or height of the characters in the
/// property.
///
///
///
/// This is for , not . For to show the hotkey,
/// set View. to the desired character.
///
///
/// Only the first HotKey specifier found in is supported.
///
///
///
/// If (the default) the width required for the HotKey specifier is returned.
/// Otherwise the height is returned.
///
///
/// The number of characters required for the . If the text direction
/// specified by does not match the parameter, 0 is
/// returned.
///
public int GetHotKeySpecifierLength (bool isWidth = true)
{
if (isWidth)
{
return TextFormatter.IsHorizontalDirection (TextDirection) && TextFormatter.Text?.Contains ((char)TextFormatter.HotKeySpecifier.Value) == true
? Math.Max (TextFormatter.HotKeySpecifier.GetColumns (), 0)
: 0;
}
return TextFormatter.IsVerticalDirection (TextDirection) && TextFormatter.Text?.Contains ((char)TextFormatter.HotKeySpecifier.Value) == true
? Math.Max (TextFormatter.HotKeySpecifier.GetColumns (), 0)
: 0;
}
/// Can be overridden if the has different format than the default.
protected virtual void UpdateTextFormatterText ()
{
if (TextFormatter is { })
{
TextFormatter.Text = _text;
}
}
/// Gets the dimensions required for ignoring a .
///
internal Size GetSizeNeededForTextWithoutHotKey ()
{
return new (
TextFormatter.Size.Width - GetHotKeySpecifierLength (),
TextFormatter.Size.Height - GetHotKeySpecifierLength (false)
);
}
///
/// Internal API. Sets .Size to the current size, adjusted for
/// .
///
///
/// Use this API to set when the view has changed such that the size required to
/// fit the text has changed. changes.
///
///
internal void SetTextFormatterSize ()
{
if (!IsInitialized)
{
TextFormatter.Size = Size.Empty;
return;
}
if (string.IsNullOrEmpty (TextFormatter.Text))
{
TextFormatter.Size = Bounds.Size;
return;
}
TextFormatter.Size = new (
Bounds.Size.Width + GetHotKeySpecifierLength (),
Bounds.Size.Height + GetHotKeySpecifierLength (false)
);
}
private bool IsValidAutoSize (out Size autoSize)
{
Rectangle rect = TextFormatter.CalcRect (_frame.X, _frame.Y, TextFormatter.Text, TextDirection);
autoSize = new (
rect.Size.Width - GetHotKeySpecifierLength (),
rect.Size.Height - GetHotKeySpecifierLength (false)
);
return !((ValidatePosDim && (!(Width is Dim.DimAbsolute) || !(Height is Dim.DimAbsolute)))
|| _frame.Size.Width != rect.Size.Width - GetHotKeySpecifierLength ()
|| _frame.Size.Height != rect.Size.Height - GetHotKeySpecifierLength (false));
}
private bool IsValidAutoSizeHeight (Dim height)
{
Rectangle rect = TextFormatter.CalcRect (_frame.X, _frame.Y, TextFormatter.Text, TextDirection);
int dimValue = height.Anchor (0);
return !((ValidatePosDim && !(height is Dim.DimAbsolute))
|| dimValue != rect.Size.Height - GetHotKeySpecifierLength (false));
}
private bool IsValidAutoSizeWidth (Dim width)
{
Rectangle rect = TextFormatter.CalcRect (_frame.X, _frame.Y, TextFormatter.Text, TextDirection);
int dimValue = width.Anchor (0);
return !((ValidatePosDim && !(width is Dim.DimAbsolute))
|| dimValue != rect.Size.Width - GetHotKeySpecifierLength ());
}
/// Sets the size of the View to the minimum width or height required to fit .
///
/// if the size was changed; if ==
/// or will not fit.
///
///
/// Always returns if is or if
/// (Horizontal) or (Vertical) are not not set or zero. Does not take into
/// account word wrapping.
///
private bool SetFrameToFitText ()
{
if (AutoSize == false)
{
throw new InvalidOperationException ("SetFrameToFitText can only be called when AutoSize is true");
}
// BUGBUG: This API is broken - should not assume Frame.Height == Bounds.Height
//
// Gets the minimum dimensions required to fit the View's , factoring in .
//
// The minimum dimensions required.
// if the dimensions fit within the View's , otherwise.
//
// Always returns if is or
// if (Horizontal) or (Vertical) are not not set or zero.
// Does not take into account word wrapping.
//
bool GetMinimumSizeOfText (out Size sizeRequired)
{
if (!IsInitialized)
{
sizeRequired = Size.Empty;
return false;
}
sizeRequired = Bounds.Size;
if (AutoSize || string.IsNullOrEmpty (TextFormatter.Text))
{
return false;
}
switch (TextFormatter.IsVerticalDirection (TextDirection))
{
case true:
int colWidth = TextFormatter.GetWidestLineLength (new List { TextFormatter.Text }, 0, 1);
// TODO: v2 - This uses frame.Width; it should only use Bounds
if (_frame.Width < colWidth
&& (Width is null || (Bounds.Width >= 0 && Width is Dim.DimAbsolute && Width.Anchor (0) >= 0 && Width.Anchor (0) < colWidth)))
{
sizeRequired = new (colWidth, Bounds.Height);
return true;
}
break;
default:
if (_frame.Height < 1 && (Height is null || (Height is Dim.DimAbsolute && Height.Anchor (0) == 0)))
{
sizeRequired = new (Bounds.Width, 1);
return true;
}
break;
}
return false;
}
if (GetMinimumSizeOfText (out Size size))
{
// TODO: This is a hack.
//_width = size.Width;
//_height = size.Height;
_frame = new (_frame.Location, size);
//throw new InvalidOperationException ("This is a hack.");
return true;
}
return false;
}
// only called from EndInit
private void UpdateTextDirection (TextDirection newDirection)
{
bool directionChanged = TextFormatter.IsHorizontalDirection (TextFormatter.Direction)
!= TextFormatter.IsHorizontalDirection (newDirection);
TextFormatter.Direction = newDirection;
bool isValidOldAutoSize = AutoSize && IsValidAutoSize (out Size _);
UpdateTextFormatterText ();
if ((!ValidatePosDim && directionChanged && AutoSize)
|| (ValidatePosDim && directionChanged && AutoSize && isValidOldAutoSize))
{
OnResizeNeeded ();
}
else if (AutoSize && directionChanged && IsAdded)
{
ResizeBoundsToFit (Bounds.Size);
}
SetTextFormatterSize ();
SetNeedsDisplay ();
}
}