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
|
.. 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
.. _wx.TextDataObject:
==========================================================================================================================================
|phoenix_title| **wx.TextDataObject**
==========================================================================================================================================
:ref:`wx.TextDataObject` is a specialization of :ref:`wx.DataObjectSimple` for text data.
It can be used without change to paste data into the :ref:`wx.Clipboard` or a :ref:`wx.DropSource`. A user may wish to derive a new class from this class for providing text on-demand in order to minimize memory consumption when offering data in several formats, such as plain text and ``RTF`` because by default the text is stored in a string in this class, but it might as well be generated when requested. For this, :meth:`~wx.TextDataObject.GetTextLength` and :meth:`~wx.TextDataObject.GetText` will have to be overridden.
Note that if you already have the text inside a string, you will not achieve any efficiency gain by overriding these functions because copying Strings is already a very efficient operation (data is not actually copied because Strings are reference counted).
.. seealso:: :ref:`Drag and Drop Overview <drag and drop overview>`, :ref:`wx.DataObject`, :ref:`wx.DataObjectSimple`, :ref:`wx.FileDataObject`, :ref:`wx.BitmapDataObject`
|
|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>TextDataObject</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.TextDataObject_inheritance.png" alt="Inheritance diagram of TextDataObject" 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.TextDataObject.html" title="wx.TextDataObject" alt="" coords="14,160,159,189"/> <area shape="rect" id="node2" href="wx.DataObjectSimple.html" title="wx.DataObjectSimple" alt="" coords="5,83,168,112"/> <area shape="rect" id="node3" href="wx.DataObject.html" title="wx.DataObject" alt="" coords="27,5,146,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.TextDataObject.__init__` Constructor, may be used to initialise the text (otherwise :meth:`~TextDataObject.SetText` should be used later).
:meth:`~wx.TextDataObject.GetAllFormats` Returns a list of wx.DataFormat objects which this data object
:meth:`~wx.TextDataObject.GetFormat` Returns the preferred format supported by this object.
:meth:`~wx.TextDataObject.GetFormatCount` Returns 2 under Mac and wxGTK, where text data coming from the clipboard may be provided as ``ANSI`` ( ``DF_TEXT`` ) or as Unicode text ( ``DF_UNICODETEXT`` , but only when ``USE_UNICODE==1`` ).
:meth:`~wx.TextDataObject.GetText` Returns the text associated with the data object.
:meth:`~wx.TextDataObject.GetTextLength` Returns the data size.
:meth:`~wx.TextDataObject.SetData`
:meth:`~wx.TextDataObject.SetText` Sets the text associated with the data object.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.TextDataObject.AllFormats` See :meth:`~wx.TextDataObject.GetAllFormats`
:attr:`~wx.TextDataObject.Format` See :meth:`~wx.TextDataObject.GetFormat`
:attr:`~wx.TextDataObject.FormatCount` See :meth:`~wx.TextDataObject.GetFormatCount`
:attr:`~wx.TextDataObject.Text` See :meth:`~wx.TextDataObject.GetText` and :meth:`~wx.TextDataObject.SetText`
:attr:`~wx.TextDataObject.TextLength` See :meth:`~wx.TextDataObject.GetTextLength`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.TextDataObject(DataObjectSimple)
**Possible constructors**::
TextDataObject(text=EmptyString)
TextDataObject is a specialization of DataObjectSimple for text
data.
.. method:: __init__(self, text=EmptyString)
Constructor, may be used to initialise the text (otherwise :meth:`SetText` should be used later).
:param `text`:
:type `text`: string
.. method:: GetAllFormats(self, dir=DataObject.Get)
Returns a list of wx.DataFormat objects which this data object
supports transferring in the given direction.
.. method:: GetFormat(self)
Returns the preferred format supported by this object.
This is ``DF_TEXT`` or ``DF_UNICODETEXT`` depending on the platform and from the build mode (i.e. from ``USE_UNICODE`` ).
:rtype: :ref:`wx.DataFormat`
.. method:: GetFormatCount(self, dir=DataObject.Get)
Returns 2 under Mac and wxGTK, where text data coming from the clipboard may be provided as ``ANSI`` ( ``DF_TEXT`` ) or as Unicode text ( ``DF_UNICODETEXT`` , but only when ``USE_UNICODE==1`` ).
Returns 1 under other platforms (e.g. wxMSW) or when building in ``ANSI`` mode ( ``USE_UNICODE==0`` ).
:param `dir`:
:type `dir`: DataObject.Direction
:rtype: `int`
.. method:: GetText(self)
Returns the text associated with the data object.
You may wish to override this method when offering data on-demand, but this is not required by wxWidgets' internals. Use this method to get data in text form from the :ref:`wx.Clipboard`.
:rtype: `string`
.. method:: GetTextLength(self)
Returns the data size.
By default, returns the size of the text data set in the constructor or using :meth:`SetText` . This can be overridden to provide text size data on-demand. It is recommended to return the text length plus 1 for a trailing zero, but this is not strictly required.
:rtype: `int`
.. method:: SetData(self, format, buf)
:rtype: `bool`
.. method:: SetText(self, strText)
Sets the text associated with the data object.
This method is called when the data object receives the data and, by default, copies the text into the member variable. If you want to process the text on the fly you may wish to override this function.
:param `strText`:
:type `strText`: string
.. attribute:: AllFormats
See :meth:`~wx.TextDataObject.GetAllFormats`
.. attribute:: Format
See :meth:`~wx.TextDataObject.GetFormat`
.. attribute:: FormatCount
See :meth:`~wx.TextDataObject.GetFormatCount`
.. attribute:: Text
See :meth:`~wx.TextDataObject.GetText` and :meth:`~wx.TextDataObject.SetText`
.. attribute:: TextLength
See :meth:`~wx.TextDataObject.GetTextLength`
|
