X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8e458bb53997706d4432d2dc0b9b516320709389..85136e3bf5dadf921652519e71da5db351fb3194:/docs/latex/wx/animatctrl.tex diff --git a/docs/latex/wx/animatctrl.tex b/docs/latex/wx/animatctrl.tex index ba36f1f976..7a4dbf488b 100644 --- a/docs/latex/wx/animatctrl.tex +++ b/docs/latex/wx/animatctrl.tex @@ -30,11 +30,15 @@ It is only available if \texttt{wxUSE\_ANIMATIONCTRL} is set to $1$ (the default +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm}% \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxAC\_DEFAULT\_STYLE}}{The default style: wxNO\_BORDER.} +\twocolitem{\windowstyle{wxAC\_DEFAULT\_STYLE}}{The default style: wxBORDER\_NONE.} \twocolitem{\windowstyle{wxAC\_NO\_AUTORESIZE}}{By default, the control will adjust its size to exactly fit to the size of the animation when \helpref{SetAnimation}{wxanimationctrlsetanimation} is called. If this style flag is given, the control will not change its size} @@ -54,7 +58,7 @@ is called. If this style flag is given, the control will not change its size} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxAnimationCtrl::wxAnimationCtrl}\label{wxanimationctrl} +\membersection{wxAnimationCtrl::wxAnimationCtrl}\label{wxanimationctrlctor} \func{}{wxAnimationCtrl}{\param{wxWindow *}{parent},\rtfsp \param{wxWindowID}{ id},\rtfsp @@ -78,9 +82,13 @@ all the parameters. \param{long}{ style = wxAC\_DEFAULT\_STYLE},\rtfsp \param{const wxString\& }{name = ``animationctrl"}} +After control creation you must explicitely call \helpref{Play}{wxanimationctrlplay} +to start to play the animation. Until that function won't be called, the first frame +of the animation is displayed. + \wxheading{Parameters} -\docparam{parent}{Parent window, must not be non-\texttt{NULL}.} +\docparam{parent}{Parent window, must be non-\NULL.} \docparam{id}{The identifier for the control.} @@ -94,9 +102,6 @@ all the parameters. \docparam{name}{Control name.} -After control creation you must explicitely call \helpref{Play}{wxanimationctrlplay} -to start to play the animation. Until that function won't be called, the first frame -of the animation is displayed. \wxheading{Return value} @@ -140,7 +145,7 @@ See \helpref{wxAnimation::LoadFile}{wxanimationloadfile} for more info. Starts playing the animation. The animation is always played in loop mode (unless the last frame of the animation has an infinite delay time) and always start from the first frame -(even if you \helpref{atopped}{wxanimationctrlstop} it while some other frame was +(even if you \helpref{stopped}{wxanimationctrlstop} it while some other frame was displayed). @@ -170,6 +175,10 @@ If the control is not playing the animation, the given bitmap will be immediatel shown, otherwise it will be shown as soon as \helpref{Stop}{wxanimationctrlstop} is called. +Note that the inactive bitmap, if smaller than the control's size, will be centered in +the control; if bigger, it will be stretched to fit it. + + \membersection{wxAnimationCtrl::Stop}\label{wxanimationctrlstop} \func{void}{Stop}{\void}