// Name: dcsvg.h
// Purpose: interface of wxSVGFileDC
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxSVGFileDC
A wxSVGFileDC is a device context onto which graphics and text can be
- drawn, and the output produced as a vector file, in SVG format (see the W3C
- SVG Specifications <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 are given in the SVG Implementation and Resource
- Directory <http://www.svgi.org/>. Vector formats may often be smaller than
- raster formats.
+ 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 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
+ wxSVGFileDC as a parameter instead of a wxDC. Thus the wxSVGFileDC
is a write-only class.
As the wxSVGFileDC is a vector format, raster operations like GetPixel()
virtual ~wxSVGFileDC();
/**
- Copies 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.
-
- @see wxDC::Blit()
+ Does nothing.
*/
- bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
- wxDC* source, wxCoord xsrc, wxCoord ysrc, wxRasterOperationMode rop = wxCOPY,
- bool useMask = false, wxCoord xsrcMask = wxDefaultCoord,
- wxCoord ysrcMask = wxDefaultCoord);
+ void EndDoc();
/**
- Adds the specified point to the bounding box which can be retrieved
- with wxDC::MinX(), wxDC::MaxX() and wxDC::MinY(), wxDC::MaxY()
- functions.
+ Does nothing.
*/
- void CalcBoundingBox(wxCoord x, wxCoord y);
+ void EndPage();
/**
This makes no sense in wxSVGFileDC and does nothing.
void Clear();
/**
- Not Implemented.
- */
- void CrossHair(wxCoord x, wxCoord y);
-
- /**
- Not Implemented.
- */
- void DestroyClippingRegion();
-
- /**
- Convert device X coordinate to logical coordinate, using the current
- mapping mode.
- */
- wxCoord DeviceToLogicalX(wxCoord x) const;
-
- /**
- 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.
- */
- wxCoord DeviceToLogicalXRel(wxCoord x) const;
-
- /**
- Converts device Y coordinate to logical coordinate, using the current
- mapping mode.
- */
- wxCoord DeviceToLogicalY(wxCoord y) const;
-
- /**
- 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.
- */
- wxCoord DeviceToLogicalYRel(wxCoord y) const;
-
- /**
- Draws an arc of a circle, centred on (@a xc, @a yc), with starting
- point (@a x1, @a y1) and ending at (@a x2, @a y2). The current pen is
- used for the outline and the current brush for filling the shape.
-
- The arc is drawn in a counter-clockwise direction from the start point
- to the end point.
- */
- void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
- wxCoord xc, wxCoord yc);
-
- /**
- Draw a bitmap on the device context at the specified point. If
- @a useMask 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 wxDC::SetTextForeground(), wxDC::SetTextBackground(), wxMemoryDC
- */
- void DrawBitmap(const wxBitmap& bitmap, wxCoord x, wxCoord y,
- bool useMask = false);
-
- //@{
- /**
- Draws a check mark inside the given rectangle.
- */
- void DrawCheckMark(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
- void DrawCheckMark(const wxRect& rect);
- //@}
-
- //@{
- /**
- Draws a circle with the given centre and radius.
-
- @see wxDC::DrawEllipse()
- */
- void DrawCircle(wxCoord x, wxCoord y, wxCoord radius);
- void DrawCircle(const wxPoint& pt, wxCoord radius);
- //@}
-
- //@{
- /**
- 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.
-
- @see wxDC::DrawCircle()
+ Does the same as wxDC::SetLogicalFunction(), except that only wxCOPY is
+ available. Trying to set one of the other values will fail.
*/
- void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
- void DrawEllipse(const wxPoint& pt, const wxSize& size);
- void DrawEllipse(const wxRect& rect);
- //@}
+ void SetLogicalFunction(wxRasterOperationMode function);
/**
- 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.
-
- @a x and @a y specify the x and y coordinates of the upper-left corner
- of the rectangle that contains the ellipse.
-
- @a width and @a height specify the width and height of the rectangle
- that contains the ellipse.
-
- @a start and @a 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 @a start is equal to @a end, a complete
- ellipse will be drawn.
+ Sets the clipping region for this device context to the intersection of
+ the given region described by the parameters of this method and the previously
+ set clipping region.
+ Clipping is implemented in the SVG output using SVG group elements (\<g\>), with
+ nested group elements being used to represent clipping region intersections when
+ two or more calls are made to SetClippingRegion().
*/
- void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord width, wxCoord height,
- double start, double end);
+ void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width,
+ wxCoord height);
/**
- 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.
+ This is an overloaded member function, provided for convenience. It differs from the
+ above function only in what argument(s) it accepts.
*/
- void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
+ void SetClippingRegion(const wxPoint& pt, const wxSize& sz);
/**
- Draws a line from the first point to the second. The current pen is
- used for drawing the line.
+ This is an overloaded member function, provided for convenience. It differs from the
+ above function only in what argument(s) it accepts.
*/
- void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
+ void SetClippingRegion(const wxRect& rect);
- //@{
/**
- Draws lines using an array of @a points of size @a 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.
+ This function is not implemented in this DC class.
+ It could be implemented in future if a GetPoints() function were made available on wxRegion.
*/
- void DrawLines(int n, wxPoint points[], wxCoord xoffset = 0,
- wxCoord yoffset = 0);
- void DrawLines(wxList* points, wxCoord xoffset = 0,
- wxCoord yoffset = 0);
- //@}
+ void SetClippingRegion(const wxRegion& region);
/**
- Draws a point using the current pen.
+ 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.
*/
- void DrawPoint(wxCoord x, wxCoord y);
+ void DestroyClippingRegion();
//@{
/**
- Draws a filled polygon using an array of @a points of size @a n,
- or list of pointers to points, adding the optional offset coordinate.
- wxWidgets automatically closes the first and last points.
-
- The last argument specifies the fill rule: @c wxODDEVEN_RULE (the
- default) or @c 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.
- */
- void DrawPolygon(int n, wxPoint points[], wxCoord xoffset = 0,
- wxCoord yoffset = 0,
- wxPolygonFillMode fill_style = wxODDEVEN_RULE);
- void DrawPolygon(wxList* points, wxCoord xoffset = 0,
- wxCoord yoffset = 0,
- wxPolygonFillMode fill_style = wxODDEVEN_RULE);
- //@}
-
- /**
- 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.
- */
- void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
-
- /**
- Draws the text rotated by @a angle degrees.
-
- The wxMSW wxDC and wxSVGFileDC rotate the text around slightly
- different points, depending on the size of the font.
- */
- void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
- double angle);
-
- /**
- 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 @a radius is positive, the value is assumed to be the radius of the
- rounded corner. If @a radius is negative, the absolute value is assumed
- to be the @e 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.
- */
- void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width,
- wxCoord height, double radius = 20);
-
- /**
- Draws a spline between all given control points, using the current pen.
- The programmer is responsible for deleting the list of points.
- The spline is drawn using a series of lines, using an algorithm taken from
- the X drawing program "XFIG".
- */
- void DrawSpline(const wxPointList* points);
-
- /**
- Draws a three-point spline using the current pen.
- */
- void DrawSpline(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
- wxCoord x3, wxCoord y3);
-
- /**
- 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 wxDC::GetTextExtent() for how to get the dimensions of
- a text string, which can be used to position the text more precisely.
- */
- void DrawText(const wxString& text, wxCoord x, wxCoord y);
-
- /**
- Does nothing.
- */
- void EndDoc();
-
- /**
- Does nothing.
- */
- void EndDrawing();
-
- /**
- Does nothing.
- */
- void EndPage();
-
- /**
- Not implemented.
+ Functions not implemented in this DC class.
*/
+ void CrossHair(wxCoord x, wxCoord y);
bool FloodFill(wxCoord x, wxCoord y, const wxColour& colour,
wxFloodFillStyle style = wxFLOOD_SURFACE);
-
- //@{
- /**
- Gets the brush used for painting the background.
-
- @see SetBackground()
- */
- wxBrush GetBackground() const;
- const wxBrush GetBackground() const;
- //@}
-
- /**
- Returns the current background mode: @c wxSOLID or @c wxTRANSPARENT.
-
- @see SetBackgroundMode()
- */
- int GetBackgroundMode() const;
-
- //@{
- /**
- Gets the current brush.
-
- @see SetBrush()
- */
- wxBrush GetBrush() const;
- const wxBrush GetBrush() const;
- //@}
-
- /**
- Gets the character height of the currently set font.
- */
- wxCoord GetCharHeight() const;
-
- /**
- Gets the average character width of the currently set font.
- */
- wxCoord GetCharWidth() const;
-
- /**
- Not implemented.
- */
void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *width, wxCoord *height) const;
-
- //@{
- /**
- Gets the current font.
-
- @see SetFont()
- */
- wxFont GetFont() const;
- const wxFont GetFont() const;
- //@}
-
- /**
- Gets the current logical function.
-
- @see SetLogicalFunction()
- */
- wxRasterOperationMode GetLogicalFunction() const;
-
- /**
- Gets the mapping mode for the device context.
-
- @see SetMapMode()
- */
- int GetMapMode() const;
-
- //@{
- /**
- Gets the current pen.
-
- @see SetPen()
- */
- wxPen GetPen() const;
- const wxPen GetPen() const;
- //@}
-
- /**
- Not implemented.
- */
bool GetPixel(wxCoord x, wxCoord y, wxColour* colour) const;
-
- /**
- For a Windows printer device context, this gets the horizontal and
- vertical resolution.
- */
- void GetSize(wxCoord* width, wxCoord* height);
-
- //@{
- /**
- Gets the current text background colour.
-
- @see SetTextBackground()
- */
- wxColour GetTextBackground() const;
- const wxColour& GetTextBackground() const;
- //@}
-
- /**
- Gets the dimensions of the string using the currently selected font.
-
- @param string
- The text string to measure.
- @param w
- This value will be set to the width after this call.
- @param h
- This value will be set to the height after this call.
- @param descent
- The dimension from the baseline of the font to the bottom of the
- descender.
- @param externalLeading
- Any extra vertical space added to the font by the font designer
- (usually is zero).
- @param font
- Specifies an alternative to the currently selected font: but note
- that this does not yet work under Windows, so you need to set a
- font for the device context first.
-
- @see wxFont, SetFont()
- */
- void GetTextExtent(const wxString& string, wxCoord* w, wxCoord* h,
- wxCoord* descent = NULL,
- wxCoord* externalLeading = NULL,
- const wxFont* font = NULL) const;
-
- //@{
- /**
- Gets the current text foreground colour.
-
- @see SetTextForeground()
- */
- wxColour GetTextForeground() const;
- const wxColour GetTextForeground() const;
- //@}
-
- /**
- Gets the current user scale factor.
-
- @see SetUserScale()
- */
- void GetUserScale(double* x, double* y) const;
-
- /**
- Converts logical X coordinate to device coordinate, using the current
- mapping mode.
- */
- wxCoord LogicalToDeviceX(wxCoord x) const;
-
- /**
- Converts logical X coordinate to relative device coordinate, using the
- current mapping mode but ignoring the x axis orientation. Use this for
- converting a width, for example.
- */
- wxCoord LogicalToDeviceXRel(wxCoord x) const;
-
- /**
- Converts logical Y coordinate to device coordinate, using the current
- mapping mode.
- */
- wxCoord LogicalToDeviceY(wxCoord y) const;
-
- /**
- Converts logical Y coordinate to relative device coordinate, using the
- current mapping mode but ignoring the y axis orientation. Use this for
- converting a height, for example.
- */
- wxCoord LogicalToDeviceYRel(wxCoord y) const;
-
- /**
- Gets the maximum horizontal extent used in drawing commands so far.
- */
- wxCoord MaxX() const;
-
- /**
- Gets the maximum vertical extent used in drawing commands so far.
- */
- wxCoord MaxY() const;
-
- /**
- Gets the minimum horizontal extent used in drawing commands so far.
- */
- wxCoord MinX() const;
-
- /**
- Gets the minimum vertical extent used in drawing commands so far.
- */
- wxCoord MinY() const;
-
- /**
- Returns @true if the DC is ok to use. @false values arise from being
- unable to write the file.
- */
- bool Ok();
-
- /**
- Resets the bounding box. After a call to this function, the bounding
- box doesn't contain anything.
-
- @see CalcBoundingBox()
- */
- void ResetBoundingBox();
-
- /**
- Sets the x and y axis orientation (i.e., the direction from lowest to
- highest values on the axis). The default orientation is the natural
- orientation, e.g. x axis from left to right and y axis from bottom up.
-
- @param xLeftRight
- @true to set the x axis orientation to the natural left to right
- orientation, @false to invert it.
- @param yBottomUp
- @true to set the y axis orientation to the natural bottom up
- orientation, @false to invert it.
- */
- void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
-
- /**
- Sets the current background brush for the DC.
- */
- void SetBackground(const wxBrush& brush);
-
- /**
- @a mode may be one of wxSOLID and wxTRANSPARENT. This setting determines
- whether text will be drawn with a background colour or not.
- */
- void SetBackgroundMode(int mode);
-
- /**
- Sets the current brush for the DC. If the argument is wxNullBrush, the
- current brush is selected out of the device context, and the original
- brush restored, allowing the current brush to be destroyed safely.
-
- @see wxBrush, wxMemoryDC (for the interpretation of colours
- when drawing into a monochrome bitmap).
- */
- void SetBrush(const wxBrush& brush);
-
- //@{
- /**
- Not implemented.
- */
- void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width,
- wxCoord height);
- void SetClippingRegion(const wxPoint& pt, const wxSize& sz);
- void SetClippingRegion(const wxRect& rect);
- void SetClippingRegion(const wxRegion& region);
- //@}
-
- /**
- Sets the device origin (i.e., the origin in pixels after scaling has
- been applied). This function may be useful in Windows printing
- operations for placing a graphic on a page.
- */
- void SetDeviceOrigin(wxCoord x, wxCoord y);
-
- /**
- Sets the current font for the DC. It must be a valid font, in
- particular you should not pass @c wxNullFont to this method.
-
- @see wxFont
- */
- void SetFont(const wxFont& font);
-
- /**
- Does the same as wxDC::SetLogicalFunction(), except that only wxCOPY is
- available. Trying to set one of the other values will fail.
- */
- void SetLogicalFunction(wxRasterOperationMode function);
-
- /**
- The mapping mode of the device context defines the unit of measurement
- used to convert logical units to device units. Note that in X, text
- drawing isn't handled consistently with the mapping mode; a font is
- always specified in point size. However, setting the user scale scales
- the text appropriately. In Windows, scalable TrueType fonts are always
- used; in X, results depend on availability of fonts, but usually a
- reasonable match is found.
-
- Note that the coordinate origin should ideally be selectable, but for
- now is always at the top left of the screen/printer.
-
- Drawing to a Windows printer device context under UNIX uses the current
- mapping mode, but mapping mode is currently ignored for PostScript
- output.
-
- The mapping mode can be one of the following:
- - wxMM_TWIPS - Each logical unit is 1/20 of a point, or 1/1440 of an
- inch.
- - wxMM_POINTS - Each logical unit is a point, or 1/72 of an inch.
- - wxMM_METRIC - Each logical unit is 1 mm.
- - wxMM_LOMETRIC - Each logical unit is 1/10 of a mm.
- - wxMM_TEXT - Each logical unit is 1 pixel.
- */
- void SetMapMode(int mode);
-
- /**
- Not implemented.
- */
void SetPalette(const wxPalette& palette);
-
- /**
- Sets the current pen for the DC. If the argument is wxNullPen, the
- current pen is selected out of the device context, and the original pen
- restored.
-
- @see wxMemoryDC (for the interpretation of colours when drawing into a
- monochrome bitmap)
- */
- void SetPen(const wxPen& pen);
-
- /**
- Sets the current text background colour for the DC.
- */
- void SetTextBackground(const wxColour& colour);
-
- /**
- Sets the current text foreground colour for the DC.
-
- @see wxMemoryDC (for the interpretation of colours when drawing into a
- monochrome bitmap)
- */
- void SetTextForeground(const wxColour& colour);
-
- /**
- Sets the user scaling factor, useful for applications which require
- "zooming".
- */
- void SetUserScale(double xScale, double yScale);
-
- /**
- Does nothing.
- */
bool StartDoc(const wxString& message);
+ //@}
};
projects / wxWidgets.git / blobdiff