Table Of Contents

Previous topic

ticker

Next topic

ticker_xrc

This Page

phoenix_title Ticker


class_hierarchy Inheritance Diagram

Inheritance diagram for class Ticker

Inheritance diagram of Ticker


super_classes Known Superclasses

PyControl


method_summary Methods Summary

__init__  
AcceptsFocus Non-interactive, so don’t accept focus
DoGetBestSize Width we don’t care about, height is either -1, or the character
DrawText Draws the ticker text at the current offset using the provided DC
GetDirection  
GetFPS Update speed of the ticker
GetPPF Pixels per frame
GetText  
IsTicking Is the ticker ticking? ie, is the text moving?
OnErase Noop because of double buffering
OnPaint  
OnTick  
SetDirection Sets the direction of the ticker: right to left(rtl) or left to right (ltr)
SetFont  
SetFPS Adjust the update speed of the ticker
SetPPF Set the number of pixels per frame the ticker moves - ie, how “jumpy” it is
SetText Set the ticker text.
ShouldInheritColours Don’t get colours from our parent...
Start Starts the text moving
Stop Stop moving the text
UpdateExtent Updates the cached text extent if needed

api Class API



class Ticker(PyControl)

Methods



__init__(self, parent, id=-1, text='', fgcolor = BLACK, bgcolor = WHITE, start=True, ppf=2, fps=20, direction="rtl", pos=DefaultPosition, size=DefaultSize, style=NO_BORDER, name="Ticker")


AcceptsFocus(self)

Non-interactive, so don’t accept focus



DoGetBestSize(self)

Width we don’t care about, height is either -1, or the character height of our text with a little extra padding



DrawText(self, dc)

Draws the ticker text at the current offset using the provided DC



GetDirection(self)


GetFPS(self)

Update speed of the ticker



GetPPF(self)

Pixels per frame



GetText(self)


IsTicking(self)

Is the ticker ticking? ie, is the text moving?



OnErase(self, evt)

Noop because of double buffering



OnPaint(self, evt)


OnTick(self, evt)


SetDirection(self, dir)

Sets the direction of the ticker: right to left(rtl) or left to right (ltr)



SetFont(self, font)


SetFPS(self, fps)

Adjust the update speed of the ticker



SetPPF(self, ppf)

Set the number of pixels per frame the ticker moves - ie, how “jumpy” it is



SetText(self, text)

Set the ticker text.



ShouldInheritColours(self)

Don’t get colours from our parent...



Start(self)

Starts the text moving



Stop(self)

Stop moving the text



UpdateExtent(self, dc)

Updates the cached text extent if needed