X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/267a7108512069169a855457d027cd68fed5bf2e..4a82116e2ee3060ecdb8a451403280f54be93372:/docs/latex/wx/dc.tex diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index 9af5f09bc4..d609a8eaec 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -9,6 +9,13 @@ 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. +% 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. + \wxheading{Derived from} \helpref{wxObject}{wxobject} @@ -23,18 +30,21 @@ only, so refer to this section for most device context information. \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxDC::wxDC} \func{}{wxDC}{\void} Constructor. + \membersection{wxDC::\destruct{wxDC}} \func{}{\destruct{wxDC}}{\void} Destructor. + \membersection{wxDC::BeginDrawing}\label{wxdcbegindrawing} \func{void}{BeginDrawing}{\void} @@ -50,15 +60,16 @@ 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{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{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} @@ -78,8 +89,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. @@ -96,8 +107,21 @@ 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. @@ -108,6 +132,26 @@ See \helpref{wxMemoryDC}{wxmemorydc} for typical usage. \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}} @@ -120,12 +164,35 @@ Adds the specified point to the bounding box which can be retrieved with \helpref{ResetBoundingBox}{wxdcresetboundingbox} + \membersection{wxDC::Clear}\label{wxdcclear} \func{void}{Clear}{\void} 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::CrossHair}\label{wxdccrosshair} \func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}} @@ -134,6 +201,7 @@ 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} @@ -141,6 +209,7 @@ 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{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}} @@ -148,12 +217,15 @@ See also \helpref{wxDC::SetClippingRegion}{wxdcsetclippingregion}. Convert device X coordinate to logical coordinate, using the current mapping mode. + \membersection{wxDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel} \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. +mapping mode but ignoring the x axis orientation. +Use this function for converting a width, for example. + \membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly} @@ -162,16 +234,19 @@ mapping mode. Use this function for converting a width, for example. Converts device Y coordinate to logical coordinate, using the current mapping mode. + \membersection{wxDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel} \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. +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{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ 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 @@ -179,11 +254,12 @@ 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 +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 @@ -191,6 +267,7 @@ of the bitmap (all bits set to 1), and the current text background colour to dra (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}} @@ -199,13 +276,36 @@ of the bitmap (all bits set to 1), and the current text background colour to dra 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{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 -filling the shape. +\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} + \membersection{wxDC::DrawEllipticArc}\label{wxdcdrawellipticarc} @@ -227,6 +327,7 @@ 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{wxCoord}{ x}, \param{wxCoord}{ y}} @@ -234,12 +335,16 @@ complete ellipse will be drawn. 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{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} @@ -255,6 +360,11 @@ 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{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\ @@ -273,17 +383,55 @@ 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{wxCoord}{ x}, \param{wxCoord}{ y}} Draws a point using the current pen. + \membersection{wxDC::DrawRectangle}\label{wxdcdrawrectangle} \func{void}{DrawRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}} @@ -292,16 +440,23 @@ 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{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius = 20}} @@ -319,6 +474,7 @@ 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{wxList *}{points}} @@ -335,6 +491,10 @@ 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{wxCoord}{ x}, \param{wxCoord}{ y}} @@ -352,12 +512,32 @@ text more precisely. 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} @@ -366,15 +546,17 @@ Allows optimization of drawing code under MS Windows. Enclose drawing primitives between {\bf BeginDrawing} and {\bf EndDrawing}\rtfsp calls. + \membersection{wxDC::EndPage}\label{wxdcendpage} \func{void}{EndPage}{\void} Ends a document page (only relevant when outputting to a printer). + \membersection{wxDC::FloodFill}\label{wxdcfloodfill} -\func{void}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const 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, using the {\it current brush colour}, and using a style: @@ -384,7 +566,12 @@ the {\it current brush colour}, and using a style: \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} @@ -394,6 +581,7 @@ the {\it current brush colour}, and using a style: Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}). + \membersection{wxDC::GetBackgroundMode}\label{wxdcgetbackgroundmode} \constfunc{int}{GetBackgroundMode}{\void} @@ -404,6 +592,7 @@ Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}. \helpref{SetBackgroundMode}{wxdcsetbackgroundmode} + \membersection{wxDC::GetBrush}\label{wxdcgetbrush} \func{wxBrush\&}{GetBrush}{\void} @@ -412,18 +601,21 @@ Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}. Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}). + \membersection{wxDC::GetCharHeight}\label{wxdcgetcharheight} \func{wxCoord}{GetCharHeight}{\void} Gets the character height of the currently set font. + \membersection{wxDC::GetCharWidth}\label{wxdcgetcharwidth} \func{wxCoord}{GetCharWidth}{\void} Gets the average character width of the currently set font. + \membersection{wxDC::GetClippingBox}\label{wxdcgetclippingbox} \func{void}{GetClippingBox}{\param{wxCoord}{ *x}, \param{wxCoord}{ *y}, \param{wxCoord}{ *width}, \param{wxCoord}{ *height}} @@ -433,6 +625,10 @@ 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} @@ -441,25 +637,45 @@ rectangle are returned as a tuple.} Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}). + \membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction} \func{int}{GetLogicalFunction}{\void} 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} -Returns TRUE if device context optimization is on. +Returns true if device context optimization is on. See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details. + +\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 begining of +{\it text} to the coresponding 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 implementaiton then it should be used +instead. + +\pythonnote{This method only takes the {\it text} parameter and + returns a Python list of integers.} + \membersection{wxDC::GetPen}\label{wxdcgetpen} \func{wxPen\&}{GetPen}{\void} @@ -472,22 +688,29 @@ Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}). \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. +Sets {\it colour} to the colour at the specified location. +Not available for wxPostScriptDC or wxMetafileDC. \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} + +\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{wxCoord *}{width}, \param{wxCoord *}{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: @@ -508,6 +731,22 @@ implements the following methods:\par \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} @@ -516,6 +755,7 @@ implements the following methods:\par Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}). + \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent} \func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\ @@ -543,6 +783,12 @@ See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}. \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 )} +} + + \membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground} \func{wxColour\&}{GetTextForeground}{\void} @@ -552,12 +798,16 @@ See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}. 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::LogicalToDeviceX}\label{wxdclogicaltodevicex} @@ -566,12 +816,15 @@ Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetusersca Converts logical X coordinate to device coordinate, using the current mapping mode. + \membersection{wxDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel} \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. +mapping mode but ignoring the x axis orientation. +Use this for converting a width, for example. + \membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey} @@ -580,12 +833,15 @@ mapping mode. Use this for converting a width, for example. Converts logical Y coordinate to device coordinate, using the current mapping mode. + \membersection{wxDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel} \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. +mapping mode but ignoring the y axis orientation. +Use this for converting a height, for example. + \membersection{wxDC::MaxX}\label{wxdcmaxx} @@ -593,29 +849,34 @@ mapping mode. Use this for converting a height, for example. Gets the maximum horizontal extent used in drawing commands so far. + \membersection{wxDC::MaxY}\label{wxdcmaxy} \func{wxCoord}{MaxY}{\void} Gets the maximum vertical extent used in drawing commands so far. + \membersection{wxDC::MinX}\label{wxdcminx} \func{wxCoord}{MinX}{\void} Gets the minimum horizontal extent used in drawing commands so far. + \membersection{wxDC::MinY}\label{wxdcminy} \func{wxCoord}{MinY}{\void} Gets the minimum vertical extent used in drawing commands so far. + \membersection{wxDC::Ok}\label{wxdcok} \func{bool}{Ok}{\void} -Returns TRUE if the DC is ok to use. +Returns true if the DC is ok to use. + \membersection{wxDC::ResetBoundingBox}\label{wxdcresetboundingbox} @@ -628,6 +889,25 @@ doesn't contain anything. \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 the natural +orientation, e.g. x axis from left to right and y axis from bottom up. + +\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.} + + \membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin} \func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}} @@ -638,12 +918,14 @@ applied). This function may be useful in Windows printing operations for placing a graphic on a page. + \membersection{wxDC::SetBackground}\label{wxdcsetbackground} \func{void}{SetBackground}{\param{const wxBrush\& }{brush}} Sets the current background brush for the DC. + \membersection{wxDC::SetBackgroundMode}\label{wxdcsetbackgroundmode} \func{void}{SetBackgroundMode}{\param{int}{ mode}} @@ -651,20 +933,32 @@ 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::SetClippingRegion}\label{wxdcsetclippingregion} \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}} @@ -676,6 +970,7 @@ restored. See \helpref{wxPalette}{wxpalette} for further details. + \membersection{wxDC::SetBrush}\label{wxdcsetbrush} \func{void}{SetBrush}{\param{const wxBrush\& }{brush}} @@ -691,18 +986,17 @@ 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}} -Sets the current font for the DC. - -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. +Sets the current font for the DC. It must be a valid font, in particular you +should not pass {\tt wxNullFont} to this method. See also \helpref{wxFont}{wxfont}. + \membersection{wxDC::SetLogicalFunction}\label{wxdcsetlogicalfunction} \func{void}{SetLogicalFunction}{\param{int}{ function}} @@ -740,6 +1034,7 @@ The others combine the current colour and the background using a 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}} @@ -749,15 +1044,13 @@ 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: @@ -770,20 +1063,22 @@ The mapping mode can be one of the following: \twocolitem{wxMM\_TEXT}{Each logical unit is 1 pixel.} \end{twocollist} + \membersection{wxDC::SetOptimization}\label{wxsetoptimization} \func{void}{SetOptimization}{\param{bool }{optimize}} -If {\it optimize} is TRUE (the default), this function sets optimization mode on. +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 +if non-wxWidgets 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. +The wxWidgets device context 'memory' will now be out of step with reality. Setting optimization off, drawing, then setting it back on again, is a trick that must occasionally be employed. + \membersection{wxDC::SetPen}\label{wxdcsetpen} \func{void}{SetPen}{\param{const wxPen\& }{pen}} @@ -796,12 +1091,14 @@ 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}} Sets the current text background colour for the DC. + \membersection{wxDC::SetTextForeground}\label{wxdcsettextforeground} \func{void}{SetTextForeground}{\param{const wxColour\& }{colour}} @@ -811,6 +1108,7 @@ 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}} @@ -818,6 +1116,7 @@ when drawing into a monochrome bitmap. Sets the user scaling factor, useful for applications which require `zooming'. + \membersection{wxDC::StartDoc}\label{wxdcstartdoc} \func{bool}{StartDoc}{\param{const wxString\& }{message}} @@ -825,9 +1124,47 @@ Sets the user scaling factor, useful for applications which require Starts a document (only relevant when outputting to a printer). Message is a message to show whilst printing. + \membersection{wxDC::StartPage}\label{wxdcstartpage} \func{bool}{StartPage}{\void} Starts a document page (only relevant when outputting to a printer). +\section{\class{wxDCClipper}}\label{wxdcclipper} + +This is a small helper class which sets the specified to its constructor +clipping region and then automatically destroys it in its destructor. Using +it ensures that unwanted clipping region is not left set on the DC. + +\wxheading{Derived from} + +No base class + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxDC}{wxdc} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxDCClipper::wxDCClipper} + +\func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{wxCoord }{x},\param{wxCoord }{y},\param{wxCoord }{w},\param{wxCoord }{h},} + +\func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{const wxRect\&}{ rect}} + +Constructor: sets the the clipping region for the given device context to the +specified rectangle. + + +\membersection{wxDCClipper::\destruct{wxDCClipper}} + +\func{}{\destruct{wxDCClipper}}{\void} + +Destructor: destroys the clipping region set in the constructor. +