X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f354202554d54b7c94320e06e435eb818d879c0a..5090e3ad5c2ceee9af33859fe6b8204d6fe55103:/docs/latex/wx/dc.tex diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index 0706ef5e70..a1ee49c5d6 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -6,8 +6,10 @@ 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}. % 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 @@ -31,20 +33,6 @@ them. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxDC::wxDC}\label{wxdcctor} - -\func{}{wxDC}{\void} - -Constructor. - - -\membersection{wxDC::\destruct{wxDC}}\label{wxdcdtor} - -\func{}{\destruct{wxDC}}{\void} - -Destructor. - - \membersection{wxDC::BeginDrawing}\label{wxdcbegindrawing} \func{void}{BeginDrawing}{\void} @@ -486,7 +474,7 @@ which is. \membersection{wxDC::DrawRoundedRectangle}\label{wxdcdrawroundedrectangle} -\func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ 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 @@ -659,7 +647,10 @@ rectangle are returned as a tuple.} \constfunc{const wxFont\&}{GetFont}{\void} -Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}). +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::GetLogicalFunction}\label{wxdcgetlogicalfunction} @@ -681,12 +672,12 @@ Gets the {\it mapping mode} for the device context (see \helpref{wxDC::SetMapMod \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 +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 implementaiton then it should be used +accurate than the generic implementation then it should be used instead. \pythonnote{This method only takes the {\it text} parameter and @@ -704,9 +695,11 @@ 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. +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.} @@ -907,8 +900,8 @@ doesn't contain anything. \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. +highest values on the axis). The default orientation is +x axis from left to right and y axis from top down. \wxheading{Parameters} @@ -1154,7 +1147,7 @@ No base class \func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{const wxRect\&}{ rect}} -Constructor: sets the the clipping region for the given device context to the +Constructor: sets the clipping region for the given device context to the specified rectangle.