Contents Up Previous Next

wxSVGFileDC

A wxSVGFileDC is a device context onto which graphics and text can be drawn, and the output produced as a vector file, in the SVG format (see http://www.w3.org/TR/2001/REC-SVG-20010904/ ). This format can be read by a range of programs, including a Netscape plugin (Adobe), full details at http://www.w3.org/Graphics/SVG/SVG-Implementations.htm8 Vector formats may often be smaller than raster formats.

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

As the wxSVGFileDC is a vector format, raster operations like GetPixel are unlikely to be supported. However, the SVG specification allows for PNG format raster files to be embedded in the SVG, and so bitmaps, icons and blit operations into the wxSVGFileDC are supported.

A more substantial SVG library (for reading and writing) is available at http://www.xs4all.nl/~kholwerd/wxstuff/canvas/htmldocbook/aap.html

wxheadingDerived from

wxDCBase (REF NOT FOUND)

wxheadingInclude files

<wx/dcsvg.h>

wxheadingSee also

wxheadingMembers

wxSVGFileDC::wxSVGFileDC
wxSVGFileDC::~wxSVGFileDC
wxSVGFileDC::BeginDrawing
wxSVGFileDC::Blit
wxSVGFileDC::CalcBoundingBox
wxSVGFileDC::Clear
wxSVGFileDC::CrossHair
wxSVGFileDC::DestroyClippingRegion
wxSVGFileDC::DeviceToLogicalX
wxSVGFileDC::DeviceToLogicalXRel
wxSVGFileDC::DeviceToLogicalY
wxSVGFileDC::DeviceToLogicalYRel
wxSVGFileDC::DrawArc
wxSVGFileDC::DrawBitmap
wxSVGFileDC::DrawCheckMark
wxSVGFileDC::DrawCircle
wxSVGFileDC::DrawEllipse
wxSVGFileDC::DrawEllipticArc
wxSVGFileDC::DrawIcon
wxSVGFileDC::DrawLine
wxSVGFileDC::DrawLines
wxSVGFileDC::DrawPolygon
wxSVGFileDC::DrawPoint
wxSVGFileDC::DrawRectangle
wxSVGFileDC::DrawRotatedText
wxSVGFileDC::DrawRoundedRectangle
wxSVGFileDC::DrawSpline
wxSVGFileDC::DrawText
wxSVGFileDC::EndDoc
wxSVGFileDC::EndDrawing
wxSVGFileDC::EndPage
wxSVGFileDC::FloodFill
wxSVGFileDC::GetBackground
wxSVGFileDC::GetBackgroundMode


wxSVGFileDC::wxSVGFileDC

wxSVGFileDC(wxString f) wxSVGFileDC(wxString f, int Width,int Height) wxSVGFileDC(wxString f, int Width,int Height,float dpi)

Constructors: a filename f with default size 340x240 at 72.0 dots per inch (a frequent screen resolution). a filename f with size Width by Height at 72.0 dots per inch a filename f with size Width by Height at dpi resolution.


wxSVGFileDC::~wxSVGFileDC

~wxSVGFileDC()

Destructor.


wxSVGFileDC::BeginDrawing

Does nothing


wxSVGFileDC::Blit

bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height, wxSVGFileDC* source, wxCoord xsrc, wxCoord ysrc, int logicalFunc = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1)

As wxDC: Copy from a source DC to this DC, specifying the destination coordinates, size of area to copy, source DC, source coordinates, logical function, whether to use a bitmap mask, and mask source position.


wxSVGFileDC::CalcBoundingBox

void CalcBoundingBox(wxCoord x, wxCoord y)

Adds the specified point to the bounding box which can be retrieved with MinX (REF NOT FOUND), MaxX (REF NOT FOUND) and MinY (REF NOT FOUND), MaxY (REF NOT FOUND) functions.


wxSVGFileDC::Clear

void Clear()

This makes no sense in wxSVGFileDC and does nothing


wxSVGFileDC::CrossHair

void CrossHair(wxCoord x, wxCoord y)

Not Implemented


wxSVGFileDC::DestroyClippingRegion

void DestroyClippingRegion()

Not Implemented


wxSVGFileDC::DeviceToLogicalX

wxCoord DeviceToLogicalX(wxCoord x)

Convert device X coordinate to logical coordinate, using the current mapping mode.


wxSVGFileDC::DeviceToLogicalXRel

wxCoord DeviceToLogicalXRel(wxCoord x)

Convert device X coordinate to relative logical coordinate, using the current mapping mode but ignoring the x axis orientation. Use this function for converting a width, for example.


wxSVGFileDC::DeviceToLogicalY

wxCoord DeviceToLogicalY(wxCoord y)

Converts device Y coordinate to logical coordinate, using the current mapping mode.


wxSVGFileDC::DeviceToLogicalYRel

wxCoord DeviceToLogicalYRel(wxCoord y)

Convert device Y coordinate to relative logical coordinate, using the current mapping mode but ignoring the y axis orientation. Use this function for converting a height, for example.


wxSVGFileDC::DrawArc

void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2, wxCoord xc, wxCoord yc)

Draws an arc of a circle, centred on (xc, yc), with starting point (x1, y1) and ending at (x2, y2). The current pen is used for the outline and the current brush for filling the shape.

The arc is drawn in an anticlockwise direction from the start point to the end point.


wxSVGFileDC::DrawBitmap

void DrawBitmap(const wxBitmap& bitmap, wxCoord x, wxCoord y, bool transparent)

Draw a bitmap on the device context at the specified point. If transparent is true and the bitmap has a transparency mask, the bitmap will be drawn transparently.

