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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
.. 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.DrawObject:
==========================================================================================================================================
|phoenix_title| **wx.lib.floatcanvas.FCObjects.DrawObject**
==========================================================================================================================================
This is the base class for all the objects that can be drawn.
One must subclass from this (and an assortment of Mixins) to create
a new DrawObject, see for example :class:`~lib.floatcanvas.FloatCanvas.Circle`.
|
|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>DrawObject</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.DrawObject_inheritance.png" alt="Inheritance diagram of DrawObject" 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.DrawObject.html" title="wx.lib.floatcanvas.FCObjects.DrawObject" alt="" coords="5,5,295,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.floatcanvas.FCObjects.Arc`, :class:`wx.lib.floatcanvas.FCObjects.Arrow`, :class:`wx.lib.floatcanvas.FCObjects.ArrowLine`, :class:`wx.lib.floatcanvas.FCObjects.Bitmap`, :class:`wx.lib.floatcanvas.FCObjects.Circle`, :class:`wx.lib.floatcanvas.FCObjects.Group`, :class:`wx.lib.floatcanvas.FCObjects.Line`, :class:`wx.lib.floatcanvas.FCObjects.PieChart`, :class:`wx.lib.floatcanvas.FCObjects.Point`, :class:`wx.lib.floatcanvas.FCObjects.PointSet`, :class:`wx.lib.floatcanvas.FCObjects.Polygon`, :class:`wx.lib.floatcanvas.FCObjects.RectEllipse`, :class:`wx.lib.floatcanvas.FCObjects.ScaledBitmap`, :class:`wx.lib.floatcanvas.FCObjects.ScaledBitmap2`, :class:`wx.lib.floatcanvas.FCObjects.ScaledText`, :class:`wx.lib.floatcanvas.FCObjects.ScaledTextBox`, :class:`wx.lib.floatcanvas.FCObjects.SquarePoint`, :class:`wx.lib.floatcanvas.FCObjects.Text`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.__init__` Default class constructor.
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.Bind` Bind an event to the DrawObject
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.Hide` Hide the object.
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.PutInBackground` Put the object in the background.
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.PutInForeground` Put the object in the foreground.
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.SetBrush` Set the brush for this DrawObject
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.SetColor` Set the Color - this method is overridden in the subclasses
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.SetFillColor` Set the FillColor - this method is overridden in the subclasses
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.SetFillStyle` Set the FillStyle - this method is overridden in the subclasses
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.SetHitBrush` Set the brush used for hit test, do not call directly.
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.SetHitPen` Set the pen used for hit test, do not call directly.
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.SetLineColor` Set the LineColor - this method is overridden in the subclasses
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.SetLineStyle` Set the LineStyle - this method is overridden in the subclasses
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.SetLineWidth` Set the LineWidth
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.SetPen` Set the Pen for this DrawObject
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.Show` Show the object.
:meth:`~wx.lib.floatcanvas.FCObjects.DrawObject.UnBindAll` Unbind all events
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: DrawObject
This is the base class for all the objects that can be drawn.
One must subclass from this (and an assortment of Mixins) to create
a new DrawObject, see for example :class:`~lib.floatcanvas.FloatCanvas.Circle`.
.. method:: __init__(self, InForeground = False, IsVisible = True)
Default class constructor.
:param boolean `InForeground`: Define if object should be in foreground
or not
:param boolean `IsVisible`: Define if object should be visible
.. method:: Bind(self, Event, CallBackFun)
Bind an event to the DrawObject
:param `Event`: see below for supported event types
- EVT_FC_LEFT_DOWN
- EVT_FC_LEFT_UP
- EVT_FC_LEFT_DCLICK
- EVT_FC_MIDDLE_DOWN
- EVT_FC_MIDDLE_UP
- EVT_FC_MIDDLE_DCLICK
- EVT_FC_RIGHT_DOWN
- EVT_FC_RIGHT_UP
- EVT_FC_RIGHT_DCLICK
- EVT_FC_ENTER_OBJECT
- EVT_FC_LEAVE_OBJECT
:param `CallBackFun`: the call back function for the event
.. method:: Hide(self)
Hide the object.
.. method:: PutInBackground(self)
Put the object in the background.
.. method:: PutInForeground(self)
Put the object in the foreground.
.. method:: SetBrush(self, FillColor, FillStyle)
Set the brush for this DrawObject
:param `FillColor`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
for valid entries
:param `FillStyle`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetFillStyle`
for valid entries
.. method:: SetColor(self, Color)
Set the Color - this method is overridden in the subclasses
:param `Color`: use one of the following values any valid entry from
:class:`wx.ColourDatabase`
- ``Green``
- ``White``
- ``Black``
- ``Grey``
- ``MediumGrey``
- ``LightGrey``
- ``Cyan``
- ``Red``
.. method:: SetFillColor(self, FillColor)
Set the FillColor - this method is overridden in the subclasses
:param `FillColor`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
for valid values
.. method:: SetFillStyle(self, FillStyle)
Set the FillStyle - this method is overridden in the subclasses
:param string `FillStyle`: following is a list of valid values:
===================== =========================================
Style Description
===================== =========================================
``Transparent`` Transparent fill
``Solid`` Solid fill
``BiDiagonalHatch`` Bi Diagonal hatch fill
``CrossDiagHatch`` Cross Diagonal hatch fill
``FDiagonal_Hatch`` F Diagonal hatch fill
``CrossHatch`` Cross hatch fill
``HorizontalHatch`` Horizontal hatch fill
``VerticalHatch`` Vertical hatch fill
===================== =========================================
.. method:: SetHitBrush(self, HitColor)
Set the brush used for hit test, do not call directly.
:param `HitColor`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
.. method:: SetHitPen(self, HitColor, LineWidth)
Set the pen used for hit test, do not call directly.
:param `HitColor`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
:param integer `LineWidth`: the line width in pixels
.. method:: SetLineColor(self, LineColor)
Set the LineColor - this method is overridden in the subclasses
:param `LineColor`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
for valid values
.. method:: SetLineStyle(self, LineStyle)
Set the LineStyle - this method is overridden in the subclasses
:param `LineStyle`: Use one of the following values or ``None`` :
===================== =============================
Style Description
===================== =============================
``Solid`` Solid line
``Transparent`` A transparent line
``Dot`` Dotted line
``LongDash`` Dashed line (long)
``ShortDash`` Dashed line (short)
``DotDash`` Dash-dot-dash line
===================== =============================
.. method:: SetLineWidth(self, LineWidth)
Set the LineWidth
:param integer `LineWidth`: sets the line width in pixel
.. method:: SetPen(self, LineColor, LineStyle, LineWidth)
Set the Pen for this DrawObject
:param `LineColor`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetColor`
for valid entries
:param `LineStyle`: see :meth:`~lib.floatcanvas.FloatCanvas.DrawObject.SetLineStyle`
for valid entries
:param integer `LineWidth`: the width in pixels
.. method:: Show(self)
Show the object.
.. method:: UnBindAll(self)
Unbind all events
.. note:: Currently only removes one from each list
|
