Doc tweaks

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index ca43c0fbcc188d637c8adf4c02487ecf55a3f9cf..136d07a3d56dbaad9e3f69e99b3ba2075555faf8 100644 (file)
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -18,7 +18,7 @@ creation of a \helpref{wxMask}{wxmask} object associated to the bitmap object.
 
 The following image handlers are available. {\bf wxBMPHandler} is always
 installed by default. To use other image formats, install the appropiate
-handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
+handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or 
 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
 
 \twocolwidtha{5cm}%
@@ -116,8 +116,8 @@ Loads an image from an input stream.
 
 Depending on how wxWindows has been configured, not all formats may be available.
 
-Note : any handler other than BMP must be previously
-initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or
+Note: any handler other than BMP must be previously
+initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or 
 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
 
 \wxheading{See also}
@@ -331,7 +331,7 @@ the user.
 
 \wxheading{See also}
 
-\helpref{wxImageHandler}{wximagehandler}
+\helpref{wxImageHandler}{wximagehandler}, 
 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
 
 \membersection{wxImage::InsertHandler}
@@ -505,6 +505,18 @@ Returns the (modified) image itself.
 
 \helpref{Scale}{wximagescale}
 
+\membersection{wxImage::Rotate}\label{wximagerotate}
+
+\func{wxImage}{Rotate}{\param{double}{ angle}, \param{const wxPoint\& }{rotationCentre},
+ \param{bool}{ interpolating = TRUE}, \param{wxPoint*}{ offsetAfterRotation = NULL}}
+
+Rotates the image about the given point, by {\it angle} radians. Passing TRUE
+to {\it interpolating} results in better image quality, but is slower. If the
+image has a mask, then the mask colour is used for the uncovered pixels in the
+rotated image background. Else, black (rgb 0, 0, 0) will be used.
+
+Returns the rotated image, leaving this image intact.
+
 \membersection{wxImage::Scale}\label{wximagescale}
 
 \constfunc{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}}
@@ -641,7 +653,7 @@ created by IJG.)
 
 \wxheading{See also}
 
-\helpref{wxImage}{wximage}
+\helpref{wxImage}{wximage}, 
 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -721,8 +733,8 @@ TRUE if the operation succeeded, FALSE otherwise.
 
 \wxheading{See also}
 
-\helpref{wxImage::LoadFile}{wximageloadfile}\\
-\helpref{wxImage::SaveFile}{wximagesavefile}\\
+\helpref{wxImage::LoadFile}{wximageloadfile}, 
+\helpref{wxImage::SaveFile}{wximagesavefile}, 
 \helpref{wxImageHandler::SaveFile}{wximagehandlersavefile}
 
 \membersection{wxImageHandler::SaveFile}\label{wximagehandlersavefile}
@@ -743,8 +755,8 @@ TRUE if the operation succeeded, FALSE otherwise.
 
 \wxheading{See also}
 
-\helpref{wxImage::LoadFile}{wximageloadfile}\\
-\helpref{wxImage::SaveFile}{wximagesavefile}\\
+\helpref{wxImage::LoadFile}{wximageloadfile}, 
+\helpref{wxImage::SaveFile}{wximagesavefile}, 
 \helpref{wxImageHandler::LoadFile}{wximagehandlerloadfile}
 
 \membersection{wxImageHandler::SetName}