X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ba90345d082f759ed34d931833cafb09fc585d61..ed39ff57b30a70a2395e07887a70bc01e7a3b7ec:/docs/latex/wx/image.tex

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index 56fed27525..b932f7a6fd 100644
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -81,10 +81,10 @@ and forth without loss in that respect.
 
 Creates an image with the given width and height.
 
-\func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static\_data=FALSE}}
+\func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static\_data=false}}
 
 Creates an image from given data with the given width and height. If 
-{\it static\_data} is TRUE, then wxImage will not delete the actual
+{\it static\_data} is true, then wxImage will not delete the actual
 image data in its destructor, otherwise it will free it by calling
 {\it free()}.
 
@@ -199,7 +199,7 @@ of a given handler class in an application session.}
 
 \func{bool}{CanRead}{\param{const wxString\&}{ filename}}
 
-returns TRUE if the current image handlers can read this file
+returns true if the current image handlers can read this file
 
 \pythonnote{In wxPython this static method is named {\tt wxImage\_AddHandler}.}
 \membersection{wxImage::CleanUpHandlers}
@@ -271,7 +271,7 @@ Creates a fresh image.
 
 \wxheading{Return value}
 
-TRUE if the call succeeded, FALSE otherwise.
+true if the call succeeded, false otherwise.
 
 \membersection{wxImage::Destroy}\label{wximagedestroy}
 
@@ -296,7 +296,7 @@ order) by 1 until an unused colour is found or the colour space exhausted.
 
 \wxheading{Return value}
 
-Returns FALSE if there is no unused colour left, TRUE on success.
+Returns false if there is no unused colour left, true on success.
 
 \wxheading{Notes}
 
@@ -351,6 +351,9 @@ Returns the image data as an array. This is most often used when doing
 direct image manipulation. The return value points to an array of
 characters in RGBRGBRGB$\ldots$ format.
 
+You should not delete the returned pointer nor pass it to
+\helpref{wxImage::SetData}{wximagesetdata}.
+
 \membersection{wxImage::GetGreen}\label{wximagegetgreen}
 
 \constfunc{unsigned char}{GetGreen}{\param{int}{ x}, \param{int}{ y}}
@@ -394,12 +397,6 @@ available images.
 Number of available images. For most image handlers, this is 1 (exceptions
 are TIFF and ICO formats).
 
-\membersection{wxImage::GetRed}\label{wximagegetred}
-
-\constfunc{unsigned char}{GetRed}{\param{int}{ x}, \param{int}{ y}}
-
-Returns the red intensity at the given coordinate.
-
 \membersection{wxImage::GetHandlers}
 
 \func{static wxList\&}{GetHandlers}{\void}
@@ -443,6 +440,12 @@ used when converting to wxBitmap under Windows.
 
 Eventually wxImage handlers will set the palette if one exists in the image file.
 
+\membersection{wxImage::GetRed}\label{wximagegetred}
+
+\constfunc{unsigned char}{GetRed}{\param{int}{ x}, \param{int}{ y}}
+
+Returns the red intensity at the given coordinate.
+
 \membersection{wxImage::GetSubImage}\label{wximagegetsubimage}
 
 \constfunc{wxImage}{GetSubImage}{\param{const wxRect\&}{ rect}}
@@ -464,7 +467,7 @@ Gets the width of the image in pixels.
 
 \constfunc{bool}{HasMask}{\void}
 
-Returns TRUE if there is a mask active, FALSE otherwise.
+Returns true if there is a mask active, false otherwise.
 
 \membersection{wxImage::GetOption}\label{wximagegetoption}
 
@@ -497,7 +500,7 @@ Gets a user-defined option as an integer. The function is case-insensitive to {\
 
 \constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
 
-Returns TRUE if the given option is present. The function is case-insensitive to {\it name}.
+Returns true if the given option is present. The function is case-insensitive to {\it name}.
 
 \wxheading{See also}
 
@@ -593,8 +596,8 @@ hotspot for loaded cursor file:
 
 \wxheading{Return value}
 
-TRUE if the operation succeeded, FALSE otherwise. If the optional index parameter is out of range,
-FALSE is returned and a call to wxLogError() takes place.
+true if the operation succeeded, false otherwise. If the optional index parameter is out of range,
+false is returned and a call to wxLogError() takes place.
 
 \wxheading{See also}
 
@@ -622,7 +625,7 @@ mimetype from a file}
 
 \constfunc{bool}{Ok}{\void}
 
-Returns TRUE if image data is present.
+Returns true if image data is present.
 
 \membersection{wxImage::RemoveHandler}
 
@@ -635,7 +638,7 @@ is not deleted.
 
 \wxheading{Return value}
 
-TRUE if the handler was found and removed, FALSE otherwise.
+true if the handler was found and removed, false otherwise.
 
 \wxheading{See also}
 
@@ -686,7 +689,7 @@ Saves an image in the given stream.
 
 \wxheading{Return value}
 
-TRUE if the operation succeeded, FALSE otherwise.
+true if the operation succeeded, false otherwise.
 
 \wxheading{Remarks}
 
@@ -724,7 +727,7 @@ mimetype to the named file}
 
 \membersection{wxImage::Mirror}\label{wximagemirror}
 
