add events API to wxHtmlWindow (patch #1504493 by Francesco Montorsi)

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

diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex
index 6204e9fd6b93754a8d3df8df7f82259ebc72c29a..8920eea23cd2b19ada4e3befa8e762599b5d97dc 100644 (file)
--- a/docs/latex/wx/image.tex
+++ b/docs/latex/wx/image.tex
@@ -45,7 +45,7 @@ as support for saving images with alpha channel which also isn't implemented).
 
 The following image handlers are available. {\bf wxBMPHandler} is always
 installed by default. To use other image formats, install the appropriate
 
 The following image handlers are available. {\bf wxBMPHandler} is always
 installed by default. To use other image formats, install the appropriate

-handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
+handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or call 

 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
 
 \twocolwidtha{5cm}%
 \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
 
 \twocolwidtha{5cm}%


@@ -57,6 +57,7 @@ handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or
 \twocolitem{\indexit{wxPCXHandler}}{For loading and saving (see below).}
 \twocolitem{\indexit{wxPNMHandler}}{For loading and saving (see below).}
 \twocolitem{\indexit{wxTIFFHandler}}{For loading and saving.}
 \twocolitem{\indexit{wxPCXHandler}}{For loading and saving (see below).}
 \twocolitem{\indexit{wxPNMHandler}}{For loading and saving (see below).}
 \twocolitem{\indexit{wxTIFFHandler}}{For loading and saving.}

+\twocolitem{\indexit{wxTGAHandler}}{For loading only.}

 \twocolitem{\indexit{wxIFFHandler}}{For loading only.}
 \twocolitem{\indexit{wxXPMHandler}}{For loading and saving.}
 \twocolitem{\indexit{wxICOHandler}}{For loading and saving.}
 \twocolitem{\indexit{wxIFFHandler}}{For loading only.}
 \twocolitem{\indexit{wxXPMHandler}}{For loading and saving.}
 \twocolitem{\indexit{wxICOHandler}}{For loading and saving.}


@@ -95,7 +96,7 @@ Default constructor.
 
 \func{}{wxImage}{\param{const wxImage\& }{image}}
 
 
 \func{}{wxImage}{\param{const wxImage\& }{image}}
 

-Copy constructor.
+Copy constructor, uses \helpref{reference counting}{trefcount}.

 
 \func{}{wxImage}{\param{const wxBitmap\&}{ bitmap}}
 
 
 \func{}{wxImage}{\param{const wxBitmap\&}{ bitmap}}
 


@@ -128,7 +129,7 @@ Loads an image from a file.
 
 Loads an image from an input stream.
 
 
 Loads an image from an input stream.
 

-\func{}{wxImage}{\param{const char** }{xpmData}}
+\func{}{wxImage}{\param{const char* const* }{xpmData}}

 
 Creates an image from XPM data.
 
 
 Creates an image from XPM data.
 


@@ -153,6 +154,7 @@ Creates an image from XPM data.
 \twocolitem{\indexit{wxBITMAP\_TYPE\_PCX}}{Load a PCX bitmap file.}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_PNM}}{Load a PNM bitmap file.}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_TIF}}{Load a TIFF bitmap file.}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_PCX}}{Load a PCX bitmap file.}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_PNM}}{Load a PNM bitmap file.}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_TIF}}{Load a TIFF bitmap file.}

+\twocolitem{\indexit{wxBITMAP\_TYPE\_TGA}}{Load a TGA bitmap file.}

 \twocolitem{\indexit{wxBITMAP\_TYPE\_XPM}}{Load a XPM bitmap file.}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_ICO}}{Load a Windows icon file (ICO).}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_CUR}}{Load a Windows cursor file (CUR).}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_XPM}}{Load a XPM bitmap file.}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_ICO}}{Load a Windows icon file (ICO).}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_CUR}}{Load a Windows cursor file (CUR).}


@@ -248,7 +250,9 @@ returns true if the current image handlers can read this file
 
 \func{wxImage}{Blur}{\param{int}{ blurRadius}}
 
 
 \func{wxImage}{Blur}{\param{int}{ blurRadius}}
 

