.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.floatcanvas.FCObjects
.. highlight:: python
.. _wx.lib.floatcanvas.FCObjects.Text:
==========================================================================================================================================
|phoenix_title| **wx.lib.floatcanvas.FCObjects.Text**
==========================================================================================================================================
Draws a text object
The size is fixed, and does not scale with the drawing.
The hit-test is done on the entire text extent
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
Text:
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.floatcanvas.FCObjects.DrawObject`, :class:`wx.lib.floatcanvas.FCObjects.TextObjectMixin`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.floatcanvas.FCObjects.Text.__init__` Default class constructor.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: Text(TextObjectMixin, DrawObject)
Draws a text object
The size is fixed, and does not scale with the drawing.
The hit-test is done on the entire text extent
.. method:: __init__(self, String, xy, Size = 14, Color = "Black", BackgroundColor = None, Family = wx.FONTFAMILY_MODERN, Style = wx.FONTSTYLE_NORMAL, Weight = wx.FONTWEIGHT_NORMAL, Underlined = False, Position = 'tl', InForeground = False, Font = None)
Default class constructor.
:param string `string`: the text to draw
:param `XY`: the (x, y) coordinate of the corner of the text, or a 2-tuple,
or a (2,) `NumPy `_ array
:param `Size`: the font size
:param `Color`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
:param `BackgroundColor`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
:param wx.FontFamily `Family`: a valid :ref:`wx.FontFamily`
:param wx.FontStyle `Style`: a valid :ref:`wx.FontStyle`
:param wx.FontWeight `Weight`: a valid :ref:`wx.FontWeight`
:param boolean `Underlined`: underline the text
:param string `Position`: a two character string indicating where in
relation to the coordinates the box should be oriented
:param boolean `InForeground`: should object be in foreground
:param wx.Font `Font`: alternatively you can define :ref:`wx.Font` and the
above will be ignored.
============== ==========================
1st character Meaning
============== ==========================
``t`` top
``c`` center
``b`` bottom
============== ==========================
============== ==========================
2nd character Meaning
============== ==========================
``l`` left
``c`` center
``r`` right
============== ==========================
:param wx.Font `Font`: a valid :class:`wx.Font`
:param boolean `InForeground`: should object be in foreground