1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
.. 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
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>Text</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.floatcanvas.FCObjects.Text_inheritance.png" alt="Inheritance diagram of Text" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.floatcanvas.FCObjects.Text.html" title="wx.lib.floatcanvas.FCObjects.Text" alt="" coords="208,160,448,189"/> <area shape="rect" id="node2" href="wx.lib.floatcanvas.FCObjects.TextObjectMixin.html" title="wx.lib.floatcanvas.FCObjects.TextObjectMixin" alt="" coords="5,83,323,112"/> <area shape="rect" id="node3" href="wx.lib.floatcanvas.FCObjects.DrawObject.html" title="wx.lib.floatcanvas.FCObjects.DrawObject" alt="" coords="347,83,637,112"/> <area shape="rect" id="node4" href="wx.lib.floatcanvas.FCObjects.XYObjectMixin.html" title="wx.lib.floatcanvas.FCObjects.XYObjectMixin" alt="" coords="11,5,317,35"/> </map>
</p>
</div>
|
|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 <http://www.numpy.org/>`_ 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
|
