Implemented wxBitmap::HasAlpha() and ::UseAlpha().

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index 741ba4a38521a90f476da42a2d9f602851954d4e..aa858fa2188c634216d0c5c8f9b2a9b293984425 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
 
 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}.
 
 This bitmap can then
 be drawn in a device context, using \helpref{wxDC::DrawBitmap}{wxdcdrawbitmap}.
 


@@ -76,7 +76,7 @@ PNM format, {\bf wxPNMHandler} will always save as raw RGB.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxImage::wxImage}\label{wximageconstr}
+\membersection{wxImage::wxImage}\label{wximagector}

 
 \func{}{wxImage}{\void}
 
 
 \func{}{wxImage}{\void}
 


@@ -199,7 +199,7 @@ platform-dependent bitmap}
 \end{itemize}
 }
 
 \end{itemize}
 }
 

-\membersection{wxImage::\destruct{wxImage}}
+\membersection{wxImage::\destruct{wxImage}}\label{wximagedtor}

 
 \func{}{\destruct{wxImage}}{\void}
 
 
 \func{}{\destruct{wxImage}}{\void}
 


@@ -223,7 +223,7 @@ 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}.}
 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}
 
 
 \func{static void}{CleanUpHandlers}{\void}
 


@@ -277,7 +277,7 @@ ConvertAlphaToMask does nothing.
 
 \constfunc{wxBitmap}{ConvertToBitmap}{\void}
 
 
 \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}
 (which takes wxImage and depth as its arguments) instead.
 
 \membersection{wxImage::ConvertToMono}\label{wxbitmapconverttomono}


@@ -313,7 +313,7 @@ true if the call succeeded, false otherwise.
 
 \membersection{wxImage::Destroy}\label{wximagedestroy}
 
 
 \membersection{wxImage::Destroy}\label{wximagedestroy}
 

-\func{bool}{Destroy}{\void}
+\func{void}{Destroy}{\void}

 
 Destroys the image data.
 
 
 Destroys the image data.
 


@@ -341,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.
 
 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}}
 
 
 \func{static wxImageHandler*}{FindHandler}{\param{const wxString\& }{name}}
 


@@ -375,7 +375,7 @@ A pointer to the handler if found, NULL otherwise.
 
 \helpref{wxImageHandler}{wximagehandler}
 
 
 \helpref{wxImageHandler}{wximagehandler}
 

-\membersection{wxImage::GetImageExtWildcard}
+\membersection{wxImage::GetImageExtWildcard}\label{wximagegetimageextwildcard}

 
 \func{static wxString}{GetImageExtWildcard}{\void}
 
 
 \func{static wxString}{GetImageExtWildcard}{\void}
 


@@ -430,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
 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}.
 
 You should not delete the returned pointer nor pass it to
 \helpref{wxImage::SetData}{wximagesetdata}.


@@ -479,7 +481,7 @@ available images.
 Number of available images. For most image handlers, this is 1 (exceptions
 are TIFF and ICO formats).
 
 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}
 
 
 \func{static wxList\&}{GetHandlers}{\void}
 


@@ -600,7 +602,7 @@ Returns true if the given option is present. The function is case-insensitive to
 \helpref{wxImage::GetOption}{wximagegetoption},\rtfsp
 \helpref{wxImage::GetOptionInt}{wximagegetoptionint}
 
 \helpref{wxImage::GetOption}{wximagegetoption},\rtfsp
 \helpref{wxImage::GetOptionInt}{wximagegetoptionint}
 

-\membersection{wxImage::InitStandardHandlers}
+\membersection{wxImage::InitStandardHandlers}\label{wximageinitstandardhandlers}

 
 \func{static void}{InitStandardHandlers}{\void}
 
 
 \func{static void}{InitStandardHandlers}{\void}
 


@@ -615,7 +617,7 @@ the user.
 \helpref{wxImageHandler}{wximagehandler}, 
 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
 
 \helpref{wxImageHandler}{wximagehandler}, 
 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
 

-\membersection{wxImage::InsertHandler}
+\membersection{wxImage::InsertHandler}\label{wximageinserthandler}

 
 \func{static void}{InsertHandler}{\param{wxImageHandler*}{ handler}}
 
 
 \func{static void}{InsertHandler}{\param{wxImageHandler*}{ handler}}
 


