Package wx :: Package lib :: Module fancytext
[frames | no frames]

Module wx.lib.fancytext

FancyText -- methods for rendering XML specified text

This module exports four main methods:

def GetExtent(str, dc=None, enclose=True)
def GetFullExtent(str, dc=None, enclose=True)
def RenderToBitmap(str, background=None, enclose=True)
def RenderToDC(str, dc, x, y, enclose=True)

In all cases, 'str' is an XML string. Note that start and end tags are only required if enclose is set to False. In this case the text should be wrapped in FancyText tags.

In addition, the module exports one class:

class StaticFancyText(self, window, id, text, background, ...)

This class works similar to StaticText except it interprets its text as FancyText.

The text can support superscripts and subscripts, text in different sizes, colors, styles, weights and families. It also supports a limited set of symbols, currently times, infinity, angle as well as greek letters in both upper case (Alpha Beta... Omega) and lower case (alpha beta... omega).

>>> frame = wx.Frame(wx.NULL, -1, "FancyText demo", wx.DefaultPosition)
>>> sft = StaticFancyText(frame, -1, testText, wx.Brush("light grey", wx.SOLID))
>>> frame.SetClientSize(sft.GetSize())
>>> didit = frame.Show()
>>> from guitest import PauseTests; PauseTests()

Classes
StaticFancyText  

Function Summary
  getExtent(str, dc, enclose)
Return the extent of str
  GetExtent(str, dc, enclose)
Return the extent of str
  GetFullExtent(str, dc, enclose)
  renderToBitmap(str, background, enclose)
Return str rendered on a minumum size bitmap
  RenderToBitmap(str, background, enclose)
Return str rendered on a minumum size bitmap
  RenderToDC(str, dc, x, y, enclose)
Render str onto a wxDC at (x,y)
  renderToDC(str, dc, x, y, enclose)
Render str onto a wxDC at (x,y)

Function Details

getExtent(str, dc=None, enclose=True)

Return the extent of str

GetExtent(str, dc=None, enclose=True)

Return the extent of str

renderToBitmap(str, background=None, enclose=1)

Return str rendered on a minumum size bitmap

RenderToBitmap(str, background=None, enclose=1)

Return str rendered on a minumum size bitmap

RenderToDC(str, dc, x, y, enclose=1)

Render str onto a wxDC at (x,y)

renderToDC(str, dc, x, y, enclose=1)

Render str onto a wxDC at (x,y)


Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:54:33 2009 http://epydoc.sf.net