More True/False fixes

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

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index 89169e5225a4f6be24ee21067657415ec28281c5..0f44a7ed054b95a4aa98d7de6af23dcce9dc0668 100644 (file)
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -109,7 +109,7 @@ This sequence of operations ensures that the source's transparent area need not
 and logical functions are supported.
 
 {\bf Note:} on Windows, blitting with masks can be speeded up considerably by compiling
 and logical functions are supported.
 
 {\bf Note:} on Windows, blitting with masks can be speeded up considerably by compiling

-wxWindows with the wxUSE\_DC\_CACHE option enabled. You can also influence whether MaskBlt
+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.
 
 or the explicit mask blitting code above is used, by using \helpref{wxSystemOptions}{wxsystemoptions} and
 setting the {\bf no-maskblt} option to 1.
 


@@ -383,7 +383,7 @@ 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.
 
 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.}
 
 \pythonnote{The wxPython version of this method accepts a Python list
 of wxPoint objects.}


@@ -684,13 +684,12 @@ instead.
 
 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 
 
 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 

-

 \membersection{wxDC::GetPixel}\label{wxdcgetpixel}
 
 \func{bool}{GetPixel}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}}
 
 \membersection{wxDC::GetPixel}\label{wxdcgetpixel}
 
 \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.}
 
 \pythonnote{For wxPython the wxColour value is returned and is not
 required as a parameter.}


@@ -698,17 +697,20 @@ required as a parameter.}
 \perlnote{This method only takes the parameters {\tt x} and {\tt y} and returns
 a Wx::Colour value}
 
 \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}
 
 
 \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:
 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:


@@ -737,6 +739,13 @@ implements the following methods:\par
 \end{twocollist}
 }}
 
 \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}
 
 
 \membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
 


@@ -899,17 +908,6 @@ left to right orientation, false to invert it.}
 bottom up orientation, false to invert it.}
 
 
 bottom up orientation, false to invert it.}
 
 

-\membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}
-
-\func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
-
-Sets the device origin (i.e., the origin in pixels after scaling has been
-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}}
 \membersection{wxDC::SetBackground}\label{wxdcsetbackground}
 
 \func{void}{SetBackground}{\param{const wxBrush\& }{brush}}


@@ -925,6 +923,22 @@ Sets the current background brush for the DC.
 whether text will be drawn with a background colour or not.
 
 
 whether text will be drawn with a background colour or not.
 
 

+\membersection{wxDC::SetBrush}\label{wxdcsetbrush}
+
+\func{void}{SetBrush}{\param{const wxBrush\& }{brush}}
+
+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
+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::SetClippingRegion}\label{wxdcsetclippingregion}
 
 \func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 \membersection{wxDC::SetClippingRegion}\label{wxdcsetclippingregion}
 
 \func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}


@@ -950,32 +964,15 @@ when only a known area of the screen is damaged.
 \helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion}
 
 
 \helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion}
 
 

-\membersection{wxDC::SetPalette}\label{wxdcsetpalette}
-
-\func{void}{SetPalette}{\param{const wxPalette\& }{palette}}
-
-If this is a window DC or memory DC, assigns the given palette to the window
-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.
-
-
-\membersection{wxDC::SetBrush}\label{wxdcsetbrush}
-
-\func{void}{SetBrush}{\param{const wxBrush\& }{brush}}
-
-Sets the current brush for the DC.
+\membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}

 
 

-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
-be destroyed safely.
+\func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}

 
 

-See also \helpref{wxBrush}{wxbrush}.
+Sets the device origin (i.e., the origin in pixels after scaling has been
+applied).

 
 

-See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
-when drawing into a monochrome bitmap.
+This function may be useful in Windows printing
+operations for placing a graphic on a page.

 
 
 \membersection{wxDC::SetFont}\label{wxdcsetfont}
 
 
 \membersection{wxDC::SetFont}\label{wxdcsetfont}


@@ -1038,12 +1035,10 @@ user scale} (see \helpref{wxDC::SetUserScale}{wxdcsetuserscale}) scales the text
 Windows, scalable TrueType fonts are always used; in X, results depend
 on availability of fonts, but usually a reasonable match is found.
 
 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:
 
 
 The mapping mode can be one of the following:
 


@@ -1064,14 +1059,26 @@ The mapping mode can be one of the following:
 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 {\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.
 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.
 
 
 
 Setting optimization off, drawing, then setting it back on again, is a trick
 that must occasionally be employed.
 
 

+\membersection{wxDC::SetPalette}\label{wxdcsetpalette}
+
+\func{void}{SetPalette}{\param{const wxPalette\& }{palette}}
+
+If this is a window DC or memory DC, assigns the given palette to the window
+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. 
+
+

 \membersection{wxDC::SetPen}\label{wxdcsetpen}
 
 \func{void}{SetPen}{\param{const wxPen\& }{pen}}
 \membersection{wxDC::SetPen}\label{wxdcsetpen}
 
 \func{void}{SetPen}{\param{const wxPen\& }{pen}}