Hendrik Lipka / LcdWindow

Display text on LCD displays (even on multiple ones). Allow to create windows (frames) on display, and to combine them (split, add, duplicate, scroll). See http://mbed.org/users/hlipka/notebook/lcdwindow/ for more information.

Dependents:   Mbell

window.h@1:65f72ed914fa, 2010-11-16 (annotated)

Committer:
hlipka
Date:
Tue Nov 16 20:49:18 2010 +0000
Revision:
1:65f72ed914fa
Parent:
0:ae5037e3d6e0
Child:
2:5ac5bab7daaf
minor revision: made use of \const\ in the API

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hlipka 0:ae5037e3d6e0 1 /*
hlipka 0:ae5037e3d6e0 2 * mbed LCDWindow library
hlipka 0:ae5037e3d6e0 3 * Copyright (c) 2010 Hendrik Lipka
hlipka 0:ae5037e3d6e0 4 *
hlipka 0:ae5037e3d6e0 5 * Permission is hereby granted, free of charge, to any person obtaining a copy
hlipka 0:ae5037e3d6e0 6 * of this software and associated documentation files (the "Software"), to deal
hlipka 0:ae5037e3d6e0 7 * in the Software without restriction, including without limitation the rights
hlipka 0:ae5037e3d6e0 8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
hlipka 0:ae5037e3d6e0 9 * copies of the Software, and to permit persons to whom the Software is
hlipka 0:ae5037e3d6e0 10 * furnished to do so, subject to the following conditions:
hlipka 0:ae5037e3d6e0 11 *
hlipka 0:ae5037e3d6e0 12 * The above copyright notice and this permission notice shall be included in
hlipka 0:ae5037e3d6e0 13 * all copies or substantial portions of the Software.
hlipka 0:ae5037e3d6e0 14 *
hlipka 0:ae5037e3d6e0 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
hlipka 0:ae5037e3d6e0 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
hlipka 0:ae5037e3d6e0 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
hlipka 0:ae5037e3d6e0 18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
hlipka 0:ae5037e3d6e0 19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
hlipka 0:ae5037e3d6e0 20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
hlipka 0:ae5037e3d6e0 21 * THE SOFTWARE.
hlipka 0:ae5037e3d6e0 22 */
hlipka 0:ae5037e3d6e0 23
hlipka 0:ae5037e3d6e0 24 #ifndef WINDOW_H_
hlipka 0:ae5037e3d6e0 25 #define WINDOW_H_
hlipka 0:ae5037e3d6e0 26
hlipka 0:ae5037e3d6e0 27 /**
hlipka 0:ae5037e3d6e0 28 * the base window class, which proves the interface for all common methods.
hlipka 0:ae5037e3d6e0 29 */
hlipka 0:ae5037e3d6e0 30 class Window
hlipka 0:ae5037e3d6e0 31 {
hlipka 0:ae5037e3d6e0 32 public:
hlipka 0:ae5037e3d6e0 33 /**
hlipka 0:ae5037e3d6e0 34 * write text into the window, at the given position.
hlipka 0:ae5037e3d6e0 35 * Implementations should check for the length of the text and shorten it accordingly.
hlipka 0:ae5037e3d6e0 36 * @params line the line where to write
hlipka 0:ae5037e3d6e0 37 * @params pos the column where to write
hlipka 0:ae5037e3d6e0 38 * @params text the text to write
hlipka 0:ae5037e3d6e0 39 */
hlipka 1:65f72ed914fa 40 virtual void writeText(const unsigned int line, const unsigned int pos, const char text[])=0;
hlipka 0:ae5037e3d6e0 41 /**
hlipka 0:ae5037e3d6e0 42 * @param returns the height of the window
hlipka 0:ae5037e3d6e0 43 */
hlipka 0:ae5037e3d6e0 44 virtual int getHeight()=0;
hlipka 0:ae5037e3d6e0 45 /**
hlipka 0:ae5037e3d6e0 46 * @param returns the width of the window
hlipka 0:ae5037e3d6e0 47 */
hlipka 0:ae5037e3d6e0 48 virtual int getWidth()=0;
hlipka 0:ae5037e3d6e0 49 /**
hlipka 0:ae5037e3d6e0 50 * clears the window
hlipka 0:ae5037e3d6e0 51 */
hlipka 0:ae5037e3d6e0 52 virtual void clear()=0;
hlipka 0:ae5037e3d6e0 53 };
hlipka 0:ae5037e3d6e0 54
hlipka 0:ae5037e3d6e0 55 #endif /*WINDOW_H_*/