X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/41fbc84101e7fc1a3e658f1d3f01664289637f01..fc71ef6e179ee4c0dc289d025b34ba045e29d919:/docs/latex/wx/dc.tex diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index 3e7e236341..345ff3b041 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} @@ -108,6 +115,18 @@ See \helpref{wxMemoryDC}{wxmemorydc} for typical usage. \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} @@ -175,9 +194,17 @@ Draw a bitmap on the device context at the specified point. If {\it transparent} 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 bit set to 1), and the current text background colour to draw the background -(all bits set 0). See also \helpref{SetTextForeground}{wxwindowsettextforeground}, - \helpref{SetTextForeground}{wxwindowsettextforeground} and \helpref{wxMemoryDC}{wxmemorydc}. +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} @@ -193,8 +220,7 @@ filling the shape. \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. +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. @@ -328,6 +354,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} @@ -350,10 +381,10 @@ 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{wxColour *}{colour}, \param{int}{ style=wxFLOOD\_SURFACE}} +\func{void}{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. @@ -366,12 +397,26 @@ and using a style: \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} @@ -395,10 +440,15 @@ 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 (see \helpref{wxDC::SetFont}{wxdcsetfont}). \membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction} @@ -424,6 +474,8 @@ See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details. \func{wxPen\&}{GetPen}{\void} +\constfunc{const wxPen\&}{GetPen}{\void} + Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}). \membersection{wxDC::GetPixel}\label{wxdcgetpixel} @@ -436,6 +488,9 @@ 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.} +\perlnote{This method only takes the parameters {\tt x} and {\tt y} and returns +a Wx::Colour value} + \membersection{wxDC::GetSize}\label{wxdcgetsize} \func{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}} @@ -466,10 +521,20 @@ 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::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} @@ -499,10 +564,17 @@ 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} +\constfunc{const wxColour\&}{GetTextForeground}{\void} + Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}). @@ -512,6 +584,8 @@ Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{w Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}). +\perlnote{In wxPerl this method takes no arguments and returna a two element + array {\tt ( \$x, \$y )}} \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex} @@ -571,6 +645,17 @@ 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{wxCoord}{ x}, \param{wxCoord}{ y}} @@ -631,6 +716,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}} @@ -733,6 +821,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}} @@ -745,6 +836,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}}