MHVLib  20111011
An efficiency oriented runtime library for AVR microcontrollers
A:/eclipse/mhvlib/MHV_Display_Character.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2011, Make, Hack, Void Inc
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *  * Redistributions of source code must retain the above copyright
00008  *    notice, this list of conditions and the following disclaimer.
00009  *  * Redistributions in binary form must reproduce the above copyright
00010  *    notice, this list of conditions and the following disclaimer in the
00011  *    documentation and/or other materials provided with the distribution.
00012  *  * Neither the name of the Make, Hack, Void nor the
00013  *    names of its contributors may be used to endorse or promote products
00014  *    derived from this software without specific prior written permission.
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00017  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00018  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00019  * DISCLAIMED. IN NO EVENT SHALL MAKE, HACK, VOID BE LIABLE FOR ANY
00020  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00021  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00022  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00023  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00024  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00025  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026  */
00027 #ifndef MHV_DISPLAY_CHARACTER_H_
00028 #define MHV_DISPLAY_CHARACTER_H_
00029 
00030 #include <MHV_Device_TX.h>
00031 
00032 class MHV_Display_Character : public MHV_Device_TX {
00033 protected:
00034         uint16_t                _rowCount;
00035         uint16_t                _colCount;
00036         int16_t                 _txOffset;
00037         uint16_t                _currentRow;
00038         uint16_t                _currentCol;
00039         bool                    _wrap;
00040         bool                    _scroll;
00041 
00042 
00043 public:
00044         MHV_Display_Character(uint16_t cols, uint16_t rows, MHV_RingBuffer *txBuffer);
00045         void writeChar(char character);
00046         void scrollVertically();
00047         void setCursor(uint16_t col, uint16_t row);
00048         void runTxBuffers();
00049         bool txAnimation(uint16_t row);
00050         uint8_t getWidth();
00051         uint8_t getHeight();
00052         bool writeString(int16_t *offsetX, uint16_t offsetY, const char *string);
00053         bool writeBuffer(int16_t *offsetX, uint16_t offsetY, const char *buffer, uint16_t length);
00054         bool writeString_P(int16_t *offsetX, uint16_t offsetY, PGM_P string);
00055         bool writeBuffer_P(int16_t *offsetX, uint16_t offsetY, PGM_P buffer, uint16_t length);
00056         void setWrap(bool shouldWrap);
00057         void setScroll(bool shouldScroll);
00058 // Subclasses must implement these
00059         virtual void _writeChar(char character)=0;
00060         virtual char _readChar()=0;
00061         virtual void _setCursor(uint16_t col, uint16_t row)=0;
00062         virtual void clear()=0;
00063 };
00064 
00065 #endif /* MHV_HD44780_H_ */