Terminaux 1.x - Manual
ProjectsWebsiteBlog

🖊️Console Writers

We need to write to the console

This feature is available on 1.0.0 or higher.

Terminaux provides a vast amount of console writers for different purposes, like the progress bar writer, writing console output in color, etc.

Normal console writers

Starting from ConsoleWriters, this namespace provides the following classes:

  • ListWriterColor

    • Provides you with the necessary functions to let you write the list entries to the console easily.

  • TextWriterColor

    • Provides you with the necessary functions to allow you to write the text to the console with and without color.

  • TextWriterSlowColor

    • Provides you with the necessary functions to simulate a typewriter writing a requested string to the console with and without color.

  • TextWriterWhereColor

    • Provides you with the necessary functions to write the text in a specific position to the console with and without color.

  • TextWriterWhereSlowColor

    • Provides you with the necessary functions to simulate a typewriter that writes a text in a specific position to the console with and without color.

  • TextWriterWrappedColor

    • Provides you with the necessary functions to allow you to wrap long outputs to pages, also called a pager.

Consult the below page to find out how to use these functions.

LogoNamespace Terminaux.Writer.ConsoleWriters | Terminaux API - Aptivi Internals

The console writers have three variants of writing functions as of 1.8.0:

  • Write(): Default colors

  • WriteColor(): Foreground colors

  • WriteColorBack(): Foreground and background colors

Fancy writers

Alongside these writers, there are also writers that are categorized as "fancy" because they either print so awesome or they print graphics. They can be found in the FancyWriters namespace that provides the below classes:

  • BorderColor

    • Provides you with the necessary functions to allow you to draw a border somewhere in the console.

  • BoxColor

    • Provides you with the necessary functions to allow you to draw a box somewhere in the console.

  • BoxFrameColor

    • Provides you with the necessary functions to allow you to draw a box frame somewhere in the console.

  • BoxFrameTextColor (1.9.0+)

    • Provides you with the necessary functions to allow you to draw a box frame with the title somewhere in the console.

  • CenteredFigletTextColor

    • Provides you with the necessary functions to allow you to render a string using the provided Figlet font in the middle of the console.

  • CenteredTextColor

    • Provides you with the necessary functions to allow you to render a string in the middle of the console.

  • FigletColor

    • Provides you with the necessary functions to allow you to render a string using the provided Figlet font to the console.

  • FigletWhereColor

    • Provides you with the necessary functions to allow you to render a string using the provided Figlet font to the console at any position you want.

  • InfoBoxColor

    • Provides you with the necessary functions to allow you to render an information box containing text inside it in the middle of the console. You can make it either modal (having a user press any key to exit) or informational (not waiting for any user input) on Terminaux 1.3.0 or higher.

  • PowerLineColor

    • Provides you with the necessary functions to allow you to build PowerLine segments and display them to the console.

  • ProgressBarColor

    • Provides you with the necessary functions to allow you to render a horizontal progress bar to the console.

  • ProgressBarVerticalColor

    • Provides you with the necessary functions to allow you to render a vertical progress bar to the console.

  • SeparatorWriterColor

    • Provides you with the necessary functions to allow you to render a separator including text to the console.

  • TableColor

    • Provides you with the necessary functions to allow you to render a table to the console.

Consult the below page to find out how to use these functions.

LogoNamespace Terminaux.Writer.FancyWriters | Terminaux API - Aptivi Internals

The tools for fancy writers can also be found here:

LogoNamespace Terminaux.Writer.FancyWriters.Tools | Terminaux API - Aptivi Internals

Starting from 1.6.0, the legacy Figlet font renderers are still available under a separate library, Terminaux.Figlet. The following classes are available:

  • CenteredFigletTextColorLegacy

  • FigletColorLegacy

  • FigletWhereColorLegacy

However, we discourage using them because they're obsolete and will be removed in the next Terminaux release. Obsoletion warnings were added in the last 1.x version series to guide developers to use the latest Figletize-based functions.

Miscellaneous writers

Finally, the miscellaneous writers are the writers that don't have any meaningful category. That's when MiscWriters comes in. This namespace contains these classes:

  • LineHandleWriter

    • Provides you with the necessary functions to allow you to render a line of a text file with the compiler-like line handle using the specified line and column to the console.

  • LineHandleRangedWriter

    • Provides you with the necessary functions to allow you to render a line of a text file with the compiler-like line handle using the specified line and column range to the console. This is used to highlight relevant parts of the entire line

LineHandleRangedWriter is available starting from 1.7.0.

Consult the below page to find out how to use these functions:

LogoNamespace Terminaux.Writer.MiscWriters | Terminaux API - Aptivi Internals