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
|
.. 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.RichTextObjectAddress:
==========================================================================================================================================
|phoenix_title| **wx.richtext.RichTextObjectAddress**
==========================================================================================================================================
A class for specifying an object anywhere in an object hierarchy, without using a pointer, necessary since ``RTC`` commands may delete and recreate sub-objects so physical object addresses change.
An array of positions (one per hierarchy level) is used.
.. seealso:: :ref:`wx.richtext.RichTextCommand`
|
|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>RichTextObjectAddress</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.RichTextObjectAddress_inheritance.png" alt="Inheritance diagram of RichTextObjectAddress" 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.RichTextObjectAddress.html" title="wx.richtext.RichTextObjectAddress" alt="" coords="5,5,243,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.richtext.RichTextObjectAddress.__init__` Creates the address given a container and an object.
:meth:`~wx.richtext.RichTextObjectAddress.Copy` Copies the address.
:meth:`~wx.richtext.RichTextObjectAddress.Create` Creates the address given a container and an object.
:meth:`~wx.richtext.RichTextObjectAddress.GetAddress` Returns the array of integers representing the object address.
:meth:`~wx.richtext.RichTextObjectAddress.GetObject` Returns the object specified by the address, given a top level container.
:meth:`~wx.richtext.RichTextObjectAddress.Init`
:meth:`~wx.richtext.RichTextObjectAddress.SetAddress` Sets the address from an array of integers.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.richtext.RichTextObjectAddress.Address` See :meth:`~wx.richtext.RichTextObjectAddress.GetAddress` and :meth:`~wx.richtext.RichTextObjectAddress.SetAddress`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.richtext.RichTextObjectAddress(object)
**Possible constructors**::
RichTextObjectAddress(topLevelContainer, obj)
RichTextObjectAddress()
RichTextObjectAddress(address)
A class for specifying an object anywhere in an object hierarchy,
without using a pointer, necessary since ``RTC`` commands may delete and
recreate sub-objects so physical object addresses change.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, topLevelContainer, obj)`
Creates the address given a container and an object.
:param `topLevelContainer`:
:type `topLevelContainer`: wx.richtext.RichTextParagraphLayoutBox
:param `obj`:
:type `obj`: wx.richtext.RichTextObject
**~~~**
**__init__** `(self)`
**~~~**
**__init__** `(self, address)`
:param `address`:
:type `address`: wx.richtext.RichTextObjectAddress
**~~~**
.. method:: Copy(self, address)
Copies the address.
:param `address`:
:type `address`: wx.richtext.RichTextObjectAddress
.. method:: Create(self, topLevelContainer, obj)
Creates the address given a container and an object.
:param `topLevelContainer`:
:type `topLevelContainer`: wx.richtext.RichTextParagraphLayoutBox
:param `obj`:
:type `obj`: wx.richtext.RichTextObject
:rtype: `bool`
.. method:: GetAddress(self)
Returns the array of integers representing the object address.
:rtype: `list of integers`
.. method:: GetObject(self, topLevelContainer)
Returns the object specified by the address, given a top level container.
:param `topLevelContainer`:
:type `topLevelContainer`: wx.richtext.RichTextParagraphLayoutBox
:rtype: :ref:`wx.richtext.RichTextObject`
.. method:: Init(self)
.. method:: SetAddress(self, address)
Sets the address from an array of integers.
:param `address`:
:type `address`: list of integers
.. attribute:: Address
See :meth:`~wx.richtext.RichTextObjectAddress.GetAddress` and :meth:`~wx.richtext.RichTextObjectAddress.SetAddress`
|
