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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.richtext.RichTextBox:
==========================================================================================================================================
|phoenix_title| **wx.richtext.RichTextBox**
==========================================================================================================================================
This class implements a floating or inline text box, containing paragraphs.
.. seealso:: :ref:`wx.richtext.RichTextParagraphLayoutBox`, :ref:`wx.richtext.RichTextObject`, :ref:`wx.richtext.RichTextBuffer`, :ref:`wx.richtext.RichTextCtrl`
|
|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>RichTextBox</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.richtext.RichTextBox_inheritance.png" alt="Inheritance diagram of RichTextBox" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.richtext.RichTextBox.html" title="wx.richtext.RichTextBox" alt="" coords="59,315,228,344"/> <area shape="rect" id="node2" href="wx.richtext.RichTextParagraphLayoutBox.html" title="wx.richtext.RichTextParagraphLayoutBox" alt="" coords="5,237,283,267"/> <area shape="rect" id="node3" href="wx.richtext.RichTextObject.html" title="wx.richtext.RichTextObject" alt="" coords="51,83,237,112"/> <area shape="rect" id="node5" href="wx.richtext.RichTextCompositeObject.html" title="wx.richtext.RichTextCompositeObject" alt="" coords="17,160,271,189"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="103,5,184,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.richtext.RichTextCell`, :ref:`wx.richtext.RichTextTable`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.richtext.RichTextBox.__init__` Default constructor; optionally pass the parent object.
:meth:`~wx.richtext.RichTextBox.CanEditProperties` Returns ``True`` if we can edit the object's properties via a GUI.
:meth:`~wx.richtext.RichTextBox.Clone` Clones the object.
:meth:`~wx.richtext.RichTextBox.Copy`
:meth:`~wx.richtext.RichTextBox.Draw` Draw the item, within the given range.
:meth:`~wx.richtext.RichTextBox.EditProperties` Edits the object's properties via a GUI.
:meth:`~wx.richtext.RichTextBox.GetPropertiesMenuLabel` Returns the label to be used for the properties context menu item.
:meth:`~wx.richtext.RichTextBox.GetXMLNodeName` Returns the ``XML`` node name of this object.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.richtext.RichTextBox.PropertiesMenuLabel` See :meth:`~wx.richtext.RichTextBox.GetPropertiesMenuLabel`
:attr:`~wx.richtext.RichTextBox.XMLNodeName` See :meth:`~wx.richtext.RichTextBox.GetXMLNodeName`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.richtext.RichTextBox(RichTextParagraphLayoutBox)
**Possible constructors**::
RichTextBox(parent=None)
RichTextBox(obj)
This class implements a floating or inline text box, containing
paragraphs.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, parent=None)`
Default constructor; optionally pass the parent object.
:param `parent`:
:type `parent`: wx.richtext.RichTextObject
**~~~**
**__init__** `(self, obj)`
Copy constructor.
:param `obj`:
:type `obj`: wx.richtext.RichTextBox
**~~~**
.. method:: CanEditProperties(self)
Returns ``True`` if we can edit the object's properties via a GUI.
:rtype: `bool`
.. method:: Clone(self)
Clones the object.
:rtype: :ref:`wx.richtext.RichTextObject`
.. method:: Copy(self, obj)
:param `obj`:
:type `obj`: wx.richtext.RichTextBox
.. method:: Draw(self, dc, context, range, selection, rect, descent, style)
Draw the item, within the given range.
Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
:param `dc`:
:type `dc`: wx.DC
:param `context`:
:type `context`: wx.richtext.RichTextDrawingContext
:param `range`:
:type `range`: wx.richtext.RichTextRange
:param `selection`:
:type `selection`: wx.richtext.RichTextSelection
:param `rect`:
:type `rect`: wx.Rect
:param `descent`:
:type `descent`: int
:param `style`:
:type `style`: int
:rtype: `bool`
.. method:: EditProperties(self, parent, buffer)
Edits the object's properties via a GUI.
:param `parent`:
:type `parent`: wx.Window
:param `buffer`:
:type `buffer`: wx.richtext.RichTextBuffer
:rtype: `bool`
.. method:: GetPropertiesMenuLabel(self)
Returns the label to be used for the properties context menu item.
:rtype: `string`
.. method:: GetXMLNodeName(self)
Returns the ``XML`` node name of this object.
This must be overridden for XmlNode-base ``XML`` export to work.
:rtype: `string`
.. attribute:: PropertiesMenuLabel
See :meth:`~wx.richtext.RichTextBox.GetPropertiesMenuLabel`
.. attribute:: XMLNodeName
See :meth:`~wx.richtext.RichTextBox.GetXMLNodeName`
|
