added null pointer check and assert

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

diff --git a/docs/latex/wx/animation.tex b/docs/latex/wx/animation.tex
index 9e3e6df8250de072bbd6d67e1f1da5ca0aa8bd86..62e2a3918705e540028283fd35eb5b1eb7dddd3e 100644 (file)
--- a/docs/latex/wx/animation.tex
+++ b/docs/latex/wx/animation.tex
@@ -23,6 +23,10 @@ Sound is not supported by wxAnimation.
 
 <wx/animate.h>
 
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
 \wxheading{Predefined objects}
 
 Objects:
@@ -44,13 +48,14 @@ Default constructor.
 
 \func{}{wxAnimation}{\param{const wxAnimation\& }{anim}}
 
-Copy constructor.
-wxAnimation objects are reference counted so that this operation is very fast.
+Copy constructor, uses \helpref{reference counting}{trefcount}.
 
 \func{}{wxAnimation}{\param{const wxString\& }{name}, \param{wxAnimationType}{ type = wxANIMATION\_TYPE\_ANY}}
 
 Loads an animation from a file.
 
+\wxheading{Parameters}
+
 \docparam{name}{The name of the file to load.}
 
 \docparam{type}{See \helpref{LoadFile}{wxanimationloadfile} for more info.}
@@ -60,15 +65,13 @@ Loads an animation from a file.
 
 \func{}{\destruct{wxAnimation}}{\void}
 
-Destroys the wxAnimation object and possibly the underlying animation data.
-Because reference counting is used, the animation may not actually be
-destroyed at this point - only when the reference count is zero will the
-data be deleted.
+Destructor.
+See \helpref{reference-counted object destruction}{refcountdestruct} for more info.
 
 
 \membersection{wxAnimation::GetDelay}\label{wxanimationgetdelay}
 
-\constfunc{int}{GetDelay}{\param{size\_t }{i}}
+\constfunc{int}{GetDelay}{\param{unsigned int }{i}}
 
 Returns the delay for the i-th frame in milliseconds.
 If {\tt -1} is returned the frame is to be displayed forever.
@@ -76,14 +79,14 @@ If {\tt -1} is returned the frame is to be displayed forever.
 
 \membersection{wxAnimation::GetFrameCount}\label{wxanimationgetframecount}
 
-\constfunc{size\_t}{GetFrameCount}{\void}
+\constfunc{unsigned int}{GetFrameCount}{\void}
 
 Returns the number of frames for this animation.
 
 
 \membersection{wxAnimation::GetFrame}\label{wxanimationgetframe}
 
-\constfunc{wxImage}{GetFrame}{\param{size\_t }{i}}
+\constfunc{wxImage}{GetFrame}{\param{unsigned int }{i}}
 
 Returns the i-th frame as a \helpref{wxImage}{wximage}.
 
@@ -104,7 +107,7 @@ Returns \true if animation data is present.
 
 \membersection{wxAnimation::Load}\label{wxanimationload}
 
-\func{bool}{Load}{\param{wxInputStream&}{ stream}, \param{wxAnimationType}{ type = wxANIMATION\_TYPE\_ANY}}
+\func{bool}{Load}{\param{wxInputStream\&}{ stream}, \param{wxAnimationType}{ type = wxANIMATION\_TYPE\_ANY}}
 
 Loads an animation from the given stream.
 
@@ -116,9 +119,9 @@ Loads an animation from the given stream.
 
 \twocolwidtha{5cm}
 \begin{twocollist}
-\twocolitem{\indexit{wxANIM\_TYPE\_GIF}}{Load an animated GIF file.}
-\twocolitem{\indexit{wxANIM\_TYPE\_ANI}}{Load an ANI file.}
-\twocolitem{\indexit{wxANIM\_TYPE\_ANY}}{Try to autodetect the filetype.}
+\twocolitem{\indexit{wxANIMATION\_TYPE\_GIF}}{Load an animated GIF file.}
+\twocolitem{\indexit{wxANIMATION\_TYPE\_ANI}}{Load an ANI file.}
+\twocolitem{\indexit{wxANIMATION\_TYPE\_ANY}}{Try to autodetect the filetype.}
 \end{twocollist}
 }
 
@@ -141,9 +144,9 @@ Loads an animation from a file.
 
 \twocolwidtha{5cm}
 \begin{twocollist}
-\twocolitem{\indexit{wxANIM\_TYPE\_GIF}}{Load an animated GIF file.}
-\twocolitem{\indexit{wxANIM\_TYPE\_ANI}}{Load an ANI file.}
-\twocolitem{\indexit{wxANIM\_TYPE\_ANY}}{Try to autodetect the filetype.}
+\twocolitem{\indexit{wxANIMATION\_TYPE\_GIF}}{Load an animated GIF file.}
+\twocolitem{\indexit{wxANIMATION\_TYPE\_ANI}}{Load an ANI file.}
+\twocolitem{\indexit{wxANIMATION\_TYPE\_ANY}}{Try to autodetect the filetype.}
 \end{twocollist}
 }
 
@@ -151,3 +154,10 @@ Loads an animation from a file.
 
 \true if the operation succeeded, \false otherwise.
 
+
+\membersection{wxAnimation::operator $=$}\label{wxanimationassignment}
+
+\func{wxAnimation\&}{operator $=$}{\param{const wxAnimation\& }{brush}}
+
+Assignment operator, using \helpref{reference counting}{trefcount}.
+