Kamaelia docs : Kamaelia.UI.Pygame.Text.TextDisplayer

Kamaelia.UI.Pygame.Text.TextDisplayer

For examples and more explanations, see the module level docs.


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)

Inboxes

  • control : shutdown handling
  • _quitevents : user-generated quit events
  • _surface : for PygameDisplay to send surfaces to
  • inbox : for incoming lines of text

Outboxes

  • outbox : not used
  • signal : propagates out shutdown signals
  • _pygame : for sending requests to PygameDisplay

Methods defined here

Warning!

You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.

initPygame(self, **argd)

requests a display surface from the PygameDisplay service, fills the color in, and copies it

main(self)

Main loop

needShutdown(self)

Checks for control messages

update(self, text)

Updates text to the bottom of the screen while scrolling old text upwards. Delegates most of the work to updateLine

updateLine(self, line)

Updates one line of text to bottom of screen, scrolling old text upwards.

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT


Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)