@@ -719,7 +721,7 @@ mimetype from a file}
 
 Returns true if image data is present.
 
 
 Returns true if image data is present.
 

-\membersection{wxImage::RemoveHandler}
+\membersection{wxImage::RemoveHandler}\label{wximageremovehandler}

 
 \func{static bool}{RemoveHandler}{\param{const wxString\& }{name}}
 
 
 \func{static bool}{RemoveHandler}{\param{const wxString\& }{name}}
 


@@ -1003,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.
 
 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}}
 
 
 \func{wxImage\& }{operator $=$}{\param{const wxImage\& }{image}}
 


@@ -1019,7 +1021,7 @@ counter. It is a fast operation.
 
 Returns 'this' object.
 
 
 Returns 'this' object.
 

-\membersection{wxImage::operator $==$}
+\membersection{wxImage::operator $==$}\label{wximageequal}

 
 \constfunc{bool}{operator $==$}{\param{const wxImage\& }{image}}
 
 
 \constfunc{bool}{operator $==$}{\param{const wxImage\& }{image}}
 


@@ -1034,7 +1036,7 @@ equal (a fast test).
 
 Returns true if the images were effectively equal, false otherwise.
 
 
 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}}
 
 
 \constfunc{bool}{operator $!=$}{\param{const wxImage\& }{image}}
 


@@ -1080,26 +1082,26 @@ created by IJG.)
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \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.
 
 
 \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.
 
 
 \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.
 
 
 \constfunc{wxString}{GetName}{\void}
 
 Gets the name of this handler.
 

-\membersection{wxImageHandler::GetExtension}
+\membersection{wxImageHandler::GetExtension}\label{wximagehandlergetextension}

 
 \constfunc{wxString}{GetExtension}{\void}
 
 
 \constfunc{wxString}{GetExtension}{\void}
 


@@ -1120,13 +1122,13 @@ available images.
 Number of available images. For most image handlers, this is 1 (exceptions
 are TIFF and ICO formats).
 
 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.
 
 
 \constfunc{long}{GetType}{\void}
 
 Gets the image type associated with this handler.
 

-\membersection{wxImageHandler::GetMimeType}
+\membersection{wxImageHandler::GetMimeType}\label{wximagehandlergetmimetype}

 
 \constfunc{wxString}{GetMimeType}{\void}
 
 
 \constfunc{wxString}{GetMimeType}{\void}
 


@@ -1182,7 +1184,7 @@ true if the operation succeeded, false otherwise.
 \helpref{wxImage::SaveFile}{wximagesavefile}, 
 \helpref{wxImageHandler::LoadFile}{wximagehandlerloadfile}
 
 \helpref{wxImage::SaveFile}{wximagesavefile}, 
 \helpref{wxImageHandler::LoadFile}{wximagehandlerloadfile}
 

-\membersection{wxImageHandler::SetName}
+\membersection{wxImageHandler::SetName}\label{wximagehandlersetname}

 
 \func{void}{SetName}{\param{const wxString\& }{name}}
 
 
 \func{void}{SetName}{\param{const wxString\& }{name}}
 


@@ -1192,7 +1194,7 @@ Sets the handler name.
 
 \docparam{name}{Handler name.}
 
 
 \docparam{name}{Handler name.}
 

-\membersection{wxImageHandler::SetExtension}
+\membersection{wxImageHandler::SetExtension}\label{wximagehandlersetextension}

 
 \func{void}{SetExtension}{\param{const wxString\& }{extension}}
 
 
 \func{void}{SetExtension}{\param{const wxString\& }{extension}}
 


@@ -1212,7 +1214,7 @@ Sets the handler MIME type.
 
 \docparam{mimename}{Handler MIME type.}
 
 
 \docparam{mimename}{Handler MIME type.}
 

-\membersection{wxImageHandler::SetType}
+\membersection{wxImageHandler::SetType}\label{wximagehandlersettype}

 
 \func{void}{SetType}{\param{long }{type}}
 
 
 \func{void}{SetType}{\param{long }{type}}