Fixed compile error
Dependents: IBMIoTClientEthernetExample IBMIoTClientWifiExample
Fork of C12832 by
Diff: TextDisplay.h
- Revision:
- 17:1c3011afe95d
- Parent:
- 0:4bbc531be6e2
--- a/TextDisplay.h Wed Feb 05 14:25:16 2014 +0000 +++ b/TextDisplay.h Mon Mar 17 19:47:39 2014 +0000 @@ -18,17 +18,21 @@ #include "mbed.h" +/** + * TextDisplay interface + */ class TextDisplay : public Stream { public: - // functions needing implementation in derived implementation class - /** Create a TextDisplay interface + /** + * Create a TextDisplay interface * * @param name The name used in the path to access the strean through the filesystem */ TextDisplay(const char *name = NULL); - /** output a character at the given position + /** + * Output a character at the given position * * @param column column where charater must be written * @param row where character must be written @@ -36,27 +40,39 @@ */ virtual void character(int column, int row, int c) = 0; - /** return number if rows on TextDisplay - * @result number of rows + /** + * Return number of rows on TextDisplay + * + * @results number of rows */ virtual int rows() = 0; - /** return number if columns on TextDisplay - * @result number of rows - */ + /** + * Return number if columns on TextDisplay\ + * + * @results number of rows + */ virtual int columns() = 0; // functions that come for free, but can be overwritten - /** redirect output from a stream (stoud, sterr) to display - * @param stream stream that shall be redirected to the TextDisplay - */ + /** + * Redirect output from a stream (stoud, sterr) to display + * + * @param stream stream that shall be redirected to the TextDisplay + */ virtual bool claim (FILE *stream); - /** clear screen - */ + /** + * Clear screen + */ virtual void cls(); + + /** + * Change the cursor position to column, row (in pixels) + */ virtual void locate(int column, int row); + virtual void foreground(uint16_t colour); virtual void background(uint16_t colour); // putc (from Stream)