phoenix_title wx.SVGFileDC

A 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/). Full details are given in the W3C SVG recommendation (http://www.w3.org/TR/SVG/).

The intention behind wx.SVGFileDC is that it can be used to produce a file corresponding to the screen display context, wx.SVGFileDC, by passing the wx.SVGFileDC as a parameter instead of a wx.DC. Thus the wx.SVGFileDC is a write-only class.

As the wx.SVGFileDC is a vector format, raster operations like 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 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 wx.SVGFileDC.SetBitmapHandler .

More substantial SVG libraries (for reading and writing) are available at wxArt2D and wxSVG.


class_hierarchy Class Hierarchy

Inheritance diagram of SVGFileDC


method_summary Methods Summary

__init__

Initializes a wx.SVGFileDC with the given filename, width and height at dpi resolution, and an optional title.

Clear

Draws a rectangle the size of the SVG using the wx.DC.SetBackground brush.

CrossHair

Function not implemented in this DC class.

DestroyClippingRegion

Destroys the current clipping region so that none of the DC is clipped.

EndDoc

Function not implemented in this DC class.

EndPage

Function not implemented in this DC class.

FloodFill

Function not implemented in this DC class.

GetDepth

Function not implemented in this DC class.

GetLogicalFunction

Function not implemented in this DC class.

GetPixel

Function not implemented in this DC class.

SetBitmapHandler

Replaces the default bitmap handler with handler.

SetLogicalFunction

Function not implemented in this DC class.

SetPalette

Function not implemented in this DC class.

SetShapeRenderingMode

Set the shape rendering mode of the generated SVG.

StartDoc

Function not implemented in this DC class.

StartPage

Function not implemented in this DC class.

property_summary Properties Summary

Depth

See GetDepth

LogicalFunction

See GetLogicalFunction and SetLogicalFunction

api Class API

class wx.SVGFileDC(DC)

Possible constructors:

SVGFileDC(filename, width=320, height=240, dpi=72, title="") -> None

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.


Methods

__init__(self, filename, width=320, height=240, dpi=72, title='')

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

Parameters:

  • filename (string)

  • width (int)

  • height (int)

  • dpi (float)

  • title (string)

Return type:

None


Clear(self)

Draws a rectangle the size of the SVG using the wx.DC.SetBackground brush.

Return type:

None


CrossHair(self, x, y)

Function not implemented in this DC class.

Parameters:

  • x (int)

  • y (int)

Return type:

None


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.

Return type:

None


EndDoc(self)

Function not implemented in this DC class.

Return type:

None


EndPage(self)

Function not implemented in this DC class.

Return type:

None


FloodFill(self, x, y, colour, style=FLOOD_SURFACE)

Function not implemented in this DC class.

Parameters:
Return type:

bool


GetDepth(self)

Function not implemented in this DC class.

Return type:

int


GetLogicalFunction(self)

Function not implemented in this DC class.

Return type:

wx.RasterOperationMode


GetPixel(self, x, y, colour)

Function not implemented in this DC class.

Parameters:
Return type:

bool


SetBitmapHandler(self, handler)

Replaces the default bitmap handler with handler.

By default, an object of wx.SVGBitmapFileHandler class is used as bitmap handler. You may want to replace it with an object of predefined 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.

Parameters:

handler (wx.SVGBitmapHandler) – The new bitmap handler. If not None, this object takes ownership of this handler and will delete it when it is not needed any more.

Return type:

None

Added in version 4.1/wxWidgets-3.1.0.


SetLogicalFunction(self, function)

Function not implemented in this DC class.

Parameters:

function (RasterOperationMode)

Return type:

None


SetPalette(self, palette)

Function not implemented in this DC class.

Parameters:

palette (wx.Palette)

Return type:

None


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.

Parameters:

renderingMode (SVGShapeRenderingMode)

Return type:

None

Added in version 4.1/wxWidgets-3.1.3.


StartDoc(self, message)

Function not implemented in this DC class.

Parameters:

message (string)

Return type:

bool


StartPage(self)

Function not implemented in this DC class.

Return type:

None


Properties

Depth

See GetDepth


LogicalFunction

See GetLogicalFunction and SetLogicalFunction