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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
|
.. 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.SVGFileDC:
==========================================================================================================================================
|phoenix_title| **wx.SVGFileDC**
==========================================================================================================================================
A :ref:`wx.SVGFileDC` is a device context onto which graphics and text can be drawn, and the output produced as a vector file, in ``SVG`` format.
This format can be read by a range of programs, including a Netscape plugin (Adobe) and the open source Inkscape program (`http://inkscape.org/ <http://inkscape.org/>`_). Full details are given in the ``W3C`` ``SVG`` recommendation (`http://www.w3.org/TR/SVG/ <http://www.w3.org/TR/SVG/>`_).
The intention behind :ref:`wx.SVGFileDC` is that it can be used to produce a file corresponding to the screen display context, :ref:`wx.SVGFileDC`, by passing the :ref:`wx.SVGFileDC` as a parameter instead of a :ref:`wx.DC`. Thus the :ref:`wx.SVGFileDC` is a write-only class.
As the :ref:`wx.SVGFileDC` is a vector format, raster operations like :meth:`~wx.SVGFileDC.GetPixel` are unlikely to be supported. However, the ``SVG`` specification allows for raster files to be embedded in the ``SVG``, and so bitmaps, icons and blit operations in :ref:`wx.SVGFileDC` are supported. By default only ``PNG`` format bitmaps are supported and these are saved as separate files in the same folder as the ``SVG`` file, however it is possible to change this behaviour by replacing the built in bitmap handler using :meth:`wx.SVGFileDC.SetBitmapHandler` .
More substantial ``SVG`` libraries (for reading and writing) are available at `wxArt2D <http://wxart2d.sourceforge.net/>`_ and `wxSVG <http://wxsvg.sourceforge.net/>`_.
|
|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>SVGFileDC</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.SVGFileDC_inheritance.png" alt="Inheritance diagram of SVGFileDC" 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.SVGFileDC.html" title="wx.SVGFileDC" alt="" coords="5,160,119,189"/> <area shape="rect" id="node2" href="wx.DC.html" title="wx.DC" alt="" coords="26,83,98,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="19,5,105,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.SVGFileDC.__init__` Initializes a :ref:`wx.SVGFileDC` with the given `filename`, `width` and `height` at `dpi` resolution, and an optional `title`.
:meth:`~wx.SVGFileDC.Clear` Draws a rectangle the size of the ``SVG`` using the :meth:`wx.DC.SetBackground` brush.
:meth:`~wx.SVGFileDC.CrossHair` Function not implemented in this DC class.
:meth:`~wx.SVGFileDC.DestroyClippingRegion` Destroys the current clipping region so that none of the DC is clipped.
:meth:`~wx.SVGFileDC.EndDoc` Function not implemented in this DC class.
:meth:`~wx.SVGFileDC.EndPage` Function not implemented in this DC class.
:meth:`~wx.SVGFileDC.FloodFill` Function not implemented in this DC class.
:meth:`~wx.SVGFileDC.GetDepth` Function not implemented in this DC class.
:meth:`~wx.SVGFileDC.GetLogicalFunction` Function not implemented in this DC class.
:meth:`~wx.SVGFileDC.GetPixel` Function not implemented in this DC class.
:meth:`~wx.SVGFileDC.SetBitmapHandler` Replaces the default bitmap handler with `handler`.
:meth:`~wx.SVGFileDC.SetLogicalFunction` Function not implemented in this DC class.
:meth:`~wx.SVGFileDC.SetPalette` Function not implemented in this DC class.
:meth:`~wx.SVGFileDC.SetShapeRenderingMode` Set the shape rendering mode of the generated ``SVG``.
:meth:`~wx.SVGFileDC.StartDoc` Function not implemented in this DC class.
:meth:`~wx.SVGFileDC.StartPage` Function not implemented in this DC class.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.SVGFileDC.Depth` See :meth:`~wx.SVGFileDC.GetDepth`
:attr:`~wx.SVGFileDC.LogicalFunction` See :meth:`~wx.SVGFileDC.GetLogicalFunction` and :meth:`~wx.SVGFileDC.SetLogicalFunction`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.SVGFileDC(DC)
**Possible constructors**::
SVGFileDC(filename, width=320, height=240, dpi=72, title="")
A SVGFileDC is a device context onto which graphics and text can be
drawn, and the output produced as a vector file, in ``SVG`` format.
.. method:: __init__(self, filename, width=320, height=240, dpi=72, title="")
Initializes a :ref:`wx.SVGFileDC` with the given `filename`, `width` and `height` at `dpi` resolution, and an optional `title`.
The title provides a readable name for the ``SVG`` document.
:param `filename`:
:type `filename`: string
:param `width`:
:type `width`: int
:param `height`:
:type `height`: int
:param `dpi`:
:type `dpi`: float
:param `title`:
:type `title`: string
.. method:: Clear(self)
Draws a rectangle the size of the ``SVG`` using the :meth:`wx.DC.SetBackground` brush.
.. method:: CrossHair(self, x, y)
Function not implemented in this DC class.
:param `x`:
:type `x`: int
:param `y`:
:type `y`: int
.. method:: DestroyClippingRegion(self)
Destroys the current clipping region so that none of the DC is clipped.
Since intersections arising from sequential calls to SetClippingRegion are represented with nested ``SVG`` group elements (<g>), all such groups are closed when DestroyClippingRegion is called.
.. method:: EndDoc(self)
Function not implemented in this DC class.
.. method:: EndPage(self)
Function not implemented in this DC class.
.. method:: FloodFill(self, x, y, colour, style=FLOOD_SURFACE)
Function not implemented in this DC class.
:param `x`:
:type `x`: int
:param `y`:
:type `y`: int
:param `colour`:
:type `colour`: wx.Colour
:param `style`:
:type `style`: wx.FloodFillStyle
:rtype: `bool`
.. method:: GetDepth(self)
Function not implemented in this DC class.
:rtype: `int`
.. method:: GetLogicalFunction(self)
Function not implemented in this DC class.
:rtype: :ref:`wx.RasterOperationMode`
.. method:: GetPixel(self, x, y, colour)
Function not implemented in this DC class.
:param `x`:
:type `x`: int
:param `y`:
:type `y`: int
:param `colour`:
:type `colour`: wx.Colour
:rtype: `bool`
.. method:: SetBitmapHandler(self, handler)
Replaces the default bitmap handler with `handler`.
By default, an object of :ref:`wx.SVGBitmapFileHandler` class is used as bitmap handler. You may want to replace it with an object of predefined :ref:`wx.SVGBitmapEmbedHandler` class to embed the bitmaps in the generated ``SVG`` instead of storing them in separate files like this: ::
mySVGFileDC.SetBitmapHandler(wx.SVGBitmapEmbedHandler())
or derive your own bitmap handler class and use it if you need to customize the bitmap handling further.
:param `handler`: The new bitmap handler. If non-NULL, this object takes ownership of this handler and will delete it when it is not needed any more.
:type `handler`: wx.SVGBitmapHandler
.. versionadded:: 4.1/wxWidgets-3.1.0
.. method:: SetLogicalFunction(self, function)
Function not implemented in this DC class.
:param `function`:
:type `function`: wx.RasterOperationMode
.. method:: SetPalette(self, palette)
Function not implemented in this DC class.
:param `palette`:
:type `palette`: wx.Palette
.. method:: SetShapeRenderingMode(self, renderingMode)
Set the shape rendering mode of the generated ``SVG``.
All subsequent drawing calls will have this rendering mode set in the ``SVG`` file.
The default mode is ``wx.SVG_SHAPE_RENDERING_AUTO``.
:param `renderingMode`:
:type `renderingMode`: wx.SVGShapeRenderingMode
.. versionadded:: 4.1/wxWidgets-3.1.3
.. method:: StartDoc(self, message)
Function not implemented in this DC class.
:param `message`:
:type `message`: string
:rtype: `bool`
.. method:: StartPage(self)
Function not implemented in this DC class.
.. attribute:: Depth
See :meth:`~wx.SVGFileDC.GetDepth`
.. attribute:: LogicalFunction
See :meth:`~wx.SVGFileDC.GetLogicalFunction` and :meth:`~wx.SVGFileDC.SetLogicalFunction`
|