-Blurs the image in both horizontal and vertical directions by the specified pixel {\it blurRadius}.
+Blurs the image in both horizontal and vertical directions by the specified pixel
+{\it blurRadius}. This should not be used when using a single mask colour
+for transparency.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -260,8 +264,8 @@ Blurs the image in both horizontal and vertical directions by the specified pixe
 
 \func{wxImage}{BlurHorizontal}{\param{int}{ blurRadius}}
 
 
 \func{wxImage}{BlurHorizontal}{\param{int}{ blurRadius}}
 

-Blurs the image in the horizontal direction only.
-
+Blurs the image in the horizontal direction only. This should not be used
+when using a single mask colour for transparency.

 \wxheading{See also}
 
 \helpref{Blur}{wximageblur}
 \wxheading{See also}
 
 \helpref{Blur}{wximageblur}


@@ -272,7 +276,8 @@ Blurs the image in the horizontal direction only.
 
 \func{wxImage}{BlurVertical}{\param{int}{ blurRadius}}
 
 
 \func{wxImage}{BlurVertical}{\param{int}{ blurRadius}}
 

-Blurs the image in the vertical direction only.
+Blurs the image in the vertical direction only. This should not be used
+when using a single mask colour for transparency.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -881,9 +886,9 @@ mimetype from a file}
 
 
 
 
 
 

-\membersection{wxImage::Ok}\label{wximageok}
+\membersection{wxImage::IsOk}\label{wximageisok}

 
 

-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}

 
 Returns true if image data is present.
 
 
 Returns true if image data is present.
 


@@ -1095,9 +1100,6 @@ Returns a scaled version of the image. This is also useful for
 scaling bitmaps in general as the only other way to scale bitmaps
 is to blit a wxMemoryDC into another wxMemoryDC.
 
 scaling bitmaps in general as the only other way to scale bitmaps
 is to blit a wxMemoryDC into another wxMemoryDC.
 

-It may be mentioned that the GTK port uses this function internally
-to scale bitmaps when using mapping modes in wxDC.
-

 \docparam{quality}{Determines what method to use for resampling the image.  Can be one of the following:
 
 \twocolwidtha{5cm}%
 \docparam{quality}{Determines what method to use for resampling the image.  Can be one of the following:
 
 \twocolwidtha{5cm}%


@@ -1287,9 +1289,7 @@ data.
 
 \func{wxImage\& }{operator $=$}{\param{const wxImage\& }{image}}
 
 
 \func{wxImage\& }{operator $=$}{\param{const wxImage\& }{image}}
 

-Assignment operator. This operator does not copy any data, but instead
-passes a pointer to the data in {\it image} and increments a reference
-counter. It is a fast operation.
+Assignment operator, using \helpref{reference counting}{trefcount}.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -1380,14 +1380,14 @@ Destroys the wxImageHandler object.
 
 \membersection{wxImageHandler::GetName}\label{wximagehandlergetname}
 
 
 \membersection{wxImageHandler::GetName}\label{wximagehandlergetname}
 

-\constfunc{wxString}{GetName}{\void}
+\constfunc{const wxString\&}{GetName}{\void}

 
 Gets the name of this handler.
 
 
 \membersection{wxImageHandler::GetExtension}\label{wximagehandlergetextension}
 
 
 Gets the name of this handler.
 
 
 \membersection{wxImageHandler::GetExtension}\label{wximagehandlergetextension}
 

-\constfunc{wxString}{GetExtension}{\void}
+\constfunc{const wxString\&}{GetExtension}{\void}

 
 Gets the file extension associated with this handler.
 
 
 Gets the file extension associated with this handler.
 


@@ -1417,7 +1417,7 @@ Gets the image type associated with this handler.
 
 \membersection{wxImageHandler::GetMimeType}\label{wximagehandlergetmimetype}
 
 
 \membersection{wxImageHandler::GetMimeType}\label{wximagehandlergetmimetype}
 

-\constfunc{wxString}{GetMimeType}{\void}
+\constfunc{const wxString\&}{GetMimeType}{\void}

 
 Gets the MIME type associated with this handler.
 
 
 Gets the MIME type associated with this handler.