X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/72045d5768a126191a907bc640c28e81a11afdd6..dc484d491b15355285a89da275c58c2ef247d1f4:/docs/latex/wx/animation.tex?ds=sidebyside diff --git a/docs/latex/wx/animation.tex b/docs/latex/wx/animation.tex index 298c9f1df4..8b6c013d06 100644 --- a/docs/latex/wx/animation.tex +++ b/docs/latex/wx/animation.tex @@ -44,8 +44,7 @@ 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}} @@ -60,15 +59,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{size\_t }{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 +73,14 @@ If {\tt -1} is returned the frame is to be displayed forever. \membersection{wxAnimation::GetFrameCount}\label{wxanimationgetframecount} -\constfunc{size_t}{GetFrameCount}{\void} +\constfunc{size\_t}{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{size\_t }{i}} Returns the i-th frame as a \helpref{wxImage}{wximage}. @@ -151,3 +148,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}. +