wxHSCROLL works in GTK2, changed description to indicate no effect only on wxGTK1

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index 4709f20fa6e63b9f1f5b26515a9a3f2443ab9bbc..6f7bffd70c123728dfc3f313be0b9da7a50a9226 100644 (file)
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -8,7 +8,7 @@ it can be used for basic image manipulation.
 
 A wxImage cannot (currently) be drawn directly to a \helpref{wxDC}{wxdc}. Instead, 
 a platform-specific \helpref{wxBitmap}{wxbitmap} object must be created from it using
-the \helpref{wxBitmap::wxBitmap(wxImage,int depth)}{wxbitmapconstr} constructor. 
+the \helpref{wxBitmap::wxBitmap(wxImage,int depth)}{wxbitmapctor} constructor. 
 This bitmap can then
 be drawn in a device context, using \helpref{wxDC::DrawBitmap}{wxdcdrawbitmap}.
 
@@ -17,7 +17,7 @@ creation of a \helpref{wxMask}{wxmask} object associated to the bitmap object.
 
 \wxheading{Alpha channel support}
 
-Starting from wxWindows 2.5.0 wxImage supports alpha channel data, that is in
+Starting from wxWidgets 2.5.0 wxImage supports alpha channel data, that is in
 addition to a byte for the red, green and blue colour components for each pixel
 it also stores a byte representing the pixel opacity. The alpha value of $0$
 corresponds to a transparent pixel (null opacity) while the value of $255$
@@ -76,7 +76,7 @@ PNM format, {\bf wxPNMHandler} will always save as raw RGB.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxImage::wxImage}\label{wximageconstr}
+\membersection{wxImage::wxImage}\label{wximagector}
 
 \func{}{wxImage}{\void}
 
@@ -154,7 +154,7 @@ the GIF and TIFF handler and as the largest and most colourful one by the ICO ha
 
 \wxheading{Remarks}
 
-Depending on how wxWindows has been configured, not all formats may be available.
+Depending on how wxWidgets 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 
@@ -199,7 +199,7 @@ platform-dependent bitmap}
 \end{itemize}
 }
 
-\membersection{wxImage::\destruct{wxImage}}
+\membersection{wxImage::\destruct{wxImage}}\label{wximagedtor}
 
 \func{}{\destruct{wxImage}}{\void}
 
@@ -223,13 +223,13 @@ of a given handler class in an application session.}
 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}
+\membersection{wxImage::CleanUpHandlers}\label{wximagecleanuphandlers}
 
 \func{static void}{CleanUpHandlers}{\void}
 
 Deletes all image handlers.
 
-This function is called by wxWindows on exit.
+This function is called by wxWidgets on exit.
 
 \membersection{wxImage::ComputeHistogram}\label{wximagecomputehistogram}
 
@@ -257,11 +257,27 @@ WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
 
 Returns number of colours in the histogram.
 
+\membersection{wxImage::ConvertAlphaToMask}\label{wximageconvertalphatomask}
+
+\func{bool}{ConvertAlphaToMask}{\param{unsigned char}{ threshold = 128}}
+
+If the image has alpha channel, this method converts it to mask. All pixels
+with alpha value less than \arg{threshold} are replaced with mask colour
+and the alpha channel is removed. Mask colour is chosen automatically using
+\helpref{FindFirstUnusedColour}{wximagefindfirstunusedcolour}.
+
+If the image image doesn't have alpha channel,
+ConvertAlphaToMask does nothing.
+
+\wxheading{Return value}
+
+\false if FindFirstUnusedColour returns \false, \true otherwise. 
+
 \membersection{wxImage::ConvertToBitmap}\label{wximageconverttobitmap}
 
 \constfunc{wxBitmap}{ConvertToBitmap}{\void}
 
-Deprecated, use equivalent \helpref{wxBitmap constructor}{wxbitmapconstr}
+Deprecated, use equivalent \helpref{wxBitmap constructor}{wxbitmapctor}
 (which takes wxImage and depth as its arguments) instead.
 
 \membersection{wxImage::ConvertToMono}\label{wxbitmapconverttomono}
