API v7.0

Breaking changes for API v7.0

Here is a list of breaking changes that happened during the API v7.0 period when differing versions of Terminaux introduced breaking changes.

From 6.0.x to 7.0.x

Between the 6.0.x and 7.0.x version range, we've made the following breaking changes:

Removed all obsolete functions

Affected classes

public static class GraphicsTools
public static class ListWriterColor
public static class AlignedFigletTextColor
public static class AlignedTextColor
public static class BarChartColor
public static class BorderColor
public static class BorderTextColor
public static class BoxColor
public static class BoxFrameColor
public static class BreakdownChartColor
public static class CanvasColor
public static class FigletColor
public static class FigletWhereColor
public static class PowerLineColor
public static class ProgressBarColor
public static class ProgressBarVerticalColor
public static class RainbowBackTextWriterColor
public static class RainbowTextWriterColor
public static class SliderColor
public static class SliderVerticalColor
public static class StickChartColor
public static class TableColor
public static class TruncatedLineText
public static class TruncatedText
public static class KeybindingsWriter
public static class LineHandleRangedWriter
public static class LineHandleWriter

The above classes, which were marked as deprecated back in Terminaux 6.0, have been removed in this API revision to clean things up as we're getting ready to stabilize the cyclic writers to make them more consistent and usable than before.

You'll have to use cyclic writers if you want to continue using fancy writers. You can consult this page for more info.

Base shell info generic class implemented

BaseShellInfo.cs

public abstract class BaseShellInfo : IShellInfo

When you create your own shell info classes to give your shell some important information, such as commands and other info, you had to override the BaseShell property so that it returned a new instance of your shell. However, this can be a hassle in certain scenarios.

Starting from Nitrocid KS 0.1.2 and Terminaux 7.0, you'll no longer have to override the BaseShell property because we've implemented a generic version of the above class that takes a type of your shell. For example, if your shell is called OxygenShell and your shell info class is called OxygenShellInfo, you can just inherit the generic version of the class so that it becomes BaseShellInfo<OxygenShell>.

As a result, the following properties are removed from the IShellInfo interface:

IShellInfo.cs

BaseShell? ShellBase { get; }
PromptPresetBase CurrentPreset { get; }

When inheriting the non-generic base shell class, your shell info class might hold wrong information about your shell, even if your commands are defined. Therefore, you must migrate to the generic version of the class if you want to retain your shell settings.

Cyclic writers now use typed CyclicWriter classes

The cyclic writers have been redefined to make their classes use the typed CyclicWriter classes. These classes consist of:

• SimpleCyclicWriter

• GraphicalCyclicWriter

This was required because we needed applications to be able to determine whether the writer that they're using was a simple one or a graphical one. Simple cyclic writers are suitable for command line applications, while graphical ones are used in TUIs.

The following writers have been migrated to SimpleCyclicWriter:

• Decoration

• Emoji

• FigletText

• Kaomoji

• KeyShortcut

• Keybindings

• LineHandle

• ListEntry

• Listing

• NerdFonts

• PowerLine

• ProgressBar

• ProgressBarNoText

• SimpleProgress

• Slider

• Spinner

• StemLeafChart

• TextException

• TextMarquee

The following writers have been migrated to GraphicalCyclicWriter:

• AlignedFigletText

• AlignedText

• AnimatedCanvas

• AnimatedText

• BarChart

• Border

• BoundedText

• Box

• BoxFrame

• BreakdownChart

• Calendars

• Canvas

• Eraser

• Line

• LineChart

• LinesChart

• PieChart

• Selection

• StickChart

• SyntaxText

• Table

• TextPath

• WinsLosses

The following shape renderers have been migrated to GraphicalCyclicWriter:

• Arc

• Circle

• Ellipsis

• Parallelogram

• Rectangle

• Square

• Trapezoid

• Triangle

Part of the introduction of the two typed cyclic writer classes involved removing both IStaticRenderable and IGeometricShape interfaces to reduce the complexity involved.

Consult the updated cyclic writer documentation for more information.

Changed left and right margins to widths in some graphical writers

Some graphical writers

public int LeftMargin
{
    get => leftMargin;
    set => leftMargin = value;
}

public int RightMargin
{
    get => rightMargin;
    set => rightMargin = value;
}

We have replaced the two above properties with the Width property that some graphical writers that are derived from GraphicalCyclicWriter use to determine the element width. The following writers are affected:

• FigletText

• ProgressBar

• ProgressBarNoText

• SimpleProgress

• TextMarquee

You'll have to calculate the total width that the affected writers need to render to the terminal.

Keybindings and StemLeafChart writers now act as a simple writer

Keybindings.cs + StemLeafChart.cs

public int Left { get; set; }
public int Top { get; set; }

The two above properties have been removed because simple writers are not supposed to use anything related to positioning.

You can still use the rendering tools functions to accommodate your needs, should you use positioning to write these.

Moved WriteRenderable() and RenderRenderable() to RendererTools

We have moved all WriteRenderable() and RenderRenderable() function overloads from ContainerTools to RendererTools to better convey the goals as we have created the two base cyclic writer classes.

Migrated InfoBoxInputPasswordColor to InfoBoxInputColor

InfoBoxInputPasswordColor.cs

public static class InfoBoxInputPasswordColor

We've migrated the two classes into one by adding functions labelled with Password, such as WriteInfoBoxInputPassword(), to the InfoBoxInputColor to reduce maintenance burden and to avoid code repetition.

You'll have to reference the same functions but with the InfoBoxInputColor class.

Removed SplitVTSequencesMultiple()

VtSequenceTools.cs

public static string[] SplitVTSequencesMultiple(string Text, VtSequenceType types = VtSequenceType.All)

As SplitVTSequencesMultiple() provides the same functionality as SplitVTSequences() with the target type set to All, we've seen the above function as redundant; therefore, we've removed it.

Replace all calls to the removed function with SplitVTSequences().

Removed SliderInside from Selection

Selection.cs

public bool SliderInside { get; set; }

As development of Terminaux 7.0 continues, we've seen the above property as redundant due to the fact that it was buggy. We've removed this property to make the selection implementation more simple. This removal was part of the broader mouse improvements that were done in this version of Terminaux.

You'll have to manually adjust the left position to add 1, depending on the look of your application. If you're using this property, you'll have to increment the left position. Otherwise, you don't have to.

Presentation system now uses the input modules

InputInfo.cs

public class InputInfo

Input modules have been implemented, and they are stable enough that the presentation input elements are actually duplicates of the broader input module classes. As a result, we've decided to eliminate the presentation-specific input elements and to rename the InputInfo class to PresentationInputInfo to avoid ambiguity. As a result, the following input methods have been removed together with the corresponding interface, IInputMethod, and the base class, BaseInputMethod:

• MaskedTextInputMethod

• SelectionInputMethod

• SelectionMultipleInputMethod

• TextInputMethod

This is done as a result of the addition of a new infobox that uses the input modules.

You'll have to replace all definitions of the older InputMethod classes with the newer InputModule classes. The following input methods can be replaced with:

• MaskedTextInputMethod -> MaskedTextBoxModule

• SelectionInputMethod -> ComboBoxModule

• SelectionMultipleInputMethod -> MultiComboBoxModule

• TextInputMethod -> TextBoxModule