X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6ae7410f5522bc6047b842359318fc9521353186..c52b96359b639cda516615f9433d3b20b35443b5:/docs/latex/wx/dc.tex diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index e96191b915..fdc1c815be 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -32,6 +32,10 @@ the color's alpha values when stroking or filling. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{See also} \helpref{Overview}{dcoverview} @@ -108,7 +112,7 @@ See \helpref{wxMemoryDC}{wxmemorydc} for typical usage. \wxheading{See also} -\helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask} +\helpref{wxDC::StretchBlit}{wxdcstretchblit}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask} \begin{comment} @@ -199,7 +203,7 @@ See also \helpref{wxDC::SetClippingRegion}{wxdcsetclippingregion}. \membersection{wxDC::DeviceToLogicalX}\label{wxdcdevicetologicalx} -\func{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}} +\func{virtual wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}} Convert device X coordinate to logical coordinate, using the current mapping mode. @@ -207,7 +211,7 @@ mapping mode. \membersection{wxDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel} -\func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}} +\func{virtual wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}} Convert device X coordinate to relative logical coordinate, using the current mapping mode but ignoring the x axis orientation. @@ -216,7 +220,7 @@ Use this function for converting a width, for example. \membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly} -\func{wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}} +\func{virtual wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}} Converts device Y coordinate to logical coordinate, using the current mapping mode. @@ -224,7 +228,7 @@ mapping mode. \membersection{wxDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel} -\func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}} +\func{virtual wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}} Convert device Y coordinate to relative logical coordinate, using the current mapping mode but ignoring the y axis orientation. @@ -355,12 +359,15 @@ of many other toolkits). \func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ 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} +adding the optional offset coordinate. The current pen is +used for drawing the lines. -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. +\func{void}{DrawLines}{\param{const wxPointList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}} + +This method uses a list of wxPoints, adding the optional offset +coordinate. The programmer is responsible for deleting the list +of points. \pythonnote{The wxPython version of this method accepts a Python list of wxPoint objects.} @@ -375,11 +382,14 @@ of wxPoint objects.} \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{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\ +Draws a filled polygon using an array of {\it points} of size {\it n}, +adding the optional offset coordinate. + +\func{void}{DrawPolygon}{\param{const wxPointList *}{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}, -or list of pointers to points, adding the optional offset coordinate. +This method draws a filled polygon using a list of wxPoints, +adding the optional offset coordinate. The last argument specifies the fill rule: {\bf wxODDEVEN\_RULE} (the default) or {\bf wxWINDING\_RULE}. @@ -487,10 +497,9 @@ the rectangle. Draws a spline between all given control points, using the current pen. -\func{void}{DrawSpline}{\param{wxList *}{points}} +\func{void}{DrawSpline}{\param{const wxPointList *}{points}} -Draws a spline between all given control points, using the current -pen. Doesn't delete the wxList and contents. +Draws a spline between all given control points. \func{void}{DrawSpline}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ x3}, \param{wxCoord}{ y3}} @@ -624,6 +633,17 @@ rectangle are returned as a tuple.} {\tt ( x, y, width, height )}} +\membersection{wxDC::GetDepth}\label{wxdcgetdepth} + +\constfunc{int}{GetDepth}{\void} + +Returns the depth (number of bits/pixel) of this DC. + +\wxheading{See also} + +\helpref{wxDisplayDepth}{wxdisplaydepth} + + \membersection{wxDC::GetFont}\label{wxdcgetfont} \constfunc{const wxFont\&}{GetFont}{\void} @@ -639,9 +659,9 @@ font is returned. \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}. +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} @@ -662,6 +682,33 @@ Gets the current logical function (see \helpref{wxDC::SetLogicalFunction}{wxdcse Gets the {\it mapping mode} for the device context (see \helpref{wxDC::SetMapMode}{wxdcsetmapmode}). +\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}, @@ -675,6 +722,11 @@ 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.} @@ -760,20 +812,31 @@ Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{w \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent} -\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}} +\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 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. -See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}. +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} @@ -837,7 +900,7 @@ use \arg{initialColour} on the left part of the rectangle and \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex} -\func{wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}} +\func{virtual wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}} Converts logical X coordinate to device coordinate, using the current mapping mode. @@ -845,7 +908,7 @@ mapping mode. \membersection{wxDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel} -\func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}} +\func{virtual wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}} Converts logical X coordinate to relative device coordinate, using the current mapping mode but ignoring the x axis orientation. @@ -854,7 +917,7 @@ Use this for converting a width, for example. \membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey} -\func{wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}} +\func{virtual wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}} Converts logical Y coordinate to device coordinate, using the current mapping mode. @@ -862,7 +925,7 @@ mapping mode. \membersection{wxDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel} -\func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}} +\func{virtual wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}} Converts logical Y coordinate to relative device coordinate, using the current mapping mode but ignoring the y axis orientation. @@ -956,7 +1019,7 @@ whether text will be drawn with a background colour or not. Sets the current brush for the DC. If the argument is wxNullBrush, the current brush is selected out of the device -context, and the original brush restored, allowing the current brush to +context (leaving wxDC without any valid brush), allowing the current brush to be destroyed safely. See also \helpref{wxBrush}{wxbrush}. @@ -1016,7 +1079,7 @@ See also \helpref{wxFont}{wxfont}. \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}. +\texttt{wxLayout\_Default}, \texttt{wxLayout\_LeftToRight} or \texttt{wxLayout\_RightToLeft}. \wxheading{See also} @@ -1086,7 +1149,7 @@ The mapping mode can be one of the following: \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.} +\twocolitem{wxMM\_TEXT}{Each logical unit is 1 device pixel.} \end{twocollist} @@ -1099,7 +1162,7 @@ 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. +See \helpref{wxPalette}{wxpalette} for further details. \membersection{wxDC::SetPen}\label{wxdcsetpen} @@ -1109,7 +1172,8 @@ See \helpref{wxPalette}{wxpalette} for further details. 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. @@ -1153,3 +1217,85 @@ Message is a message to show while printing. \func{bool}{StartPage}{\void} 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} +