Kamaelia docs : Kamaelia.Util.Chooser.Chooser

Kamaelia.Util.Chooser.Chooser

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

class Chooser(Axon.Component.component)

Chooser([items]) -> new Chooser component.

Iterates through a finite list of items. Step by sending "NEXT", "PREV", "FIRST" or "LAST" messages to its "inbox" inbox.

Keyword arguments:

items -- list of items to be chosen from, must be type 'list' (default=[])

Inboxes

control : shutdown messages
inbox : receive commands

Outboxes

outbox : emits chosen items
signal : shutdown messages

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.

init(self[, items])

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

getCurrentChoice(self)

Return the current choice to the outbox

gotoFirst(self)

Goto the first item in the set. Returns True.

gotoLast(self)

Goto the last item in the set. Returns True.

gotoNext(self)

Advance the choice forwards one.

Returns True if successful or False if unable to (eg. already at end).

gotoPrev(self)

Backstep the choice backwards one.

Returns True if successful or False if unable to (eg. already at start).

main(self)

Main loop.

shutdown(self)

Returns True if a shutdownMicroprocess message was received.

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, 12 Oct 2008 at 03:01:28 UTC/GMT

(C) 2005 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved,
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.