When drawing a mono-bitmap, the current text foreground colour will be used to draw the foreground of the bitmap (all bits set to 1), and the current text background colour to draw the background (all bits set to 0). See also SetTextForeground (REF NOT FOUND), SetTextBackground (REF NOT FOUND) and wxMemoryDC (REF NOT FOUND).


wxSVGFileDC::DrawCheckMark

void DrawCheckMark(wxCoord x, wxCoord y, wxCoord width, wxCoord height)

void DrawCheckMark(const wxRect &rect)

Draws a check mark inside the given rectangle.


wxSVGFileDC::DrawCircle

void DrawCircle(wxCoord x, wxCoord y, wxCoord radius)

void DrawCircle(const wxPoint& pt, wxCoord radius)

Draws a circle with the given centre and radius.

wxheadingSee also

DrawEllipse


wxSVGFileDC::DrawEllipse

void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height)

void DrawEllipse(const wxPoint& pt, const wxSize& size)

void DrawEllipse(const wxRect& rect)

Draws an ellipse contained in the rectangle specified either with the given top left corner and the given size or directly. The current pen is used for the outline and the current brush for filling the shape.

wxheadingSee also

DrawCircle


wxSVGFileDC::DrawEllipticArc

void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord width, wxCoord height, double start, double end)

Draws an arc of an ellipse. The current pen is used for drawing the arc and the current brush is used for drawing the pie.

x and y specify the x and y coordinates of the upper-left corner of the rectangle that contains the ellipse.

width and height specify the width and height of the rectangle that contains the ellipse.

start and end specify the start and end of the arc relative to the three-o'clock position from the center of the rectangle. Angles are specified in degrees (360 is a complete circle). Positive values mean counter-clockwise motion. If start is equal to end, a complete ellipse will be drawn.


wxSVGFileDC::DrawIcon

void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y)

Draw an icon on the display (does nothing if the device context is PostScript). This can be the simplest way of drawing bitmaps on a window.


wxSVGFileDC::DrawLine

void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2)

Draws a line from the first point to the second. The current pen is used for drawing the line.


wxSVGFileDC::DrawLines

void DrawLines(int n, wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0)

void DrawLines(wxList *points, wxCoord xoffset = 0, wxCoord yoffset = 0)

Draws lines using an array of points of size n, or list of pointers to points, adding the optional offset coordinate. The current pen is used for drawing the lines. The programmer is responsible for deleting the list of points.


wxSVGFileDC::DrawPolygon

void DrawPolygon(int n, wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0,
int fill_style = wxODDEVEN_RULE)

void DrawPolygon(wxList *points, wxCoord xoffset = 0, wxCoord yoffset = 0,
int fill_style = wxODDEVEN_RULE)

Draws a filled polygon using an array of points of size n, or list of pointers to points, adding the optional offset coordinate.

The last argument specifies the fill rule: wxODDEVEN_RULE (the default) or wxWINDING_RULE.

The current pen is used for drawing the outline, and the current brush for filling the shape. Using a transparent brush suppresses filling. The programmer is responsible for deleting the list of points.

Note that wxWindows automatically closes the first and last points.


wxSVGFileDC::DrawPoint

void DrawPoint(wxCoord x, wxCoord y)

Draws a point using the current pen.


wxSVGFileDC::DrawRectangle

void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height)

Draws a rectangle with the given top left corner, and with the given size. The current pen is used for the outline and the current brush for filling the shape.


wxSVGFileDC::DrawRotatedText

void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle)

Draws the text rotated by angle degrees.

The wxMSW wxDC and wxSVGFileDC rotate the text around slightly different points, depending on the size of the font


wxSVGFileDC::DrawRoundedRectangle

void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height, double radius = 20)

Draws a rectangle with the given top left corner, and with the given size. The corners are quarter-circles using the given radius. The current pen is used for the outline and the current brush for filling the shape.

If radius is positive, the value is assumed to be the radius of the rounded corner. If radius is negative, the absolute value is assumed to be the proportion of the smallest dimension of the rectangle. This means that the corner can be a sensible size relative to the size of the rectangle, and also avoids the strange effects X produces when the corners are too big for the rectangle.


wxSVGFileDC::DrawSpline

void DrawSpline(wxList *points)

Draws a spline between all given control points, using the current pen. Doesn't delete the wxList and contents. The spline is drawn using a series of lines, using an algorithm taken from the X drawing program 'XFIG'.

void DrawSpline(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2, wxCoord x3, wxCoord y3)

Draws a three-point spline using the current pen.


wxSVGFileDC::DrawText

void DrawText(const wxString& text, wxCoord x, wxCoord y)

Draws a text string at the specified point, using the current text font, and the current text foreground and background colours.

The coordinates refer to the top-left corner of the rectangle bounding the string. See wxSVGFileDC::GetTextExtent (REF NOT FOUND) for how to get the dimensions of a text string, which can be used to position the text more precisely.


wxSVGFileDC::EndDoc

void EndDoc()

Does nothing


wxSVGFileDC::EndDrawing

void EndDrawing()

Does nothing


wxSVGFileDC::EndPage

void EndPage()

Does nothing


wxSVGFileDC::FloodFill

void FloodFill(wxCoord x, wxCoord y, const wxColour& colour, int style=wxFLOOD_SURFACE)

Not implemented


wxSVGFileDC::GetBackground

wxBrush& GetBackground()

constfuncconst wxBrush&GetBackground

Gets the brush used for painting the background (see wxSVGFileDC::SetBackground (REF NOT FOUND)).


wxSVGFileDC::GetBackgroundMode

constfuncintGetBackgroundMode