compilation fix after TRUE/FALSE change

[wxWidgets.git] / docs / latex / wx / dc.tex

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index 94354be9345ad80d7f94373a23758950dcd165cf..dc731b363de887e4fed7a5a7f79138472b9c61d6 100644 (file)
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -211,7 +211,8 @@ mapping mode.
 \func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}
 
 Convert device X coordinate to relative logical coordinate, using the current
 \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}
 
 
 \membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly}
 


@@ -225,7 +226,8 @@ mapping mode.
 \func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}
 
 Convert device Y coordinate to relative logical coordinate, using the current
 \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}
 
 
 \membersection{wxDC::DrawArc}\label{wxdcdrawarc}
 


@@ -257,13 +259,33 @@ of the bitmap (all bits set to 1), and the current text background colour to dra
 
 Draws a check mark inside the given rectangle.
 
 
 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}}
 
 \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}
 
 
 \membersection{wxDC::DrawEllipticArc}\label{wxdcdrawellipticarc}
 


@@ -364,6 +386,11 @@ for filling the shape.
 
 Draws the text rotated by {\it angle} degrees.
 
 
 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}
 \wxheading{See also}
 
 \helpref{DrawText}{wxdcdrawtext}


@@ -470,7 +497,8 @@ 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}
 
 \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.
+{\it Note:} The present implementation for non-Windows platforms may fail to find
+colour borders if the pixels do not match the colour exactly.

 
 \membersection{wxDC::GetBackground}\label{wxdcgetbackground}
 
 
 \membersection{wxDC::GetBackground}\label{wxdcgetbackground}
 


@@ -520,7 +548,7 @@ Gets the rectangle surrounding the current clipping region.
 rectangle are returned as a tuple.}
 
 \perlnote{This method takes no arguments and returns a four element list
 rectangle are returned as a tuple.}
 
 \perlnote{This method takes no arguments and returns a four element list

-{\tt ( \$x, \$y, \$width, \$height )}}
+{\tt ( x, y, width, height )}}

 
 \membersection{wxDC::GetFont}\label{wxdcgetfont}
 
 
 \membersection{wxDC::GetFont}\label{wxdcgetfont}
 


@@ -604,7 +632,7 @@ implements the following methods:\par
 \indented{2cm}{\begin{twocollist}
 \twocolitem{{\bf GetSize()}}{Returns a Wx::Size}
 \twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list
 \indented{2cm}{\begin{twocollist}
 \twocolitem{{\bf GetSize()}}{Returns a Wx::Size}
 \twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list

-  {\tt ( \$width, \$height )}}
+  {\tt ( width, height )}}

 \end{twocollist}
 }}
 
 \end{twocollist}
 }}
 


@@ -645,7 +673,7 @@ See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
 
 \perlnote{In wxPerl this method is implemented as 
   {\bf GetTextExtent( string, font = undef )} returning a four element
 
 \perlnote{In wxPerl this method is implemented as 
   {\bf GetTextExtent( string, font = undef )} returning a four element

-  array {\tt ( \$width, \$height, \$descent, \$externalLeading )}
+  array {\tt ( width, height, descent, externalLeading )}

 }
 
 \membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground}
 }
 
 \membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground}


@@ -664,7 +692,7 @@ 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
 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 )}}
+ array {\tt ( x, y )}}

 
 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
 
 
 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
 


@@ -678,7 +706,8 @@ mapping mode.
 \func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}
 
 Converts logical X coordinate to relative device coordinate, using the current
 \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}
 
 
 \membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey}
 


@@ -692,7 +721,8 @@ mapping mode.
 \func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}
 
 Converts logical Y coordinate to relative device coordinate, using the current
 \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}
 
 
 \membersection{wxDC::MaxX}\label{wxdcmaxx}
 


@@ -735,6 +765,23 @@ doesn't contain anything.
 
 \helpref{CalcBoundingBox}{wxdccalcboundingbox}
 
 
 \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}}
 \membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}
 
 \func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}


@@ -762,11 +809,21 @@ whether text will be drawn with a background colour or not.
 
 \func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 
 
 \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}}
 
 \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}
 
 
 \wxheading{See also}
 


@@ -802,11 +859,8 @@ when drawing into a monochrome bitmap.
 
 \func{void}{SetFont}{\param{const wxFont\& }{font}}
 
 
 \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}.
 
 
 See also \helpref{wxFont}{wxfont}.