API Console: Difference between revisions
XML import API auto-gen |
XML import |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<sidebar>API | <sidebar>API Contents</sidebar> | ||
Text console additions | Text console additions | ||
===Examples=== | __TOC__ | ||
==Functions provided for this class== | |||
{| | |||
|- | |||
|width="35%"|[[API Console.AddText|AddText]] | |||
|Adds a window to the list of consoles available | |||
|- | |||
|width="35%"|[[API Console.AddMemory|AddMemory]] | |||
|Adds a window to the list of consoles available | |||
|- | |||
|width="35%"|[[API Console.GetDefault|GetDefault]] | |||
|Gets the default (read-only) console window | |||
|- | |||
|width="35%"|[[API Console.Rename|Rename]] | |||
|Renames the given console | |||
|- | |||
|width="35%"|[[API Console.SetMemMode|SetMemMode]] | |||
|Sets whether to show address and bytes for the console | |||
|- | |||
|width="35%"|[[API Console.SetInputRGB|SetInputRGB]] | |||
|Sets the colour of text inserted by the user from now on | |||
|- | |||
|width="35%"|[[API Console.SetOutputRGB|SetOutputRGB]] | |||
|Sets the colour of text inserted by the component from now on | |||
|- | |||
|width="35%"|[[API Console.WriteText|WriteText]] | |||
|Adds a block of text to the console window | |||
|- | |||
|width="35%"|[[API Console.GetLineText|GetLineText]] | |||
|Reads a line of text from the given console, pass -1 for final line | |||
|- | |||
|width="35%"|[[API Console.SetLineText|SetLineText]] | |||
|Writes a line of text from the given console, pass -1 for final line | |||
|- | |||
|width="35%"|[[API Console.GetLineBytes|GetLineBytes]] | |||
|Reads a line of bytes from the given console extending the array if needed | |||
|- | |||
|width="35%"|[[API Console.SetLineBytes|SetLineBytes]] | |||
|Writes a line of bytes from the given console, pass -1 for final line | |||
|- | |||
|width="35%"|[[API Console.CountLines|CountLines]] | |||
|Counts the number of lines in the console | |||
|- | |||
|width="35%"|[[API Console.ClearText|ClearText]] | |||
|Clears all the text in the console | |||
|} | |||
==Examples== | |||
This demonstration creates two console windows, one is a memory window and one is a text window. | |||
When the pin A.0 goes high the view of each switches - the text window displays as memory and vice versa. Though the view changes, the ''type'' of console stays the same - one is fixed memory, the other is a stream that is always added to. | |||
{{Fcfile|SIMAPI Console.fcfx|SIMAPI Console}} | |||
==See also== | |||
[[API Debug.Print]] | |||
[[API Scope]] | |||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Text console additions
Functions provided for this class
| AddText | Adds a window to the list of consoles available |
| AddMemory | Adds a window to the list of consoles available |
| GetDefault | Gets the default (read-only) console window |
| Rename | Renames the given console |
| SetMemMode | Sets whether to show address and bytes for the console |
| SetInputRGB | Sets the colour of text inserted by the user from now on |
| SetOutputRGB | Sets the colour of text inserted by the component from now on |
| WriteText | Adds a block of text to the console window |
| GetLineText | Reads a line of text from the given console, pass -1 for final line |
| SetLineText | Writes a line of text from the given console, pass -1 for final line |
| GetLineBytes | Reads a line of bytes from the given console extending the array if needed |
| SetLineBytes | Writes a line of bytes from the given console, pass -1 for final line |
| CountLines | Counts the number of lines in the console |
| ClearText | Clears all the text in the console |
Examples
This demonstration creates two console windows, one is a memory window and one is a text window.
When the pin A.0 goes high the view of each switches - the text window displays as memory and vice versa. Though the view changes, the type of console stays the same - one is fixed memory, the other is a stream that is always added to.
