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
|
.. 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.StreamBase:
==========================================================================================================================================
|phoenix_title| **wx.StreamBase**
==========================================================================================================================================
This class is the base class of most stream related classes in wxWidgets.
It must not be used directly.
.. seealso:: :ref:`StreamBuffer`
|
|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>StreamBase</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.StreamBase_inheritance.png" alt="Inheritance diagram of StreamBase" 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.StreamBase.html" title="wx.StreamBase" alt="" coords="5,5,128,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.InputStream`, :ref:`wx.OutputStream`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.StreamBase.__init__` Creates a dummy stream object.
:meth:`~wx.StreamBase.GetLastError` This function returns the last error.
:meth:`~wx.StreamBase.GetLength` Returns the length of the stream in bytes.
:meth:`~wx.StreamBase.GetSize` This function returns the size of the stream.
:meth:`~wx.StreamBase.IsOk` Returns ``True`` if no error occurred on the stream.
:meth:`~wx.StreamBase.IsSeekable` Returns ``True`` if the stream supports seeking to arbitrary offsets.
:meth:`~wx.StreamBase.Reset` Resets the stream state.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.StreamBase.LastError` See :meth:`~wx.StreamBase.GetLastError`
:attr:`~wx.StreamBase.Length` See :meth:`~wx.StreamBase.GetLength`
:attr:`~wx.StreamBase.Size` See :meth:`~wx.StreamBase.GetSize`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.StreamBase(object)
**Possible constructors**::
StreamBase()
This class is the base class of most stream related classes in
wxWidgets.
.. method:: __init__(self)
Creates a dummy stream object.
It doesn't do anything.
.. method:: GetLastError(self)
This function returns the last error.
:rtype: :ref:`wx.StreamError`
.. method:: GetLength(self)
Returns the length of the stream in bytes.
If the length cannot be determined (this is always the case for socket streams for example), returns :meth:`InvalidOffset` .
:rtype: :ref:`wx.FileOffset`
.. versionadded:: 2.5.4
.. method:: GetSize(self)
This function returns the size of the stream.
For example, for a file it is the size of the file.
:rtype: `int`
.. warning:: There are streams which do not have size by definition, such as socket streams. In that cases, :meth:`GetSize` returns 0 so you should always test its return value.
.. method:: IsOk(self)
Returns ``True`` if no error occurred on the stream.
:rtype: `bool`
.. seealso:: :meth:`GetLastError`
.. method:: IsSeekable(self)
Returns ``True`` if the stream supports seeking to arbitrary offsets.
:rtype: `bool`
.. method:: Reset(self, error=STREAM_NO_ERROR)
Resets the stream state.
By default, resets the stream to good state, i.e. clears any errors. Since wxWidgets 2.9.3 can be also used to explicitly set the state to the specified error (the `error` argument didn't exist in the previous versions).
:param `error`:
:type `error`: wx.StreamError
.. seealso:: :meth:`GetLastError`
.. attribute:: LastError
See :meth:`~wx.StreamBase.GetLastError`
.. attribute:: Length
See :meth:`~wx.StreamBase.GetLength`
.. attribute:: Size
See :meth:`~wx.StreamBase.GetSize`
|
