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

Embed: (wiki syntax)

« Back to documentation index

TextLCDAdapter Class Reference
Public Member Functions

TextLCDAdapter Class Reference

adapter class to wrap a TextLCD instance as Window More...

#include <textlcdadapter.h>

Inherits Window.

Public Member Functions

virtual void clear ()
 clears the window
virtual int getRows ()
virtual int getColumns ()
virtual void character (int column, int row, int c)
 writes a character to the specified position must be public because it is used during delegation
int putc (int c)
 Write a character to the LCD, on the position specified by the cursor sets the cursor to the next position, and wraps (from right to left, next line, and from bottom back to top)
int printf (const char *format,...)
 Write a formated string to the LCD, on the position specified by the cursor does wrap around (as specified by putc)
virtual void writeText (const unsigned int column, const unsigned int row, const char text[])=0
 write text into the window, at the given position.
virtual void locate (int column, int row)
 set (internal) cursor to a screen column and row

Detailed Description

adapter class to wrap a TextLCD instance as Window

Definition at line 32 of file textlcdadapter.h.

Member Function Documentation

void character ( int  column,
int  row,
int  c 
) [virtual]

writes a character to the specified position must be public because it is used during delegation

Parameters:
columnThe horizontal position from the left, indexed from 0
rowThe vertical position from the top, indexed from 0
cthe character

Implements Window.

Definition at line 41 of file textlcdadapter.cpp.

void clear (  ) [virtual]

clears the window

Implements Window.

Definition at line 31 of file textlcdadapter.cpp.

int getColumns (  ) [virtual]
Parameters:
returnsthe width of the window

Implements Window.

Definition at line 38 of file textlcdadapter.cpp.

int getRows (  ) [virtual]
Parameters:
returnsthe height of the window

Implements Window.

Definition at line 35 of file textlcdadapter.cpp.

void locate ( int  column,
int  row 
) [virtual, inherited]

set (internal) cursor to a screen column and row

Parameters:
columnThe horizontal position from the left, indexed from 0
rowThe vertical position from the top, indexed from 0

Definition at line 26 of file window.cpp.

int printf ( const char *  format,
  ... 
)

Write a formated string to the LCD, on the position specified by the cursor does wrap around (as specified by putc)

Parameters:
formatA printf-style format string, followed by the variables to use in formating the string.

Reimplemented from Window.

Definition at line 47 of file textlcdadapter.cpp.

int putc ( int  c )

Write a character to the LCD, on the position specified by the cursor sets the cursor to the next position, and wraps (from right to left, next line, and from bottom back to top)

Parameters:
cThe character to write to the display

Reimplemented from Window.

Definition at line 44 of file textlcdadapter.cpp.

virtual void writeText ( const unsigned int  column,
const unsigned int  row,
const char  text[] 
) [pure virtual, inherited]

write text into the window, at the given position.

this doesn't change the internal cursor position Implementations should check for the length of the text and shorten it accordingly. columns the column where to write row the line where to write text the text to write

Implemented in DogmLCDSPI, HD44780LCD8bit, KS0108LCD8bit, MultiWindow, SED1335TextLCD, SubWindow, TeeWindow, and Terminal.

Generated on Tue Jul 12 2022 20:45:22 by  doxygen 1.7.2