Document more wxDC drawing functions overloads.

Document overloads taking wxPoint/wxSize/wxRect in addition to the versions
taking individual wxCoords.

Closes #11752.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63547 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2010-02-25 00:03:22 +00:00
parent 4d68a949df
commit 83b4d26c14

View File

@ -231,6 +231,11 @@ public:
void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
wxCoord xc, wxCoord yc);
/**
@overload
*/
void DrawArc(const wxPoint& pt1, const wxPoint& pt2, const wxPoint& centre);
/**
Draw a bitmap on the device context at the specified point. If
@a transparent is @true and the bitmap has a transparency mask, the
@ -246,6 +251,12 @@ public:
void DrawBitmap(const wxBitmap& bitmap, wxCoord x, wxCoord y,
bool useMask = false);
/**
@overload
*/
void DrawBitmap(const wxBitmap &bmp, const wxPoint& pt,
bool useMask = false);
/**
Draws a check mark inside the given rectangle.
*/
@ -306,6 +317,12 @@ public:
void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord width, wxCoord height,
double start, double end);
/**
@overload
*/
void DrawEllipticArc(const wxPoint& pt, const wxSize& sz,
double sa, double ea);
/**
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
@ -313,6 +330,11 @@ public:
*/
void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
/**
@overload
*/
void DrawIcon(const wxIcon& icon, const wxPoint& pt);
/**
Draw optional bitmap and the text into the given rectangle and aligns
it as specified by alignment parameter; it also will emphasize the
@ -339,6 +361,11 @@ public:
*/
void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
/**
@overload
*/
void DrawLine(const wxPoint& pt1, const wxPoint& pt2);
/**
Draws lines using an array of points of size @a n adding the optional
offset coordinate. The current pen is used for drawing the lines.
@ -379,6 +406,11 @@ public:
*/
void DrawPoint(wxCoord x, wxCoord y);
/**
@overload
*/
void DrawPoint(const wxPoint& pt);
/**
Draws a filled polygon using an array of points of size @a n, adding
the optional offset coordinate. The first and last points are
@ -463,6 +495,16 @@ public:
*/
void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
/**
@overload
*/
void DrawRectangle(const wxPoint& pt, const wxSize& sz);
/**
@overload
*/
void DrawRectangle(const wxRect& rect);
/**
Draws the text rotated by @a angle degrees
(positive angles are counterclockwise; the full angle is 360 degrees).
@ -477,6 +519,12 @@ public:
void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
double angle);
/**
@overload
*/
void DrawRotatedText(const wxString& text, const wxPoint&,
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
@ -493,6 +541,17 @@ public:
void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width,
wxCoord height, double radius);
/**
@overload
*/
void DrawRoundedRectangle(const wxPoint& pt, const wxSize& sz,
double radius);
/**
@overload
*/
void DrawRoundedRectangle(const wxRect& rect, double radius);
/**
Draws a spline between all given points using the current pen.
@ -543,6 +602,11 @@ public:
*/
void DrawText(const wxString& text, wxCoord x, wxCoord y);
/**
@overload
*/
void DrawText(const wxString& text, const wxPoint& pt);
/**
Fill the area specified by rect with a radial gradient, starting from
@a initialColour at the centre of the circle and fading to
@ -603,6 +667,12 @@ public:
bool FloodFill(wxCoord x, wxCoord y, const wxColour& colour,
wxFloodFillStyle style = wxFLOOD_SURFACE);
/**
@overload
*/
bool FloodFill(const wxPoint& pt, const wxColour& col,
int style = wxFLOOD_SURFACE);
/**
Displays a cross hair using the current pen. This is a vertical and
horizontal line the height and width of the window, centred on the
@ -610,6 +680,11 @@ public:
*/
void CrossHair(wxCoord x, wxCoord y);
/**
@overload
*/
void CrossHair(const wxPoint& pt);
//@}