ANSI Functions

All ANSI related functions are mapped on the Ansi table. These functions are used to retrieve ANSI escape sequences to accomplish various tasks like moving the cursor, clearing/deleting characters and so on.

  • Ansi.GetClearCharacters(chars)
  • Ansi.GetCursorDown(lines)
  • Ansi.GetCursorLeft(columns)
  • Ansi.GetCursorMove(row, column)
  • Ansi.GetCursorRight(columns)
  • Ansi.GetCursorUp(lines)
  • Ansi.GetDeleteLines(lines)
  • Ansi.GetDeleteCharacters(chars)
  • Ansi.GetInsertBlankLines(lines)
  • Ansi.GetInsertCharacters(chars)


Ansi.GetClearCharacters(chars)

code = Ansi.GetClearCharacters(chars)

Returns a string with the ANSI escape sequence needed to clear 'chars' characters.

INPUT

  • chars : How many charaters we have to clear

OUTPUT

  • result : String with the requested ANSI escape sequence


Ansi.GetCursorDown(lines)

code = Ansi.GetCursorDown(lines)

Return the escape sequence to move the cursor down <lines> lines.

INPUT

  • lines : How many lines we want to move the cursor down

OUTPUT

  • result : String with the requested ANSI escape sequence


Ansi.GetCursorLeft(columns)

code = Ansi.GetCursorLeft(columns)

Return the escape sequence to move the cursor left <columns> chars.

INPUT

  • columns : How many columns we want to move the cursor to the left

OUTPUT

  • result : String with the requested ANSI escape sequence


Ansi.GetCursorMove(row, column)

code = Ansi.GetCursorMove(row, column)

Return the escape sequence to move the cursor to (row, column).

INPUT

  • row : Row position
  • column : Column position

OUTPUT

  • result : String with the requested ANSI escape sequence


Ansi.GetCursorRight(columns)

code = Ansi.GetCursorRight(columns)

Return the escape sequence to move the cursor right <columns> chars.

INPUT

  • columns : How many columns we want to move the cursor to the right

OUTPUT

  • result : String with the requested ANSI escape sequence


Ansi.GetCursorUp(lines)

code = Ansi.GetCursorUp(lines)

Return the escape sequence to move the cursor up <lines> lines.

INPUT

  • lines : How many lines we want to move the cursor up

OUTPUT

  • result : String with the requested ANSI escape sequence


Ansi.GetDeleteCharacters(chars)

code = Ansi.GetDeleteCharacters(chars)

Return the escape sequence to delete <chars> characters.

INPUT

  • chars : How many charaters we have to delete

OUTPUT

  • result : String with the requested ANSI escape sequence


Ansi.GetDeleteLines(lines)

code = Ansi.GetDeleteLines(lines)

Return the escape sequence to delete <lines> rows.

INPUT

  • lines : How many lines we have to delete

OUTPUT

  • result : String with the requested ANSI escape sequence


Ansi.GetInsertBlankLines(lines)

code = Ansi.GetInsertBlankLines(lines)

Return the escape sequence to insert <lines> blank rows.

INPUT

  • lines : How many blank lines we have to insert

OUTPUT

  • result : String with the requested ANSI escape sequence


Ansi.GetInsertCharacters(chars)

code = Ansi.GetInsertCharacters(chars)

Return the escape sequence to insert <chars> characters.

INPUT

  • chars : How many charaters we have to insert

OUTPUT

  • result : String with the requested ANSI escape sequence
hollywoodlibs/ansi/ansifunctions.txt · Ultima modifica: 2016/10/10 21:11 da admin
CC Attribution-Noncommercial 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0