X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/55ccdb93e4ae4b606a4068cb37492c1ec3ed77a6..c36cdfc084f779b67668af8cad3eb6906182af21:/docs/latex/wx/animation.tex?ds=sidebyside diff --git a/docs/latex/wx/animation.tex b/docs/latex/wx/animation.tex index 8b6c013d06..62e2a39187 100644 --- a/docs/latex/wx/animation.tex +++ b/docs/latex/wx/animation.tex @@ -23,6 +23,10 @@ Sound is not supported by wxAnimation. +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \wxheading{Predefined objects} Objects: @@ -50,6 +54,8 @@ Copy constructor, uses \helpref{reference counting}{trefcount}. 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.} @@ -65,7 +71,7 @@ See \helpref{reference-counted object destruction}{refcountdestruct} for more in \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. @@ -73,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}. @@ -101,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. @@ -113,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} } @@ -138,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} }