@@ -325,7 +341,7 @@ Returns false if there is no unused colour left, true on success.
 Note that this method involves computing the histogram, which is
 computationally intensive operation.
 
-\membersection{wxImage::FindHandler}
+\membersection{wxImage::FindHandler}\label{wximagefindhandler}
 
 \func{static wxImageHandler*}{FindHandler}{\param{const wxString\& }{name}}
 
@@ -359,7 +375,7 @@ A pointer to the handler if found, NULL otherwise.
 
 \helpref{wxImageHandler}{wximagehandler}
 
-\membersection{wxImage::GetImageExtWildcard}
+\membersection{wxImage::GetImageExtWildcard}\label{wximagegetimageextwildcard}
 
 \func{static wxString}{GetImageExtWildcard}{\void}
 
@@ -414,8 +430,10 @@ Returns the blue intensity at the given coordinate.
 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 in the top-to-bottom, left-to-right
-order, that is the first RGB triplet corresponds to the pixel $(0, 0)$, the
-second one --- to $(0, 1)$ and so on.
+order, that is the first RGB triplet corresponds to the pixel first pixel of
+the first row, the second one --- to the second pixel of the first row and so
+on until the end of the first row, with second row following after it and so
+on.
 
 You should not delete the returned pointer nor pass it to
 \helpref{wxImage::SetData}{wximagesetdata}.
@@ -463,7 +481,7 @@ available images.
 Number of available images. For most image handlers, this is 1 (exceptions
 are TIFF and ICO formats).
 
-\membersection{wxImage::GetHandlers}
+\membersection{wxImage::GetHandlers}\label{wximagegethandlers}
 
 \func{static wxList\&}{GetHandlers}{\void}
 
@@ -584,14 +602,14 @@ Returns true if the given option is present. The function is case-insensitive to
 \helpref{wxImage::GetOption}{wximagegetoption},\rtfsp
 \helpref{wxImage::GetOptionInt}{wximagegetoptionint}
 
-\membersection{wxImage::InitStandardHandlers}
+\membersection{wxImage::InitStandardHandlers}\label{wximageinitstandardhandlers}
 
 \func{static void}{InitStandardHandlers}{\void}
 
 Internal use only. Adds standard image format handlers. It only install BMP
 for the time being, which is used by wxBitmap.
 
-This function is called by wxWindows on startup, and shouldn't be called by
+This function is called by wxWidgets on startup, and shouldn't be called by
 the user.
 
 \wxheading{See also}
@@ -599,7 +617,7 @@ the user.
 \helpref{wxImageHandler}{wximagehandler}, 
 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
 
-\membersection{wxImage::InsertHandler}
+\membersection{wxImage::InsertHandler}\label{wximageinserthandler}
 
 \func{static void}{InsertHandler}{\param{wxImageHandler*}{ handler}}
 
@@ -660,7 +678,7 @@ the GIF and TIFF handler and as the largest and most colourful one by the ICO ha
 
 \wxheading{Remarks}
 
-Depending on how wxWindows has been configured, not all formats may be available.
+Depending on how wxWidgets has been configured, not all formats may be available.
 
 Note: you can use \helpref{GetOptionInt}{wximagegetoptionint} to get the 
 hotspot for loaded cursor file:
@@ -703,7 +721,7 @@ mimetype from a file}
 
 Returns true if image data is present.
 
-\membersection{wxImage::RemoveHandler}
+\membersection{wxImage::RemoveHandler}\label{wximageremovehandler}
 
 \func{static bool}{RemoveHandler}{\param{const wxString\& }{name}}
 
@@ -815,7 +833,7 @@ true if the operation succeeded, false otherwise.
 
 \wxheading{Remarks}
 