-\constfunc{wxImage}{Mirror}{\param{bool}{ horizontally = TRUE}}
+\constfunc{wxImage}{Mirror}{\param{bool}{ horizontally = true}}
 
 Returns a mirrored copy of the image. The parameter {\it horizontally}
 indicates the orientation.
@@ -752,9 +755,9 @@ Returns the (modified) image itself.
 \membersection{wxImage::Rotate}\label{wximagerotate}
 
 \func{wxImage}{Rotate}{\param{double}{ angle}, \param{const wxPoint\& }{rotationCentre},
- \param{bool}{ interpolating = TRUE}, \param{wxPoint*}{ offsetAfterRotation = NULL}}
+ \param{bool}{ interpolating = true}, \param{wxPoint*}{ offsetAfterRotation = NULL}}
 
-Rotates the image about the given point, by {\it angle} radians. Passing TRUE
+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.
@@ -763,7 +766,7 @@ Returns the rotated image, leaving this image intact.
 
 \membersection{wxImage::Rotate90}\label{wximagerotate90}
 
-\constfunc{wxImage}{Rotate90}{\param{bool}{ clockwise = TRUE}}
+\constfunc{wxImage}{Rotate90}{\param{bool}{ clockwise = true}}
 
 Returns a copy of the image rotated 90 degrees in the direction
 indicated by {\it clockwise}.
@@ -810,9 +813,16 @@ Sets the image data without performing checks. The data given must have
 the size (width*height*3) or results will be unexpected. Don't use this
 method if you aren't sure you know what you are doing.
 
+The data must have been allocated with malloc(), NOT with operator new.
+
+After this call the pointer to the data is owned by the wxImage object,
+that will be responsible for deleting it.
+Do not pass to this function a pointer obtained through
+\helpref{wxImage::GetData}{wximagegetdata}.
+
 \membersection{wxImage::SetMask}\label{wximagesetmask}
 
-\func{void}{SetMask}{\param{bool}{ hasMask = TRUE}}
+\func{void}{SetMask}{\param{bool}{ hasMask = true}}
 
 Specifies whether there is a mask or not. The area of the mask is determined by the current mask colour.
 
@@ -840,8 +850,8 @@ in {\it mask} has given RGB value.
 
 \wxheading{Return value}
 
-Returns FALSE if {\it mask} does not have same dimensions as the image or if
-there is no unused colour left. Returns TRUE if the mask was successfully 
+Returns false if {\it mask} does not have same dimensions as the image or if
+there is no unused colour left. Returns true if the mask was successfully 
 applied.
 
 \wxheading{Notes}
@@ -901,7 +911,7 @@ Returns 'this' object.
 
 \membersection{wxImage::operator $==$}
 
-\func{bool}{operator $==$}{\param{const wxImage\& }{image}}
+\constfunc{bool}{operator $==$}{\param{const wxImage\& }{image}}
 
 Equality operator. This operator tests whether the internal data pointers are
 equal (a fast test).
@@ -912,11 +922,11 @@ equal (a fast test).
 
 \wxheading{Return value}
 
-Returns TRUE if the images were effectively equal, FALSE otherwise.
+Returns true if the images were effectively equal, false otherwise.
 
 \membersection{wxImage::operator $!=$}
 
-\func{bool}{operator $!=$}{\param{const wxImage\& }{image}}
+\constfunc{bool}{operator $!=$}{\param{const wxImage\& }{image}}
 
 Inequality operator. This operator tests whether the internal data pointers are
 unequal (a fast test).
@@ -927,7 +937,7 @@ unequal (a fast test).
 
 \wxheading{Return value}
 
-Returns TRUE if the images were unequal, FALSE otherwise.
+Returns true if the images were unequal, false otherwise.
 
 \section{\class{wxImageHandler}}\label{wximagehandler}
 
@@ -1014,7 +1024,7 @@ Gets the MIME type associated with this handler.
 
 \membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile}
 
-\func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}, \param{bool}{ verbose=TRUE}, \param{int}{ index=0}}
+\func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}, \param{bool}{ verbose=true}, \param{int}{ index=0}}
 
 Loads a image from a stream, putting the resulting data into {\it image}. If the image file contains
 more than one image and the image handler is capable of retrieving these individually, {\it index}
@@ -1026,13 +1036,13 @@ indicates which image to read from the stream.
 
 \docparam{stream}{Opened input stream for reading image data.}
 
-\docparam{verbose}{If set to TRUE, errors reported by the image handler will produce wxLogMessages.}
+\docparam{verbose}{If set to true, errors reported by the image handler will produce wxLogMessages.}
 
 \docparam{index}{The index of the image in the file (starting from zero).}
 
 \wxheading{Return value}
 
-TRUE if the operation succeeded, FALSE otherwise.
+true if the operation succeeded, false otherwise.
 
 \wxheading{See also}
 
@@ -1054,7 +1064,7 @@ Saves a image in the output stream.
 
 \wxheading{Return value}
 
-TRUE if the operation succeeded, FALSE otherwise.
+true if the operation succeeded, false otherwise.
 
 \wxheading{See also}
 
