File: wx.SVGBitmapFileHandler.txt

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (165 lines) | stat: -rw-r--r-- 4,567 bytes parent folder | download
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
.. 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.SVGBitmapFileHandler:

==========================================================================================================================================
|phoenix_title|  **wx.SVGBitmapFileHandler**
==========================================================================================================================================

Handler saving bitmaps to external ``PNG`` files and linking to it from the ``SVG``.          

This handler is used by default by :ref:`wx.SVGFileDC`. ``PNG`` files are created in the same folder as the ``SVG`` file and are named using the ``SVG`` filename appended with  ``_image#.png`` . 

When using :meth:`wx.SVGFileDC.SetBitmapHandler`   to set this handler with the default constructor, the ``PNG`` files are created in the runtime location of the application. The save location can be customized by using the :ref:`wx.SVGBitmapFileHandler`  constructor. 





         



.. versionadded:: 4.1/wxWidgets-3.1.0  
     







.. seealso:: :meth:`wx.SVGFileDC.SetBitmapHandler` .  







|

|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>SVGBitmapFileHandler</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.SVGBitmapFileHandler_inheritance.png" alt="Inheritance diagram of SVGBitmapFileHandler" 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.SVGBitmapFileHandler.html" title="wx.SVGBitmapFileHandler" alt="" coords="5,83,197,112"/> <area shape="rect" id="node2" href="wx.SVGBitmapHandler.html" title="wx.SVGBitmapHandler" alt="" coords="16,5,187,35"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.SVGBitmapFileHandler.__init__`                                        Create a :ref:`wx.SVGBitmapFileHandler`  and specify the location where the file will be saved.
:meth:`~wx.SVGBitmapFileHandler.ProcessBitmap`                                   Writes the bitmap representation as ``SVG`` to the given stream.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.SVGBitmapFileHandler(SVGBitmapHandler)

   **Possible constructors**::

       SVGBitmapFileHandler(path)
       
   
   Handler saving bitmaps to external ``PNG`` files and linking to it from
   the ``SVG``.



   .. method:: __init__(self, path)

      Create a :ref:`wx.SVGBitmapFileHandler`  and specify the location where the file will be saved.                  




      :param `path`: The path of the save location. If  `path`  contains a filename, the autogenerated filename will be appended to this name.  
      :type `path`: string




                  



      .. versionadded:: 4.1/wxWidgets-3.1.3  
     








   .. method:: ProcessBitmap(self, bitmap, x, y, stream)

      Writes the bitmap representation as ``SVG`` to the given stream.                  

      The ``XML`` generated by this function will be inserted into the ``SVG`` file inline with the ``XML`` generated by the main :ref:`wx.SVGFileDC`  class so it is important that the ``XML`` is properly formed. 




      :param `bitmap`: A valid bitmap to add to ``SVG``.   
      :type `bitmap`: wx.Bitmap
      :param `x`: Horizontal position of the bitmap.   
      :type `x`: int
      :param `y`: Vertical position of the bitmap.   
      :type `y`: int
      :param `stream`: The stream to write ``SVG`` contents to.   
      :type `stream`: wx.OutputStream












      :rtype: `bool`