Christian Weiß / Mbed 2 deprecated SelbstTest2

Dependencies:   mbed

C12832_copy/TextDisplay.h@0:bfb11ea418eb, 2018-11-15 (annotated)

Committer:
Wizo
Date:
Thu Nov 15 18:05:10 2018 +0000
Revision:
0:bfb11ea418eb
SelbstTest2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wizo 0:bfb11ea418eb 1 /* mbed TextDisplay Library Base Class
Wizo 0:bfb11ea418eb 2 * Copyright (c) 2007-2009 sford
Wizo 0:bfb11ea418eb 3 * Released under the MIT License: http://mbed.org/license/mit
Wizo 0:bfb11ea418eb 4 *
Wizo 0:bfb11ea418eb 5 * A common base class for Text displays
Wizo 0:bfb11ea418eb 6 * To port a new display, derive from this class and implement
Wizo 0:bfb11ea418eb 7 * the constructor (setup the display), character (put a character
Wizo 0:bfb11ea418eb 8 * at a location), rows and columns (number of rows/cols) functions.
Wizo 0:bfb11ea418eb 9 * Everything else (locate, printf, putc, cls) will come for free
Wizo 0:bfb11ea418eb 10 *
Wizo 0:bfb11ea418eb 11 * The model is the display will wrap at the right and bottom, so you can
Wizo 0:bfb11ea418eb 12 * keep writing and will always get valid characters. The location is
Wizo 0:bfb11ea418eb 13 * maintained internally to the class to make this easy
Wizo 0:bfb11ea418eb 14 */
Wizo 0:bfb11ea418eb 15
Wizo 0:bfb11ea418eb 16 #ifndef MBED_TEXTDISPLAY_H
Wizo 0:bfb11ea418eb 17 #define MBED_TEXTDISPLAY_H
Wizo 0:bfb11ea418eb 18
Wizo 0:bfb11ea418eb 19 #include "mbed.h"
Wizo 0:bfb11ea418eb 20
Wizo 0:bfb11ea418eb 21 class TextDisplay : public Stream {
Wizo 0:bfb11ea418eb 22 public:
Wizo 0:bfb11ea418eb 23
Wizo 0:bfb11ea418eb 24 // functions needing implementation in derived implementation class
Wizo 0:bfb11ea418eb 25 /** Create a TextDisplay interface
Wizo 0:bfb11ea418eb 26 *
Wizo 0:bfb11ea418eb 27 * @param name The name used in the path to access the strean through the filesystem
Wizo 0:bfb11ea418eb 28 */
Wizo 0:bfb11ea418eb 29 TextDisplay(const char *name = NULL);
Wizo 0:bfb11ea418eb 30
Wizo 0:bfb11ea418eb 31 /** output a character at the given position
Wizo 0:bfb11ea418eb 32 *
Wizo 0:bfb11ea418eb 33 * @param column column where charater must be written
Wizo 0:bfb11ea418eb 34 * @param row where character must be written
Wizo 0:bfb11ea418eb 35 * @param c the character to be written to the TextDisplay
Wizo 0:bfb11ea418eb 36 */
Wizo 0:bfb11ea418eb 37 virtual void character(int column, int row, int c) = 0;
Wizo 0:bfb11ea418eb 38
Wizo 0:bfb11ea418eb 39 /** return number if rows on TextDisplay
Wizo 0:bfb11ea418eb 40 * @result number of rows
Wizo 0:bfb11ea418eb 41 */
Wizo 0:bfb11ea418eb 42 virtual int rows() = 0;
Wizo 0:bfb11ea418eb 43
Wizo 0:bfb11ea418eb 44 /** return number if columns on TextDisplay
Wizo 0:bfb11ea418eb 45 * @result number of rows
Wizo 0:bfb11ea418eb 46 */
Wizo 0:bfb11ea418eb 47 virtual int columns() = 0;
Wizo 0:bfb11ea418eb 48
Wizo 0:bfb11ea418eb 49 // functions that come for free, but can be overwritten
Wizo 0:bfb11ea418eb 50
Wizo 0:bfb11ea418eb 51 /** redirect output from a stream (stoud, sterr) to display
Wizo 0:bfb11ea418eb 52 * @param stream stream that shall be redirected to the TextDisplay
Wizo 0:bfb11ea418eb 53 */
Wizo 0:bfb11ea418eb 54 virtual bool claim (FILE *stream);
Wizo 0:bfb11ea418eb 55
Wizo 0:bfb11ea418eb 56 /** clear screen
Wizo 0:bfb11ea418eb 57 */
Wizo 0:bfb11ea418eb 58 virtual void cls();
Wizo 0:bfb11ea418eb 59 virtual void locate(int column, int row);
Wizo 0:bfb11ea418eb 60 virtual void foreground(uint16_t colour);
Wizo 0:bfb11ea418eb 61 virtual void background(uint16_t colour);
Wizo 0:bfb11ea418eb 62 // putc (from Stream)
Wizo 0:bfb11ea418eb 63 // printf (from Stream)
Wizo 0:bfb11ea418eb 64
Wizo 0:bfb11ea418eb 65 protected:
Wizo 0:bfb11ea418eb 66
Wizo 0:bfb11ea418eb 67 virtual int _putc(int value);
Wizo 0:bfb11ea418eb 68 virtual int _getc();
Wizo 0:bfb11ea418eb 69
Wizo 0:bfb11ea418eb 70 // character location
Wizo 0:bfb11ea418eb 71 uint16_t _column;
Wizo 0:bfb11ea418eb 72 uint16_t _row;
Wizo 0:bfb11ea418eb 73
Wizo 0:bfb11ea418eb 74 // colours
Wizo 0:bfb11ea418eb 75 uint16_t _foreground;
Wizo 0:bfb11ea418eb 76 uint16_t _background;
Wizo 0:bfb11ea418eb 77 char *_path;
Wizo 0:bfb11ea418eb 78 };
Wizo 0:bfb11ea418eb 79
Wizo 0:bfb11ea418eb 80 #endif