X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b8de493fbdba4c710a66f2e8aad290ce78550fc4..2f382cc6be31beb297ce62e41f3ed68e66e36980:/docs/latex/wx/dc.tex diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index 333d6355b7..5a3caed12a 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -13,6 +13,10 @@ only, so refer to this section for most device context information. \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{See also} \helpref{Overview}{dcoverview} @@ -48,9 +52,9 @@ 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}} Copy from a source DC to this DC, specifying the destination coordinates, size of area to copy, source DC, source coordinates, and @@ -100,10 +104,22 @@ There is partial support for Blit in wxPostScriptDC, under X. See \helpref{wxMemoryDC}{wxmemorydc} for typical usage. -wxheading{See also} +\wxheading{See also} \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask} +\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} + \membersection{wxDC::Clear}\label{wxdcclear} \func{void}{Clear}{\void} @@ -112,7 +128,7 @@ Clears the device context using the current background brush. \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 @@ -127,35 +143,35 @@ See also \helpref{wxDC::SetClippingRegion}{wxdcsetclippingregion}. \membersection{wxDC::DeviceToLogicalX}\label{wxdcdevicetologicalx} -\func{long}{DeviceToLogicalX}{\param{long}{ x}} +\func{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{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. \membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly} -\func{long}{DeviceToLogicalY}{\param{long}{ y}} +\func{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{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. \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{double}{ xc}, \param{double}{ 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,9 +179,29 @@ 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{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 +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::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}} 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 @@ -173,17 +209,17 @@ 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 +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. {\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 @@ -194,35 +230,38 @@ 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::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. \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.} + \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}, @@ -237,23 +276,36 @@ The programmer is responsible for deleting the list of points. Note that wxWindows automatically closes the first and last points. +\pythonnote{The wxPython version of this method accepts a Python list +of wxPoint objects.} + \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 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. + +\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 = 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 @@ -277,13 +329,16 @@ 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'. -\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.} + \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. @@ -293,6 +348,11 @@ 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. + \membersection{wxDC::EndDoc}\label{wxdcenddoc} \func{void}{EndDoc}{\void} @@ -315,7 +375,7 @@ 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{void}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{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: @@ -329,37 +389,56 @@ and using a style: \membersection{wxDC::GetBackground}\label{wxdcgetbackground} -\func{wxBrush *}{GetBackground}{\void} +\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} +\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.} + \membersection{wxDC::GetFont}\label{wxdcgetfont} -\func{wxFont *}{GetFont}{\void} +\func{wxFont\&}{GetFont}{\void} + +\constfunc{const wxFont\&}{GetFont}{\void} Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}). @@ -384,20 +463,25 @@ See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details. \membersection{wxDC::GetPen}\label{wxdcgetpen} -\func{wxPen *}{GetPen}{\void} +\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}} 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. +is being worked on. Not available for wxPostScriptDC or wxMetafileDC. + +\pythonnote{For wxPython the wxColour value is returned and is not +required as a parameter.} \membersection{wxDC::GetSize}\label{wxdcgetsize} -\func{void}{GetSize}{\param{long *}{width}, \param{long *}{height}} +\func{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. @@ -410,23 +494,33 @@ 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}} +} + \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}} +\func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\ + \param{wxCoord *}{descent = NULL}, \param{wxCoord *}{externalLeading = NULL}, \param{wxFont *}{font = NULL}} 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 @@ -442,61 +536,79 @@ the device context first. See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}. +\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}} +} + \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}). + + \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex} -\func{long}{LogicalToDeviceX}{\param{long}{ x}} +\func{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{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. \membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey} -\func{long}{LogicalToDeviceY}{\param{long}{ y}} +\func{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{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. \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. @@ -506,9 +618,20 @@ Gets the minimum vertical extent used in drawing commands so far. Returns TRUE if the DC is ok to use. +\membersection{wxDC::ResetBoundingBox}\label{wxdcresetboundingbox} + +\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::SetDeviceOrigin}\label{wxdcsetdeviceorigin} -\func{void}{SetDeviceOrigin}{\param{long}{ x}, \param{long}{ y}} +\func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}} Sets the device origin (i.e., the origin in pixels after scaling has been applied). @@ -531,13 +654,17 @@ whether text will be drawn with a background colour or not. \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 wxRegion\&}{ region}} -Sets the clipping region for the DC. The clipping region is a rectangular area -to which drawing is restricted. Possible uses for the clipping region are for clipping text +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. -See also \helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}. +\wxheading{See also} + +\helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion} \membersection{wxDC::SetPalette}\label{wxdcsetpalette} @@ -562,6 +689,9 @@ 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::SetFont}\label{wxdcsetfont} \func{void}{SetFont}{\param{const wxFont\& }{font}} @@ -608,7 +738,7 @@ 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} @@ -633,12 +763,12 @@ 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} @@ -664,6 +794,9 @@ 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 also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours +when drawing into a monochrome bitmap. + \membersection{wxDC::SetTextBackground}\label{wxdcsettextbackground} \func{void}{SetTextBackground}{\param{const wxColour\& }{colour}} @@ -676,6 +809,9 @@ Sets the current text background colour for the DC. 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}}