X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e2a6f23364aefcd5095dc6558e3ab8144363fa96..19f6bff4484b97ef036a793820eb30c0a6df92b5:/docs/latex/wx/dc.tex diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index ed3c32073c..e5ce0687ed 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -6,55 +6,48 @@ so a window can have a device context associated with it, and a printer also has In this way, the same piece of code may write to a number of different devices, if the device context is used as a parameter. -Derived types of wxDC have documentation for specific features -only, so refer to this section for most device context information. +Notice that wxDC is an abstract base class and can't be created directly, +please use \helpref{wxPaintDC}{wxpaintdc}, \helpref{wxClientDC}{wxclientdc}, +\helpref{wxWindowDC}{wxwindowdc}, \helpref{wxScreenDC}{wxscreendc}, +\helpref{wxMemoryDC}{wxmemorydc} or \helpref{wxPrinterDC}{wxprinterdc}. -\wxheading{Derived from} - -\helpref{wxObject}{wxobject} - -\wxheading{See also} - -\helpref{Overview}{dcoverview} - -\latexignore{\rtfignore{\wxheading{Members}}} +% VZ: we should really document them instead of this lame excuse, but I don't +% have time for it now, when it is done please remove this +Please note that in addition to the versions of the methods documented here, +there are also versions which accept single {\tt wxPoint} parameter instead of +two {\tt wxCoord} ones or {\tt wxPoint} and {\tt wxSize} instead of four of +them. -\membersection{wxDC::wxDC} +\wxheading{Support for Transparency / Alpha Channel} -\func{}{wxDC}{\void} +On Mac OS X when using Core Graphics (wx\_MAC\_USE\_CORE\_GRAPHICS set to 1) +colors with alpha are supported, so instances {\tt wxPen} or {\tt wxBrush} that are built from {\tt wxColour} use +the color's alpha values when stroking or filling. -Constructor. +\wxheading{Derived from} -\membersection{wxDC::\destruct{wxDC}} +\helpref{wxObject}{wxobject} -\func{}{\destruct{wxDC}}{\void} +\wxheading{Include files} -Destructor. + -\membersection{wxDC::BeginDrawing}\label{wxdcbegindrawing} +\wxheading{See also} -\func{void}{BeginDrawing}{\void} +\helpref{Overview}{dcoverview} -Allows optimization of drawing code under MS Windows. Enclose -drawing primitives between {\bf BeginDrawing} and {\bf EndDrawing}\rtfsp -calls. +\latexignore{\rtfignore{\wxheading{Members}}} -Drawing to a wxDialog panel device context outside of a -system-generated OnPaint event {\it requires} this pair of calls to -enclose drawing code. This is because a Windows dialog box does not have -a retained device context associated with it, and selections such as pen -and brush settings would be lost if the device context were obtained and -released for each drawing operation. \membersection{wxDC::Blit}\label{wxdcblit} -\func{bool}{Blit}{\param{long}{ xdest}, \param{long}{ ydest}, \param{long}{ width}, \param{long}{ height}, - \param{wxDC* }{source}, \param{long}{ xsrc}, \param{long}{ ysrc}, \param{int}{ logicalFunc}, - \param{bool }{useMask}} +\func{bool}{Blit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, + \param{wxDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{int}{ logicalFunc = wxCOPY}, + \param{bool }{useMask = false}, \param{wxCoord}{ xsrcMask = -1}, \param{wxCoord}{ ysrcMask = -1}} Copy from a source DC to this DC, specifying the destination -coordinates, size of area to copy, source DC, source coordinates, and -logical function. +coordinates, size of area to copy, source DC, source coordinates, +logical function, whether to use a bitmap mask, and mask source position. \wxheading{Parameters} @@ -74,8 +67,8 @@ logical function. \docparam{logicalFunc}{Logical function to use: see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}.} -\docparam{useMask}{If TRUE, Blit does a transparent blit using the mask that is associated with the bitmap -selected into the source device context. The Windows implementation does the following: +\docparam{useMask}{If true, Blit does a transparent blit using the mask that is associated with the bitmap +selected into the source device context. The Windows implementation does the following if MaskBlt cannot be used: \begin{enumerate} \item Creates a temporary bitmap and copies the destination area into it. @@ -92,17 +85,63 @@ and the background colour set to WHITE. This sequence of operations ensures that the source's transparent area need not be black, and logical functions are supported. + +{\bf Note:} on Windows, blitting with masks can be speeded up considerably by compiling +wxWidgets with the wxUSE\_DC\_CACHE option enabled. You can also influence whether MaskBlt +or the explicit mask blitting code above is used, by using \helpref{wxSystemOptions}{wxsystemoptions} and +setting the {\bf no-maskblt} option to 1. + } +\docparam{xsrcMask}{Source x position on the mask. If both xsrcMask and ysrcMask are -1, xsrc and ysrc +will be assumed for the mask source position. Currently only implemented on Windows.} + +\docparam{ysrcMask}{Source y position on the mask. If both xsrcMask and ysrcMask are -1, xsrc and ysrc +will be assumed for the mask source position. Currently only implemented on Windows.} + + \wxheading{Remarks} There is partial support for Blit in wxPostScriptDC, under X. See \helpref{wxMemoryDC}{wxmemorydc} for typical usage. -wxheading{See also} +\wxheading{See also} + +\helpref{wxDC::StretchBlit}{wxdcstretchblit}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask} + +\begin{comment} + +\membersection{wxDC::CacheEnabled}\label{wxdccacheenabled} + +\func{static bool}{CacheEnabled}{\void} + +On supported platforms (currently only Windows), returns true +if the DC cache is enabled. The DC cache +can speed up the \helpref{Blit}{wxdcblit} operation when +drawing a large number of masked bitmaps. + +If using the cache functions in your code, please test for the +wxUSE\_DC\_CACHEING preprocessor symbol for portability. + +\wxheading{See also} + +\helpref{wxDC::EnableCache}{wxdcenablecache}, \helpref{wxDC::ClearCache} +\end{comment} + + +\membersection{wxDC::CalcBoundingBox}\label{wxdccalcboundingbox} + +\func{void}{CalcBoundingBox}{\param{wxCoord }{x}, \param{wxCoord }{y}} + +Adds the specified point to the bounding box which can be retrieved with +\helpref{MinX}{wxdcminx}, \helpref{MaxX}{wxdcmaxx} and +\helpref{MinY}{wxdcminy}, \helpref{MaxY}{wxdcmaxy} functions. + +\wxheading{See also} + +\helpref{ResetBoundingBox}{wxdcresetboundingbox} -\helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask} \membersection{wxDC::Clear}\label{wxdcclear} @@ -110,14 +149,46 @@ wxheading{See also} Clears the device context using the current background brush. +\begin{comment} + +\membersection{wxDC::ClearCache}\label{wxdcclearcache} + +\func{static void}{ClearCache}{\void} + +On supported platforms (currently only Windows), clears +the contents of the DC cache (one bitmap and two Windows device contexts). The DC cache +can speed up the \helpref{Blit}{wxdcblit} operation when +drawing a large number of masked bitmaps. You should +call ClearCache at the end of length DC operations if you wish to only use +the cache transiently; you should also call it as your application exits. + +If using the cache functions in your code, please test for the +wxUSE\_DC\_CACHEING preprocessor symbol for portability. + +\wxheading{See also} + +\helpref{wxDC::EnableCache}{wxdcenablecache}, \helpref{wxDC::CacheEnabled} +\end{comment} + + +\membersection{wxDC::ComputeScaleAndOrigin}\label{wxdccomputescaleandorigin} + +\func{virtual void}{ComputeScaleAndOrigin}{\void} + +Performs all necessary computations for given platform and context type +after each change of scale and origin parameters. Usually called automatically +internally after such changes. + + \membersection{wxDC::CrossHair}\label{wxdccrosshair} -\func{void}{CrossHair}{\param{long}{ x}, \param{long}{ y}} +\func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}} 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 given point. + \membersection{wxDC::DestroyClippingRegion}\label{wxdcdestroyclippingregion} \func{void}{DestroyClippingRegion}{\void} @@ -125,37 +196,44 @@ on the given point. Destroys the current clipping region so that none of the DC is clipped. See also \helpref{wxDC::SetClippingRegion}{wxdcsetclippingregion}. + \membersection{wxDC::DeviceToLogicalX}\label{wxdcdevicetologicalx} -\func{long}{DeviceToLogicalX}{\param{long}{ x}} +\func{virtual wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}} Convert device X coordinate to logical coordinate, using the current mapping mode. + \membersection{wxDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel} -\func{long}{DeviceToLogicalXRel}{\param{long}{ x}} +\func{virtual wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}} Convert device X coordinate to relative logical coordinate, using the current -mapping mode. Use this function for converting a width, for example. +mapping mode but ignoring the x axis orientation. +Use this function for converting a width, for example. + \membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly} -\func{long}{DeviceToLogicalY}{\param{long}{ y}} +\func{virtual wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}} Converts device Y coordinate to logical coordinate, using the current mapping mode. + \membersection{wxDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel} -\func{long}{DeviceToLogicalYRel}{\param{long}{ y}} +\func{virtual wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}} Convert device Y coordinate to relative logical coordinate, using the current -mapping mode. Use this function for converting a height, for example. +mapping mode but ignoring the y axis orientation. +Use this function for converting a height, for example. + \membersection{wxDC::DrawArc}\label{wxdcdrawarc} -\func{void}{DrawArc}{\param{long}{ x1}, \param{long}{ y1}, \param{long}{ x2}, \param{long}{ y2}, \param{double}{ xc}, \param{double}{ yc}} +\func{void}{DrawArc}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ xc}, \param{wxCoord}{ yc}} Draws an arc of a circle, centred on ({\it xc, yc}), with starting point ({\it x1, y1}) and ending at ({\it x2, y2}). The current pen is used for the outline @@ -163,34 +241,71 @@ and the current brush for filling the shape. The arc is drawn in an anticlockwise direction from the start point to the end point. + \membersection{wxDC::DrawBitmap}\label{wxdcdrawbitmap} -\func{void}{DrawBitmap}{\param{const wxBitmap\&}{ bitmap}, \param{long}{ x}, \param{long}{ y}, \param{bool}{ transparent}} +\func{void}{DrawBitmap}{\param{const wxBitmap\&}{ bitmap}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{bool}{ transparent}} -Draw a bitmap on the device context at the specified point. If {\it transparent} is TRUE and the bitmap has +Draw a bitmap on the device context at the specified point. If {\it 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 \helpref{SetTextForeground}{wxdcsettextforeground}, +\helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}. + + +\membersection{wxDC::DrawCheckMark}\label{wxdcdrawcheckmark} + +\func{void}{DrawCheckMark}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}} + +\func{void}{DrawCheckMark}{\param{const wxRect \&}{rect}} + +Draws a check mark inside the given rectangle. + + +\membersection{wxDC::DrawCircle}\label{wxdcdrawcircle} + +\func{void}{DrawCircle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ radius}} + +\func{void}{DrawCircle}{\param{const wxPoint\&}{ pt}, \param{wxCoord}{ radius}} + +Draws a circle with the given centre and radius. + +\wxheading{See also} + +\helpref{DrawEllipse}{wxdcdrawellipse} + + \membersection{wxDC::DrawEllipse}\label{wxdcdrawellipse} -\func{void}{DrawEllipse}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}} +\func{void}{DrawEllipse}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}} + +\func{void}{DrawEllipse}{\param{const wxPoint\&}{ pt}, \param{const wxSize\&}{ size}} + +\func{void}{DrawEllipse}{\param{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. + +\wxheading{See also} + +\helpref{DrawCircle}{wxdcdrawcircle} -Draws an ellipse contained in the 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. \membersection{wxDC::DrawEllipticArc}\label{wxdcdrawellipticarc} -\func{void}{DrawEllipticArc}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}, +\func{void}{DrawEllipticArc}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ start}, \param{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. This function is currently only available for -X window and PostScript device contexts. +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. {\it x} and {\it y} specify the x and y coordinates of the upper-left corner of the rectangle that contains the ellipse. -{\it width} and {\it height} specify the width and height of the rectangle that contains +{\it width} and {\it height} specify the width and height of the rectangle that contains the ellipse. {\it start} and {\it end} specify the start and end of the arc relative to the three-o'clock @@ -199,37 +314,68 @@ in degrees (360 is a complete circle). Positive values mean counter-clockwise motion. If {\it start} is equal to {\it end}, a complete ellipse will be drawn. + \membersection{wxDC::DrawIcon}\label{wxdcdrawicon} -\func{void}{DrawIcon}{\param{const wxIcon\&}{ icon}, \param{long}{ x}, \param{long}{ y}} +\func{void}{DrawIcon}{\param{const wxIcon\&}{ icon}, \param{wxCoord}{ x}, \param{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. + +\membersection{wxDC::DrawLabel}\label{wxdcdrawlabel} + +\func{virtual void}{DrawLabel}{\param{const wxString\&}{ text}, + \param{const wxBitmap\&}{ image}, + \param{const wxRect\&}{ rect}, + \param{int}{ alignment = wxALIGN\_LEFT | wxALIGN\_TOP}, + \param{int}{ indexAccel = -1}, + \param{wxRect *}{rectBounding = NULL}} + +\func{void}{DrawLabel}{\param{const wxString\&}{ text}, \param{const wxRect\&}{ rect}, + \param{int}{ alignment = wxALIGN\_LEFT | wxALIGN\_TOP}, + \param{int}{ indexAccel = -1}} + +Draw optional bitmap and the text into the given rectangle and aligns it as specified +by alignment parameter; it also will emphasize the character with the given index if +it is != -1 and return the bounding rectangle if required. + + \membersection{wxDC::DrawLine}\label{wxdcdrawline} -\func{void}{DrawLine}{\param{long}{ x1}, \param{long}{ y1}, \param{long}{ x2}, \param{long}{ y2}} +\func{void}{DrawLine}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}} Draws a line from the first point to the second. The current pen is used -for drawing the line. +for drawing the line. Note that the point $(x2, y2)$ is {\emph not} part of the +line and is not drawn by this function (this is consistent with the behaviour +of many other toolkits). + \membersection{wxDC::DrawLines}\label{wxdcdrawlines} -\func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{long}{ xoffset = 0}, \param{long}{ yoffset = 0}} +\func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}} -\func{void}{DrawLines}{\param{wxList *}{points}, \param{long}{ xoffset = 0}, \param{long}{ yoffset = 0}} +\func{void}{DrawLines}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}} Draws lines using an array of {\it points} of size {\it 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. +\pythonnote{The wxPython version of this method accepts a Python list +of wxPoint objects.} + +\perlnote{The wxPerl version of this method accepts + as its first parameter a reference to an array + of wxPoint objects.} + + \membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon} -\func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{long}{ xoffset = 0}, \param{long}{ yoffset = 0},\\ +\func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\ \param{int }{fill\_style = wxODDEVEN\_RULE}} -\func{void}{DrawPolygon}{\param{wxList *}{points}, \param{long}{ xoffset = 0}, \param{long}{ yoffset = 0},\\ +\func{void}{DrawPolygon}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\ \param{int }{fill\_style = wxODDEVEN\_RULE}} Draws a filled polygon using an array of {\it points} of size {\it n}, @@ -242,25 +388,83 @@ 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. +Note that wxWidgets automatically closes the first and last points. + +\pythonnote{The wxPython version of this method accepts a Python list +of wxPoint objects.} + +\perlnote{The wxPerl version of this method accepts + as its first parameter a reference to an array + of wxPoint objects.} + + +\membersection{wxDC::DrawPolyPolygon}\label{wxdcdrawpolypolygon} + +\func{void}{DrawPolyPolygon}{\param{int}{ n}, \param{int}{ count[]}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\ + \param{int }{fill\_style = wxODDEVEN\_RULE}} + +Draws two or more filled polygons using an array of {\it points}, adding the +optional offset coordinates. + +Notice that for the platforms providing a native implementation +of this function (Windows and PostScript-based wxDC currently), this is more +efficient than using \helpref{DrawPolygon}{wxdcdrawpolygon} in a loop. + +{\it n} specifies the number of polygons to draw, the array {\it count} of size +{\it n} specifies the number of points in each of the polygons in the +{\it points} array. + +The last argument specifies the fill rule: {\bf wxODDEVEN\_RULE} (the default) +or {\bf 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 polygons maybe disjoint or overlapping. Each polygon specified in a call to +{\bf DrawPolyPolygon} must be closed. Unlike polygons created by the +\helpref{DrawPolygon}{wxdcdrawpolygon} member function, the polygons created by +{\bf DrawPolyPolygon} are not closed automatically. + +\pythonnote{Not implemented yet} + +\perlnote{Not implemented yet} + \membersection{wxDC::DrawPoint}\label{wxdcdrawpoint} -\func{void}{DrawPoint}{\param{long}{ x}, \param{long}{ y}} +\func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}} + +Draws a point using the color of the current pen. Note that the other properties of the pen are not used, such as width etc.. -Draws a point using the current pen. \membersection{wxDC::DrawRectangle}\label{wxdcdrawrectangle} -\func{void}{DrawRectangle}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}} +\func{void}{DrawRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{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. + +\membersection{wxDC::DrawRotatedText}\label{wxdcdrawrotatedtext} + +\func{void}{DrawRotatedText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{double}{ angle}} + +Draws the text rotated by {\it angle} degrees. + +{\bf NB:} Under Win9x only TrueType fonts can be drawn by this function. In +particular, a font different from {\tt wxNORMAL\_FONT} should be used as the +latter is not a TrueType font. {\tt wxSWISS\_FONT} is an example of a font +which is. + +\wxheading{See also} + +\helpref{DrawText}{wxdcdrawtext} + + \membersection{wxDC::DrawRoundedRectangle}\label{wxdcdrawroundedrectangle} -\func{void}{DrawRoundedRectangle}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}, \param{double}{ radius = 20}} +\func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius}} Draws a rectangle with the given top left corner, and with the given size. The corners are quarter-circles using the given radius. The @@ -275,22 +479,33 @@ 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. + \membersection{wxDC::DrawSpline}\label{wxdcdrawspline} +\func{void}{DrawSpline}{\param{int }{n}, \param{wxPoint }{points[]}} + +Draws a spline between all given control points, using the current +pen. + \func{void}{DrawSpline}{\param{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'. +pen. Doesn't delete the wxList and contents. -\func{void}{DrawSpline}{\param{long}{ x1}, \param{long}{ y1}, \param{long}{ x2}, \param{long}{ y2}, \param{long}{ x3}, \param{long}{ y3}} +\func{void}{DrawSpline}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ x3}, \param{wxCoord}{ y3}} Draws a three-point spline using the current pen. +\pythonnote{The wxPython version of this method accepts a Python list +of wxPoint objects.} + +\perlnote{The wxPerl version of this method accepts a reference to an array + of wxPoint objects.} + + \membersection{wxDC::DrawText}\label{wxdcdrawtext} -\func{void}{DrawText}{\param{const wxString\& }{text}, \param{long}{ x}, \param{long}{ y}} +\func{void}{DrawText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}} Draws a text string at the specified point, using the current text font, and the current text foreground and background colours. @@ -300,19 +515,36 @@ the string. See \helpref{wxDC::GetTextExtent}{wxdcgettextextent} for how to get the dimensions of a text string, which can be used to position the text more precisely. +{\bf NB:} under wxGTK the current +\helpref{logical function}{wxdcgetlogicalfunction} is used by this function +but it is ignored by wxMSW. Thus, you should avoid using logical functions +with this function in portable programs. + +\begin{comment} + +\membersection{wxDC::EnableCache}\label{wxdcenablecache} + +\func{static void}{EnableCache}{\param{bool}{ enableCache}} + +On supported platforms (currently only Windows), enables the DC cache +which can speed up the \helpref{Blit}{wxdcblit} operation when +drawing a large number of masked bitmaps. + +If using the cache functions in your code, please test for the +wxUSE\_DC\_CACHEING preprocessor symbol for portability. + +\wxheading{See also} + +\helpref{wxDC::CacheEnabled}{wxdccacheenabled}, \helpref{wxDC::ClearCache} +\end{comment} + + \membersection{wxDC::EndDoc}\label{wxdcenddoc} \func{void}{EndDoc}{\void} Ends a document (only relevant when outputting to a printer). -\membersection{wxDC::EndDrawing}\label{wxdcenddrawing} - -\func{void}{EndDrawing}{\void} - -Allows optimization of drawing code under MS Windows. Enclose -drawing primitives between {\bf BeginDrawing} and {\bf EndDrawing}\rtfsp -calls. \membersection{wxDC::EndPage}\label{wxdcendpage} @@ -320,55 +552,101 @@ calls. Ends a document page (only relevant when outputting to a printer). + \membersection{wxDC::FloodFill}\label{wxdcfloodfill} -\func{void}{FloodFill}{\param{long}{ x}, \param{long}{ y}, \param{wxColour *}{colour}, \param{int}{ style=wxFLOOD\_SURFACE}} +\func{bool}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const wxColour\&}{ colour}, \param{int}{ style=wxFLOOD\_SURFACE}} -Flood fills the device context starting from the given point, in the given colour, -and using a style: +Flood fills the device context starting from the given point, using +the {\it current brush colour}, and using a style: \begin{itemize}\itemsep=0pt \item wxFLOOD\_SURFACE: the flooding occurs until a colour other than the given colour is encountered. \item wxFLOOD\_BORDER: the area to be flooded is bounded by the given colour. \end{itemize} -{\it Note:} this function is available in MS Windows only. +Returns false if the operation failed. + +{\it Note:} The present implementation for non-Windows platforms may fail to find +colour borders if the pixels do not match the colour exactly. However the +function will still return true. + \membersection{wxDC::GetBackground}\label{wxdcgetbackground} -\func{wxBrush\&}{GetBackground}{\void} +\constfunc{const wxBrush\&}{GetBackground}{\void} Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}). + +\membersection{wxDC::GetBackgroundMode}\label{wxdcgetbackgroundmode} + +\constfunc{int}{GetBackgroundMode}{\void} + +Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}. + +\wxheading{See also} + +\helpref{SetBackgroundMode}{wxdcsetbackgroundmode} + + \membersection{wxDC::GetBrush}\label{wxdcgetbrush} -\func{wxBrush\&}{GetBrush}{\void} +\constfunc{const wxBrush\&}{GetBrush}{\void} Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}). + \membersection{wxDC::GetCharHeight}\label{wxdcgetcharheight} -\func{long}{GetCharHeight}{\void} +\func{wxCoord}{GetCharHeight}{\void} Gets the character height of the currently set font. + \membersection{wxDC::GetCharWidth}\label{wxdcgetcharwidth} -\func{long}{GetCharWidth}{\void} +\func{wxCoord}{GetCharWidth}{\void} Gets the average character width of the currently set font. + \membersection{wxDC::GetClippingBox}\label{wxdcgetclippingbox} -\func{void}{GetClippingBox}{\param{long}{ *x}, \param{long}{ *y}, \param{long}{ *width}, \param{long}{ *height}} +\func{void}{GetClippingBox}{\param{wxCoord}{ *x}, \param{wxCoord}{ *y}, \param{wxCoord}{ *width}, \param{wxCoord}{ *height}} Gets the rectangle surrounding the current clipping region. +\pythonnote{No arguments are required and the four values defining the +rectangle are returned as a tuple.} + +\perlnote{This method takes no arguments and returns a four element list +{\tt ( x, y, width, height )}} + + \membersection{wxDC::GetFont}\label{wxdcgetfont} -\func{wxFont\&}{GetFont}{\void} +\constfunc{const wxFont\&}{GetFont}{\void} + +Gets the current font. Notice that even although each device context object has +some default font after creation, this method would return a \texttt{wxNullFont} +initially and only after calling \helpref{wxDC::SetFont}{wxdcsetfont} a valid +font is returned. + + +\membersection{wxDC::GetLayoutDirection}\label{wxdcgetlayoutdirection} + +\constfunc{wxLayoutDirection}{GetLayoutDirection}{\void} + +Gets the current layout direction of the device context. On platforms where RTL layout +is supported, the return value will either be \texttt{wxLayout\_LeftToRight} or +\texttt{wxLayout\_RightToLeft}. If RTL layout is not supported, the return value will +be \texttt{wxLayout\_Default}. + +\wxheading{See also} + +\helpref{SetLayoutDirection}{wxdcsetlayoutdirection} -Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}). \membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction} @@ -376,152 +654,328 @@ Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}). Gets the current logical function (see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}). + \membersection{wxDC::GetMapMode}\label{wxdcgetmapmode} \func{int}{GetMapMode}{\void} Gets the {\it mapping mode} for the device context (see \helpref{wxDC::SetMapMode}{wxdcsetmapmode}). -\membersection{wxDC::GetOptimization}\label{wxdcgetoptimization} -\func{bool}{GetOptimization}{\void} +\membersection{wxDC::GetMultiLineTextExtent}\label{wxdcgetmultilinetextextent} + +\constfunc{void}{GetMultiLineTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w},\\ + \param{wxCoord *}{h}, \param{wxCoord *}{heightLine = NULL}, \param{wxFont *}{font = NULL}} + +\constfunc{wxSize}{GetMultiLineTextExtent}{\param{const wxString\& }{string}} + +Gets the dimensions of the string using the currently selected font. +\rtfsp{\it string} is the text string to measure, {\it heightLine}, if non NULL, +is where to store the height of a single line. + +The text extent is returned in {\it w} and {\it h} pointers (first form) or as +a \helpref{wxSize}{wxsize} object (second form). + +If the optional parameter {\it font} is specified and valid, then it is used +for the text extent calculation. Otherwise the currently selected font is. + +Note that this function works both with single-line and multi-line strings. + +\wxheading{See also} + +\helpref{wxFont}{wxfont},\rtfsp +\helpref{wxDC::SetFont}{wxdcsetfont},\rtfsp +\helpref{wxDC::GetPartialTextExtents}{wxdcgetpartialtextextents},\rtfsp +\helpref{wxDC::GetTextExtent}{wxdcgettextextent} + + +\membersection{wxDC::GetPartialTextExtents}\label{wxdcgetpartialtextextents} + +\constfunc{bool}{GetPartialTextExtents}{\param{const wxString\& }{text}, +\param{wxArrayInt\& }{widths}} + +Fills the {\it widths} array with the widths from the beginning of +{\it text} to the corresponding character of {\it text}. The generic +version simply builds a running total of the widths of each character +using \helpref{GetTextExtent}{wxdcgettextextent}, however if the +various platforms have a native API function that is faster or more +accurate than the generic implementation then it should be used +instead. + +\wxheading{See also} + +\helpref{wxDC::GetMultiLineTextExtent}{wxdcgetmultilinetextextent},\rtfsp +\helpref{wxDC::GetTextExtent}{wxdcgettextextent} + +\pythonnote{This method only takes the {\it text} parameter and + returns a Python list of integers.} -Returns TRUE if device context optimization is on. -See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details. \membersection{wxDC::GetPen}\label{wxdcgetpen} -\func{wxPen\&}{GetPen}{\void} +\constfunc{const wxPen\&}{GetPen}{\void} Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}). + \membersection{wxDC::GetPixel}\label{wxdcgetpixel} -\func{bool}{GetPixel}{\param{long}{ x}, \param{long}{ y}, \param{wxColour *}{colour}} +\func{bool}{GetPixel}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}} + +Gets in {\it colour} the colour at the specified location. +Not available for wxPostScriptDC or wxMetafileDC. + +Note that setting a pixel can be done using \helpref{DrawPoint}{wxdcdrawpoint}. + +\pythonnote{For wxPython the wxColour value is returned and is not +required as a parameter.} + +\perlnote{This method only takes the parameters {\tt x} and {\tt y} and returns +a Wx::Colour value} -Sets {\it colour} to the colour at the specified location. Windows only; an X implementation -is being worked on. Not available for wxPostScriptDC or wxMetafileDC. +\membersection{wxDC::GetPPI}\label{wxdcgetppi} + +\constfunc{wxSize}{GetPPI}{\void} + +Returns the resolution of the device in pixels per inch. \membersection{wxDC::GetSize}\label{wxdcgetsize} -\func{void}{GetSize}{\param{long *}{width}, \param{long *}{height}} +\constfunc{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}} -For a PostScript device context, this gets the maximum size of graphics -drawn so far on the device context. +\constfunc{wxSize}{GetSize}{\void} -For a Windows printer device context, this gets the horizontal and vertical -resolution. It can be used to scale graphics to fit the page when using -a Windows printer device context. For example, if {\it maxX} and {\it maxY}\rtfsp +This gets the horizontal and vertical resolution in device units. It can be used to scale graphics to fit the page. +For example, if {\it maxX} and {\it maxY}\rtfsp represent the maximum horizontal and vertical `pixel' values used in your application, the following code will scale the graphic to fit on the printer page: \begin{verbatim} - long w, h; + wxCoord w, h; dc.GetSize(&w, &h); double scaleX=(double)(maxX/w); double scaleY=(double)(maxY/h); dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY)); \end{verbatim} +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf GetSize()}}{Returns a wxSize} +\twocolitem{{\bf GetSizeTuple()}}{Returns a 2-tuple (width, height)} +\end{twocollist}} +} + +\perlnote{In place of a single overloaded method, wxPerl uses:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf GetSize()}}{Returns a Wx::Size} +\twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list + {\tt ( width, height )}} +\end{twocollist} +}} + +\membersection{wxDC::GetSizeMM}\label{wxdcgetsizemm} + +\constfunc{void}{GetSizeMM}{\param{wxCoord *}{width}, \param{wxCoord *}{height}} + +\constfunc{wxSize}{GetSizeMM}{\void} + +Returns the horizontal and vertical resolution in millimetres. + \membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground} -\func{wxColour\&}{GetTextBackground}{\void} +\constfunc{const wxColour\&}{GetTextBackground}{\void} Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}). + \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent} -\func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{long *}{w}, \param{long *}{h},\\ - \param{long *}{descent = NULL}, \param{long *}{externalLeading = NULL}, \param{wxFont *}{font = NULL}} +\constfunc{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\ + \param{wxCoord *}{descent = NULL}, \param{wxCoord *}{externalLeading = NULL}, \param{const wxFont *}{font = NULL}} + +\constfunc{wxSize}{GetTextExtent}{\param{const wxString\& }{string}} Gets the dimensions of the string using the currently selected font. -\rtfsp{\it string} is the text string to measure, {\it w} and {\it h} are -the total width and height respectively, {\it descent} is the +\rtfsp{\it string} is the text string to measure, {\it descent} is the dimension from the baseline of the font to the bottom of the descender, and {\it externalLeading} is any extra vertical space added to the font by the font designer (usually is zero). -The optional parameter {\it 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. +The text extent is returned in {\it w} and {\it h} pointers (first form) or as +a \helpref{wxSize}{wxsize} object (second form). + +If the optional parameter {\it font} is specified and valid, then it is used +for the text extent calculation. Otherwise the currently selected font is. + +Note that this function only works with single-line strings. + +\wxheading{See also} + +\helpref{wxFont}{wxfont},\rtfsp +\helpref{wxDC::SetFont}{wxdcsetfont},\rtfsp +\helpref{wxDC::GetPartialTextExtents}{wxdcgetpartialtextextents},\rtfsp +\helpref{wxDC::GetMultiLineTextExtent}{wxdcgetmultilinetextextent} + +\pythonnote{The following methods are implemented in wxPython:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf GetTextExtent(string)}}{Returns a 2-tuple, (width, height)} +\twocolitem{{\bf GetFullTextExtent(string, font=NULL)}}{Returns a +4-tuple, (width, height, descent, externalLeading) } +\end{twocollist}} +} + +\perlnote{In wxPerl this method is implemented as + {\bf GetTextExtent( string, font = undef )} returning a four element + array {\tt ( width, height, descent, externalLeading )} +} -See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}. \membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground} -\func{wxColour\&}{GetTextForeground}{\void} +\constfunc{const wxColour\&}{GetTextForeground}{\void} Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}). + +\membersection{wxDC::GetUserScale}\label{wxdcgetuserscale} + +\func{void}{GetUserScale}{\param{double}{ *x}, \param{double}{ *y}} + +Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}). + +\perlnote{In wxPerl this method takes no arguments and return a two element + array {\tt ( x, y )}} + + +\membersection{wxDC::GradientFillConcentric}\label{wxdcgradientfillconcentric} + +\func{void}{GradientFillConcentric}{\param{const wxRect\&}{ rect}, \param{const wxColour\&}{ initialColour}, \param{const wxColour\&}{ destColour}} + +\func{void}{GradientFillConcentric}{\param{const wxRect\&}{ rect}, \param{const wxColour\&}{ initialColour}, \param{const wxColour\&}{ destColour}, \param{const wxPoint\& }{circleCenter}} + +Fill the area specified by rect with a radial gradient, starting from +\arg{initialColour} at the centre of the circle and fading to \arg{destColour} +on the circle outside. + +\arg{circleCenter} are the relative coordinates of centre of the circle in +the specified \arg{rect}. If not specified, the cercle is placed at the +centre of rect. + +\textbf{Note: } Currently this function is very slow, don't use it for +real-time drawing. + + +\membersection{wxDC::GradientFillLinear}\label{wxdcgradientfilllinear} + +\func{void}{GradientFillLinear}{\param{const wxRect\&}{ rect}, \param{const wxColour\&}{ initialColour}, \param{const wxColour\&}{ destColour}, \param{wxDirection}{ nDirection = wxEAST}} + +Fill the area specified by \arg{rect} with a linear gradient, starting from +\arg{initialColour} and eventually fading to \arg{destColour}. The +\arg{nDirection} specifies the direction of the colour change, default is to +use \arg{initialColour} on the left part of the rectangle and +\arg{destColour} on the right one. + + \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex} -\func{long}{LogicalToDeviceX}{\param{long}{ x}} +\func{virtual wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}} Converts logical X coordinate to device coordinate, using the current mapping mode. + \membersection{wxDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel} -\func{long}{LogicalToDeviceXRel}{\param{long}{ x}} +\func{virtual wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}} Converts logical X coordinate to relative device coordinate, using the current -mapping mode. Use this for converting a width, for example. +mapping mode but ignoring the x axis orientation. +Use this for converting a width, for example. + \membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey} -\func{long}{LogicalToDeviceY}{\param{long}{ y}} +\func{virtual wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}} Converts logical Y coordinate to device coordinate, using the current mapping mode. + \membersection{wxDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel} -\func{long}{LogicalToDeviceYRel}{\param{long}{ y}} +\func{virtual wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}} Converts logical Y coordinate to relative device coordinate, using the current -mapping mode. Use this for converting a height, for example. +mapping mode but ignoring the y axis orientation. +Use this for converting a height, for example. + \membersection{wxDC::MaxX}\label{wxdcmaxx} -\func{long}{MaxX}{\void} +\func{wxCoord}{MaxX}{\void} Gets the maximum horizontal extent used in drawing commands so far. + \membersection{wxDC::MaxY}\label{wxdcmaxy} -\func{long}{MaxY}{\void} +\func{wxCoord}{MaxY}{\void} Gets the maximum vertical extent used in drawing commands so far. + \membersection{wxDC::MinX}\label{wxdcminx} -\func{long}{MinX}{\void} +\func{wxCoord}{MinX}{\void} Gets the minimum horizontal extent used in drawing commands so far. + \membersection{wxDC::MinY}\label{wxdcminy} -\func{long}{MinY}{\void} +\func{wxCoord}{MinY}{\void} Gets the minimum vertical extent used in drawing commands so far. -\membersection{wxDC::Ok}\label{wxdcok} + +\membersection{wxDC::IsOk}\label{wxdcisok} \func{bool}{Ok}{\void} -Returns TRUE if the DC is ok to use. +Returns true if the DC is ok to use. -\membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin} -\func{void}{SetDeviceOrigin}{\param{long}{ x}, \param{long}{ y}} +\membersection{wxDC::ResetBoundingBox}\label{wxdcresetboundingbox} -Sets the device origin (i.e., the origin in pixels after scaling has been -applied). +\func{void}{ResetBoundingBox}{\void} + +Resets the bounding box: after a call to this function, the bounding box +doesn't contain anything. + +\wxheading{See also} + +\helpref{CalcBoundingBox}{wxdccalcboundingbox} + + +\membersection{wxDC::SetAxisOrientation}\label{wxdcsetaxisorientation} + +\func{void}{SetAxisOrientation}{\param{bool}{ xLeftRight}, + \param{bool}{ yBottomUp}} + +Sets the x and y axis orientation (i.e., the direction from lowest to +highest values on the axis). The default orientation is +x axis from left to right and y axis from top down. + +\wxheading{Parameters} + +\docparam{xLeftRight}{True to set the x axis orientation to the natural +left to right orientation, false to invert it.} + +\docparam{yBottomUp}{True to set the y axis orientation to the natural +bottom up orientation, false to invert it.} -This function may be useful in Windows printing -operations for placing a graphic on a page. \membersection{wxDC::SetBackground}\label{wxdcsetbackground} @@ -529,6 +983,7 @@ operations for placing a graphic on a page. Sets the current background brush for the DC. + \membersection{wxDC::SetBackgroundMode}\label{wxdcsetbackgroundmode} \func{void}{SetBackgroundMode}{\param{int}{ mode}} @@ -536,54 +991,80 @@ Sets the current background brush for the DC. {\it mode} may be one of wxSOLID and wxTRANSPARENT. This setting determines whether text will be drawn with a background colour or not. + +\membersection{wxDC::SetBrush}\label{wxdcsetbrush} + +\func{void}{SetBrush}{\param{const wxBrush\& }{brush}} + +Sets the current brush for the DC. + +If the argument is wxNullBrush, the current brush is selected out of the device +context (leaving wxDC without any valid brush), allowing the current brush to +be destroyed safely. + +See also \helpref{wxBrush}{wxbrush}. + +See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours +when drawing into a monochrome bitmap. + + \membersection{wxDC::SetClippingRegion}\label{wxdcsetclippingregion} -\func{void}{SetClippingRegion}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}} +\func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}} + +\func{void}{SetClippingRegion}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}} + +\func{void}{SetClippingRegion}{\param{const wxRect\&}{ rect}} \func{void}{SetClippingRegion}{\param{const wxRegion\&}{ region}} -Sets the clipping region for the DC. The clipping region is an area -to which drawing is restricted. Possible uses for the clipping region are for clipping text -or for speeding up window redraws when only a known area of the screen is damaged. +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. You should call +\helpref{DestroyClippingRegion}{wxdcdestroyclippingregion} if you want to set +the clipping region exactly to the region specified. + +The clipping region is an area to which drawing is restricted. Possible uses +for the clipping region are for clipping text or for speeding up window redraws +when only a known area of the screen is damaged. \wxheading{See also} \helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion} -\membersection{wxDC::SetPalette}\label{wxdcsetpalette} -\func{void}{SetPalette}{\param{const wxPalette\& }{palette}} +\membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin} -If this is a window DC or memory DC, assigns the given palette to the window -or bitmap associated with the DC. If the argument is wxNullPalette, the current -palette is selected out of the device context, and the original palette -restored. +\func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}} -See \helpref{wxPalette}{wxpalette} for further details. +Sets the device origin (i.e., the origin in pixels after scaling has been +applied). -\membersection{wxDC::SetBrush}\label{wxdcsetbrush} +This function may be useful in Windows printing +operations for placing a graphic on a page. -\func{void}{SetBrush}{\param{const wxBrush\& }{brush}} -Sets the current brush for the DC. +\membersection{wxDC::SetFont}\label{wxdcsetfont} -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. +\func{void}{SetFont}{\param{const wxFont\& }{font}} -See also \helpref{wxBrush}{wxbrush}. +Sets the current font for the DC. It must be a valid font, in particular you +should not pass {\tt wxNullFont} to this method. -\membersection{wxDC::SetFont}\label{wxdcsetfont} +See also \helpref{wxFont}{wxfont}. -\func{void}{SetFont}{\param{const wxFont\& }{font}} -Sets the current font for the DC. +\membersection{wxDC::SetLayoutDirection}\label{wxdcsetlayoutdirection} -If the argument is wxNullFont, the current font is selected out of the device -context, and the original font restored, allowing the current font to -be destroyed safely. +\func{void}{SetLayoutDirection}{\param{wxLayoutDirection}{ dir}} + +Sets the current layout direction for the device context. \arg{dir} may be either +\texttt{wxLayout\_Default}, \texttt{wxLayout\_LeftToRight} or \texttt{wxLayout\_RightToLeft}. + +\wxheading{See also} + +\helpref{GetLayoutDirection}{wxdcgetlayoutdirection} -See also \helpref{wxFont}{wxfont}. \membersection{wxDC::SetLogicalFunction}\label{wxdcsetlogicalfunction} @@ -619,9 +1100,10 @@ wxXOR src XOR dst The default is wxCOPY, which simply draws with the current colour. The others combine the current colour and the background using a -logical operation. wxXOR is commonly used for drawing rubber bands or +logical operation. wxINVERT is commonly used for drawing rubber bands or moving outlines, since drawing twice reverts to the original colour. + \membersection{wxDC::SetMapMode}\label{wxdcsetmapmode} \func{void}{SetMapMode}{\param{int}{ int}} @@ -631,40 +1113,37 @@ 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 {\it user scale} (see \helpref{wxDC::SetUserScale}{wxdcsetuserscale}) scales the text appropriately. In -Windows, scaleable TrueType fonts are always used; in X, results depend +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. +The coordinate origin 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. +Drawing to a Windows printer device context uses the current mapping mode, +but mapping mode is currently ignored for PostScript output. The mapping mode can be one of the following: \begin{twocollist}\itemsep=0pt -\twocolitem{MM\_TWIPS}{Each logical unit is 1/20 of a point, or 1/1440 of +\twocolitem{wxMM\_TWIPS}{Each logical unit is 1/20 of a point, or 1/1440 of an inch.} -\twocolitem{MM\_POINTS}{Each logical unit is a point, or 1/72 of an inch.} -\twocolitem{MM\_METRIC}{Each logical unit is 1 mm.} -\twocolitem{MM\_LOMETRIC}{Each logical unit is 1/10 of a mm.} -\twocolitem{MM\_TEXT}{Each logical unit is 1 pixel.} +\twocolitem{wxMM\_POINTS}{Each logical unit is a point, or 1/72 of an inch.} +\twocolitem{wxMM\_METRIC}{Each logical unit is 1 mm.} +\twocolitem{wxMM\_LOMETRIC}{Each logical unit is 1/10 of a mm.} +\twocolitem{wxMM\_TEXT}{Each logical unit is 1 pixel.} \end{twocollist} -\membersection{wxDC::SetOptimization}\label{wxsetoptimization} -\func{void}{SetOptimization}{\param{bool }{optimize}} +\membersection{wxDC::SetPalette}\label{wxdcsetpalette} -If {\it optimize} is TRUE (the default), this function sets optimization mode on. -This currently means that under X, the device context will not try to set a pen or brush -property if it is known to be set already. This approach can fall down -if non-wxWindows code is using the same device context or window, for example -when the window is a panel on which the windowing system draws panel items. -The wxWindows device context 'memory' will now be out of step with reality. +\func{void}{SetPalette}{\param{const wxPalette\& }{palette}} + +If this is a window DC or memory DC, assigns the given palette to the window +or bitmap associated with the DC. If the argument is wxNullPalette, the current +palette is selected out of the device context, and the original palette +restored. + +See \helpref{wxPalette}{wxpalette} for further details. -Setting optimization off, drawing, then setting it back on again, is a trick -that must occasionally be employed. \membersection{wxDC::SetPen}\label{wxdcsetpen} @@ -673,7 +1152,12 @@ that must occasionally be employed. 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. +context (leaving wxDC without any valid pen), allowing the current brush to +be destroyed safely. + +See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours +when drawing into a monochrome bitmap. + \membersection{wxDC::SetTextBackground}\label{wxdcsettextbackground} @@ -681,12 +1165,17 @@ context, and the original pen restored. Sets the current text background colour for the DC. + \membersection{wxDC::SetTextForeground}\label{wxdcsettextforeground} \func{void}{SetTextForeground}{\param{const wxColour\& }{colour}} Sets the current text foreground colour for the DC. +See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours +when drawing into a monochrome bitmap. + + \membersection{wxDC::SetUserScale}\label{wxdcsetuserscale} \func{void}{SetUserScale}{\param{double}{ xScale}, \param{double}{ yScale}} @@ -694,12 +1183,14 @@ Sets the current text foreground colour for the DC. Sets the user scaling factor, useful for applications which require `zooming'. + \membersection{wxDC::StartDoc}\label{wxdcstartdoc} \func{bool}{StartDoc}{\param{const wxString\& }{message}} Starts a document (only relevant when outputting to a printer). -Message is a message to show whilst printing. +Message is a message to show while printing. + \membersection{wxDC::StartPage}\label{wxdcstartpage} @@ -707,3 +1198,84 @@ Message is a message to show whilst printing. Starts a document page (only relevant when outputting to a printer). + +\membersection{wxDC::StretchBlit}\label{wxdcstretchblit} + +\func{bool}{StretchBlit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ dstWidth}, \param{wxCoord}{ dstHeight}, + \param{wxDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{wxCoord}{ srcWidth}, \param{wxCoord}{ srcHeight}, + \param{int}{ logicalFunc = wxCOPY}, \param{bool }{useMask = false}, \param{wxCoord}{ xsrcMask = -1}, \param{wxCoord}{ ysrcMask = -1}} + +Copy from a source DC to this DC, specifying the destination +coordinates, destination size, source DC, source coordinates, +size of source area to copy, logical function, whether to use a bitmap mask, +and mask source position. + +\wxheading{Parameters} + +\docparam{xdest}{Destination device context x position.} + +\docparam{ydest}{Destination device context y position.} + +\docparam{dstWidth}{Width of destination area.} + +\docparam{dstHeight}{Height of destination area.} + +\docparam{source}{Source device context.} + +\docparam{xsrc}{Source device context x position.} + +\docparam{ysrc}{Source device context y position.} + +\docparam{srcWidth}{Width of source area to be copied.} + +\docparam{srcHeight}{Height of source area to be copied.} + +\docparam{logicalFunc}{Logical function to use: see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}.} + +\docparam{useMask}{If true, Blit does a transparent blit using the mask that is associated with the bitmap +selected into the source device context. The Windows implementation does the following if \texttt{MaskBlt} cannot be used: + +\begin{enumerate} +\item Creates a temporary bitmap and copies the destination area into it. +\item Copies the source area into the temporary bitmap using the specified logical function. +\item Sets the masked area in the temporary bitmap to BLACK by ANDing the +mask bitmap with the temp bitmap with the foreground colour set to WHITE +and the background colour set to BLACK. +\item Sets the unmasked area in the destination area to BLACK by ANDing the +mask bitmap with the destination area with the foreground colour set to BLACK +and the background colour set to WHITE. +\item ORs the temporary bitmap with the destination area. +\item Deletes the temporary bitmap. +\end{enumerate} + +This sequence of operations ensures that the source's transparent area need not be black, +and logical functions are supported. + +{\bf Note:} on Windows, blitting with masks can be speeded up considerably by compiling +wxWidgets with the \texttt{wxUSE\_DC\_CACHE} option enabled. You can also influence whether \texttt{MaskBlt} +or the explicit mask blitting code above is used, by using \helpref{wxSystemOptions}{wxsystemoptions} and +setting the {\bf no-maskblt} option to 1. + +} + +\docparam{xsrcMask}{Source x position on the mask. If both xsrcMask and ysrcMask are -1, xsrc and ysrc +will be assumed for the mask source position. Currently only implemented on Windows.} + +\docparam{ysrcMask}{Source y position on the mask. If both xsrcMask and ysrcMask are -1, xsrc and ysrc +will be assumed for the mask source position. Currently only implemented on Windows.} + + +\wxheading{Remarks} + +There is partial support for Blit in wxPostScriptDC, under X. + +wxDC::StretchBlit is only implemented under wxMAC and wxMSW. + +See \helpref{wxMemoryDC}{wxmemorydc} for typical usage. + +\newsince{2.9.0} + +\wxheading{See also} + +\helpref{wxDC::Blit}{wxdcblit}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask} +