.. 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

Inheritance diagram for class
SVGBitmapFileHandler:
|
|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 : str) -> None
Handler saving bitmaps to external ``PNG`` files and linking to it from
the ``SVG``.
.. method:: __init__(self, path : str)
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
:rtype: `None`
.. versionadded:: 4.1/wxWidgets-3.1.3
.. method:: ProcessBitmap(self, bitmap : Bitmap, x : int, y : int, stream : OutputStream)
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`