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
|
.. 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.URLDataObject:
==========================================================================================================================================
|phoenix_title| **wx.URLDataObject**
==========================================================================================================================================
:ref:`wx.URLDataObject` is a :ref:`wx.DataObject` containing an URL and can be used e.g.
when you need to put an URL on or retrieve it from the clipboard:
::
wx.TheClipboard.SetData(wx.URLDataObject(url))
.. note::
This class is derived from :ref:`wx.DataObjectComposite` on Windows rather than :ref:`wx.TextDataObject` on all other platforms.
.. seealso:: :ref:`Drag and Drop Overview <drag and drop overview>`, :ref:`wx.DataObject`
|
|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>URLDataObject</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.URLDataObject_inheritance.png" alt="Inheritance diagram of URLDataObject" 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.DataObjectSimple.html" title="wx.DataObjectSimple" alt="" coords="5,83,163,112"/> <area shape="rect" id="node4" href="wx.TextDataObject.html" title="wx.TextDataObject" alt="" coords="15,160,153,189"/> <area shape="rect" id="node2" href="wx.DataObject.html" title="wx.DataObject" alt="" coords="27,5,141,35"/> <area shape="rect" id="node3" href="wx.URLDataObject.html" title="wx.URLDataObject" alt="" coords="15,237,153,267"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.URLDataObject.__init__` Constructor, may be used to initialize the URL.
:meth:`~wx.URLDataObject.GetAllFormats` Returns a list of wx.DataFormat objects which this data object
:meth:`~wx.URLDataObject.GetURL` Returns the URL stored by this object, as a string.
:meth:`~wx.URLDataObject.SetData`
:meth:`~wx.URLDataObject.SetURL` Sets the URL stored by this object.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.URLDataObject.AllFormats` See :meth:`~wx.URLDataObject.GetAllFormats`
:attr:`~wx.URLDataObject.URL` See :meth:`~wx.URLDataObject.GetURL` and :meth:`~wx.URLDataObject.SetURL`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.URLDataObject(DataObject)
**Possible constructors**::
URLDataObject(url=EmptyString)
URLDataObject is a DataObject containing an URL and can be used
e.g.
.. method:: __init__(self, url=EmptyString)
Constructor, may be used to initialize the URL.
If `url` is empty, :meth:`SetURL` can be used later.
:param `url`:
:type `url`: 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:: GetURL(self)
Returns the URL stored by this object, as a string.
:rtype: `string`
.. method:: SetData(self, format, buf)
:rtype: `bool`
.. method:: SetURL(self, url)
Sets the URL stored by this object.
:param `url`:
:type `url`: string
.. attribute:: AllFormats
See :meth:`~wx.URLDataObject.GetAllFormats`
.. attribute:: URL
See :meth:`~wx.URLDataObject.GetURL` and :meth:`~wx.URLDataObject.SetURL`
|
