terminal.h

00001 /*
00002  * mbed LCDWindow library
00003 * Copyright (c) 2010 Hendrik Lipka
00004 * 
00005 * Permission is hereby granted, free of charge, to any person obtaining a copy
00006 * of this software and associated documentation files (the "Software"), to deal
00007 * in the Software without restriction, including without limitation the rights
00008 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00009 * copies of the Software, and to permit persons to whom the Software is
00010 * furnished to do so, subject to the following conditions:
00011 * 
00012 * The above copyright notice and this permission notice shall be included in
00013 * all copies or substantial portions of the Software.
00014 * 
00015 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00016 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00017 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00018 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00019 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00020 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00021 * THE SOFTWARE.
00022 */
00023 
00024 #ifndef TERMINAL_H_
00025 #define TERMINAL_H_
00026 
00027 #include "window.h"
00028 
00029 /**
00030  * A windows class which uses an internal buffer to provide automatic scrolling.
00031  * The buffer is initially filled with spaces.
00032 */
00033 class Terminal: public Window
00034 {
00035     public:
00036         /**
00037          * @param window the parent window
00038         */
00039         Terminal (Window* window);
00040         /**
00041          * works like the normal writeText method, 
00042          * but also stores the written text into the internal buffer (which makes it subject to scrolling)
00043         */
00044         virtual void writeText(const unsigned int column, const unsigned int row, const char text[]);
00045         /**
00046          * write the given text into the last line (at the first position)
00047          * @param text the text to write
00048         */
00049         virtual void addText(const char text[]);
00050         virtual int getColumns (){return _columns;};
00051         virtual int getRows (){return _rows;};
00052         virtual void clear();
00053         virtual void character(int column, int row, int c);
00054 
00055     private:
00056         Window* _window;
00057         char** _lineBuffer;
00058         unsigned int _columns;
00059         unsigned int _rows;
00060         char* createLine();
00061 };
00062 
00063 #endif