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
|
.. 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.GIFHandler:
==========================================================================================================================================
|phoenix_title| **wx.GIFHandler**
==========================================================================================================================================
This is the image handler for the ``GIF`` format.
.. seealso:: :ref:`wx.Image`, :ref:`wx.ImageHandler`, :ref:`wx.InitAllImageHandlers`
|
|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>GIFHandler</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.GIFHandler_inheritance.png" alt="Inheritance diagram of GIFHandler" 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.Object.html" title="wx.Object" alt="" coords="29,5,111,35"/> <area shape="rect" id="node2" href="wx.ImageHandler.html" title="wx.ImageHandler" alt="" coords="5,83,136,112"/> <area shape="rect" id="node3" href="wx.GIFHandler.html" title="wx.GIFHandler" alt="" coords="15,160,125,189"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.GIFHandler.__init__` Default constructor for :ref:`wx.GIFHandler`.
:meth:`~wx.GIFHandler.DoCanRead` Called to test if this handler can read an image from the given stream.
:meth:`~wx.GIFHandler.LoadFile` Loads a image from a stream, putting the resulting data into `image`.
:meth:`~wx.GIFHandler.SaveAnimation` Save the animated gif.
:meth:`~wx.GIFHandler.SaveFile` Saves a image in the output stream.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.GIFHandler(ImageHandler)
**Possible constructors**::
GIFHandler()
This is the image handler for the ``GIF`` format.
.. method:: __init__(self)
Default constructor for :ref:`wx.GIFHandler`.
.. method:: DoCanRead(self, stream)
Called to test if this handler can read an image from the given stream.
``NOTE``: this function is allowed to change the current stream position since CallDoCanRead() will take care of restoring it later
:param `stream`:
:type `stream`: wx.InputStream
:rtype: `bool`
.. method:: LoadFile(self, image, stream, verbose=True, index=-1)
Loads a image from a stream, putting the resulting data into `image`.
If the image file contains more than one image and the image handler is capable of retrieving these individually, `index` indicates which image to read from the stream.
:param `image`: The image object which is to be affected by this operation.
:type `image`: wx.Image
:param `stream`: Opened input stream for reading image data.
:type `stream`: wx.InputStream
:param `verbose`: If set to ``True``, errors reported by the image handler will produce LogMessages.
:type `verbose`: bool
:param `index`: The index of the image in the file (starting from zero).
:type `index`: int
:rtype: `bool`
:returns:
``True`` if the operation succeeded, ``False`` otherwise.
.. seealso:: :meth:`wx.Image.LoadFile` , :meth:`wx.Image.SaveFile` , :meth:`SaveFile`
.. method:: SaveAnimation(self, images, stream, verbose=True, delayMilliSecs=1000)
Save the animated gif.
:param `images`: The image array object which is to be affected by this operation.
:type `images`: ImageArray
:param `stream`: Opened output stream for writing the data.
:type `stream`: wx.OutputStream
:param `verbose`: If set to ``True``, errors reported by the image handler will produce LogMessages
:type `verbose`: bool
:param `delayMilliSecs`: How long, in milliseconds, to wait between each frame.
:type `delayMilliSecs`: int
:rtype: `bool`
:returns:
``True`` if the operation succeeded, ``False`` otherwise.
.. method:: SaveFile(self, image, stream, verbose=True)
Saves a image in the output stream.
:param `image`: The image object which is to be affected by this operation.
:type `image`: wx.Image
:param `stream`: Opened output stream for writing the data.
:type `stream`: wx.OutputStream
:param `verbose`: If set to ``True``, errors reported by the image handler will produce LogMessages.
:type `verbose`: bool
:rtype: `bool`
:returns:
``True`` if the operation succeeded, ``False`` otherwise.
.. seealso:: :meth:`wx.Image.LoadFile` , :meth:`wx.Image.SaveFile` , :meth:`LoadFile`
|
