subwindow.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 SUBWINDOW_H_
00025 #define SUBWINDOW_H_
00026 
00027 #include "window.h"
00028 
00029 /**
00030  * A window class using only a part of a parent window for output.
00031  * It is assumed that the sub window fill fit into the parent.
00032 */
00033 class SubWindow: public Window
00034 {
00035     public:
00036         /**
00037          * It is assumed that the sub window fill fit into the parent.
00038          * @param lcd the parent window
00039          * @param columnOffset in which column to start the sub window
00040          * @param rowOffset in which line to start the sub window
00041          * @param columns the width of the sub window
00042          * @param rows the height of the sub window
00043         */
00044         SubWindow(Window* lcd, const unsigned int columnOffset, const unsigned int rowOffset, const unsigned int columns, const unsigned int rows);
00045         virtual void writeText(const unsigned int column, const unsigned int row, const char text[]);
00046         virtual int getColumns (){return _columns;};
00047         virtual int getRows (){return _rows;};
00048         /**
00049          * clear the part of the parent window which is spanned by the sub window.
00050         */
00051         virtual void clear();
00052         virtual void character(int column, int row, int c);
00053 
00054     private:
00055         Window* _lcd;
00056         unsigned int _columnOffset;
00057         unsigned int _rowOffset;
00058         unsigned int _columns;
00059         unsigned int _rows;
00060 };
00061 
00062 #endif