Example Usage

To take user input in Textbox and display it in TextDisplayer:

Pipeline(Textbox(size = (800, 300),
                 position = (0,0)),
         TextDisplayer(size = (800, 300),
                       position = (0,340))
         ).run()

How does it work?

TextDisplayer requests a display from the Pygame Display service and requests that Pygame Display send all keypresses to it. Every time TextDisplayer receives a keypress, it updates its string buffer and the display.

If it receives a newline, or if text must wrap, it moves the existing text upwards and blits the new line onto the bottom.

Known issues

The line wrapping length is specified by the width of the display divided by the width of the letter 'a' in the displayed font, so lines may wrap too far off the edge of the screen if the user types very narrow text (i.e. just spaces with no other charachters), or too far inside the edge of the screen (usually).

class TextDisplayer(Axon.Component.component)

TextDisplayer(...) -> new TextDisplayer Pygame component.

Keyword arguments:

• size -- (w, h) size of the TextDisplayer surface, in pixels.

  Default (500, 300).

• text_height -- font size. Default 18.

• bgcolour -- tuple containing RGB values for the background color.

  Default is a pale yellow.

• fgcolour -- tuple containing RGB values for the text color.

  Default is black.

• position -- tuple containing x,y coordinates of the surface's

  upper left corner in relation to the Pygame window. Default (0,0)

class Textbox(TextDisplayer)

Textbox(...) -> New Pygame Textbox component

Keyword Arguments:

• Textbox inherits its keyword arguments from TextDisplayer. Please see TextDisplayer docs.

Reads keyboard input and updates it on the screen. Flushes string buffer and sends it to outbox when a newline is encountered.