.. include:: headings.inc

.. module:: lib.fancytext

.. currentmodule:: lib.fancytext

.. highlight:: python



.. _lib.fancytext:

==========================================================================================================================================
|phoenix_title|  **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()



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for module **fancytext**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.fancytext_inheritance.png" alt="Inheritance diagram of fancytext" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.fancytext.StaticFancyText.html" title="fancytext.StaticFancyText" alt="" coords="1019,111,1227,142"/> <area shape="rect" id="node2" href="StaticBitmap.html" title="A static bitmap control displays a bitmap." alt="" coords="857,111,969,142"/> <area shape="rect" id="node4" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="604,111,684,142"/> <area shape="rect" id="node8" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="733,111,808,142"/> <area shape="rect" id="node5" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="455,111,553,142"/> <area shape="rect" id="node7" href="lib.fancytext.Renderer.html" title="Class for rendering XML marked up text." alt="" coords="5,31,165,62"/> <area shape="rect" id="node10" href="lib.fancytext.SizeRenderer.html" title="Processes text as if rendering it, but just computes the size." alt="" coords="213,5,405,35"/> <area shape="rect" id="node13" href="lib.fancytext.DCRenderer.html" title="Renders text to a wxPython device context DC." alt="" coords="217,58,401,89"/> <area shape="rect" id="node15" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="273,111,345,142"/> </map> 
   </p>

|


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~lib.fancytext.GetExtent`                                                 Return the extent of str
:func:`~lib.fancytext.GetFullExtent`                                             
:func:`~lib.fancytext.iceil`                                                     
:func:`~lib.fancytext.iround`                                                    
:func:`~lib.fancytext.RenderToBitmap`                                            Return str rendered on a minumum size bitmap
:func:`~lib.fancytext.RenderToDC`                                                Render str onto a wxDC at (x,y)
:func:`~lib.fancytext.RenderToRenderer`                                          
:func:`~lib.fancytext.test`                                                      
================================================================================ ================================================================================


|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`lib.fancytext.DCRenderer`                                                  Renders text to a wxPython device context DC.
:ref:`lib.fancytext.Renderer`                                                    Class for rendering XML marked up text.
:ref:`lib.fancytext.SizeRenderer`                                                Processes text as if rendering it, but just computes the size.
:ref:`lib.fancytext.StaticFancyText`                                             
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   lib.fancytext.DCRenderer
   lib.fancytext.Renderer
   lib.fancytext.SizeRenderer
   lib.fancytext.StaticFancyText





Functions
------------

.. function:: GetExtent(str, dc=None, enclose=True)

   Return the extent of str


.. function:: GetFullExtent(str, dc=None, enclose=True)


.. function:: iceil(number)


.. function:: iround(number)


.. function:: RenderToBitmap(str, background=None, enclose=1)

   Return str rendered on a minumum size bitmap


.. function:: RenderToDC(str, dc, x, y, enclose=1)

   Render str onto a wxDC at (x,y)


.. function:: RenderToRenderer(str, renderer, enclose=True)


.. function:: test()