-Depending on how wxWindows has been configured, not all formats may be available.
+Depending on how wxWidgets has been configured, not all formats may be available.
 
 Note: you can use \helpref{GetOptionInt}{wximagegetoptionint} to set the 
 hotspot before saving an image into a cursor file (default hotspot is in 
@@ -987,7 +1005,7 @@ data, but in some cases this might be too slow so that the data will have to
 be set directly. In that case you will have to get access to the image data 
 using the \helpref{GetData}{wximagegetdata} method.
 
-\membersection{wxImage::operator $=$}
+\membersection{wxImage::operator $=$}\label{wximageassign}
 
 \func{wxImage\& }{operator $=$}{\param{const wxImage\& }{image}}
 
@@ -1003,7 +1021,7 @@ counter. It is a fast operation.
 
 Returns 'this' object.
 
-\membersection{wxImage::operator $==$}
+\membersection{wxImage::operator $==$}\label{wximageequal}
 
 \constfunc{bool}{operator $==$}{\param{const wxImage\& }{image}}
 
@@ -1018,7 +1036,7 @@ equal (a fast test).
 
 Returns true if the images were effectively equal, false otherwise.
 
-\membersection{wxImage::operator $!=$}
+\membersection{wxImage::operator $!=$}\label{wximagenotequal}
 
 \constfunc{bool}{operator $!=$}{\param{const wxImage\& }{image}}
 
@@ -1046,7 +1064,7 @@ application initialisation.
 
 This software is based in part on the work of the Independent JPEG Group.
 
-(Applies when wxWindows is linked with JPEG support. wxJPEGHandler uses libjpeg
+(Applies when wxWidgets is linked with JPEG support. wxJPEGHandler uses libjpeg
 created by IJG.)
 
 \wxheading{Derived from}
@@ -1064,26 +1082,26 @@ created by IJG.)
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxImageHandler::wxImageHandler}\label{wximagehandlerconstr}
+\membersection{wxImageHandler::wxImageHandler}\label{wximagehandlerctor}
 
 \func{}{wxImageHandler}{\void}
 
 Default constructor. In your own default constructor, initialise the members
 m\_name, m\_extension and m\_type.
 
-\membersection{wxImageHandler::\destruct{wxImageHandler}}
+\membersection{wxImageHandler::\destruct{wxImageHandler}}\label{wximagehandlerdtor}
 
 \func{}{\destruct{wxImageHandler}}{\void}
 
 Destroys the wxImageHandler object.
 
-\membersection{wxImageHandler::GetName}
+\membersection{wxImageHandler::GetName}\label{wximagehandlergetname}
 
 \constfunc{wxString}{GetName}{\void}
 
 Gets the name of this handler.
 
-\membersection{wxImageHandler::GetExtension}
+\membersection{wxImageHandler::GetExtension}\label{wximagehandlergetextension}
 
 \constfunc{wxString}{GetExtension}{\void}
 
@@ -1104,13 +1122,13 @@ available images.
 Number of available images. For most image handlers, this is 1 (exceptions
 are TIFF and ICO formats).
 
-\membersection{wxImageHandler::GetType}
+\membersection{wxImageHandler::GetType}\label{wximagehandlergettype}
 
 \constfunc{long}{GetType}{\void}
 
 Gets the image type associated with this handler.
 
-\membersection{wxImageHandler::GetMimeType}
+\membersection{wxImageHandler::GetMimeType}\label{wximagehandlergetmimetype}
 
 \constfunc{wxString}{GetMimeType}{\void}
 
@@ -1166,7 +1184,7 @@ true if the operation succeeded, false otherwise.
 \helpref{wxImage::SaveFile}{wximagesavefile}, 
 \helpref{wxImageHandler::LoadFile}{wximagehandlerloadfile}
 
-\membersection{wxImageHandler::SetName}
+\membersection{wxImageHandler::SetName}\label{wximagehandlersetname}
 
 \func{void}{SetName}{\param{const wxString\& }{name}}
 
@@ -1176,7 +1194,7 @@ Sets the handler name.
 
 \docparam{name}{Handler name.}
 
-\membersection{wxImageHandler::SetExtension}
+\membersection{wxImageHandler::SetExtension}\label{wximagehandlersetextension}
 
 \func{void}{SetExtension}{\param{const wxString\& }{extension}}
 
@@ -1196,7 +1214,7 @@ Sets the handler MIME type.
 
 \docparam{mimename}{Handler MIME type.}
 
-\membersection{wxImageHandler::SetType}
+\membersection{wxImageHandler::SetType}\label{wximagehandlersettype}
 
 \func{void}{SetType}{\param{long }{type}}