TINF_6ABEL18 / Mbed 2 deprecated TINF_Test1_7ABELI

7ABELI_Projekt

Dependencies:   mbed

C12832/TextDisplay.h@0:b69a47c4639b, 2018-11-29 (annotated)

Committer:
Wizo
Date:
Thu Nov 29 17:17:23 2018 +0000
Revision:
0:b69a47c4639b
7ABELI_Projekt

Who changed what in which revision?

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