added null pointer check and assert

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

diff --git a/docs/latex/wx/animatctrl.tex b/docs/latex/wx/animatctrl.tex
index d66bac7f0cb3c3ba5f5ab76dc26033d925fb8c74..ae89a733c990a54d0af4768e9368154a172052df 100644 (file)
--- a/docs/latex/wx/animatctrl.tex
+++ b/docs/latex/wx/animatctrl.tex
@@ -30,12 +30,16 @@ It is only available if \texttt{wxUSE\_ANIMATIONCTRL} is set to $1$ (the default
 
 <wx/animate.h>
 
 
 <wx/animate.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+

 \wxheading{Window styles}
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\windowstyle{wxAC\_DEFAULT\_STYLE}}{The default style: wxNO_BORDER.}
-\twocolitem{\windowstyle{wxAC\_NO_AUTORESIZE}}{By default, the control will adjust
+\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}
 \end{twocollist}
 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}
 \end{twocollist}


@@ -54,7 +58,7 @@ is called. If this style flag is given, the control will not change its size}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxAnimationCtrl::wxAnimationCtrl}\label{wxanimationctrl}
+\membersection{wxAnimationCtrl::wxAnimationCtrl}\label{wxanimationctrlctor}

 
 \func{}{wxAnimationCtrl}{\param{wxWindow *}{parent},\rtfsp
 \param{wxWindowID}{ id},\rtfsp
 
 \func{}{wxAnimationCtrl}{\param{wxWindow *}{parent},\rtfsp
 \param{wxWindowID}{ id},\rtfsp


@@ -80,7 +84,7 @@ all the parameters.
 
 \wxheading{Parameters}
 
 
 \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.}
 
 
 \docparam{id}{The identifier for the control.}
 


@@ -110,6 +114,14 @@ of the animation is displayed.
 Returns the animation associated with this control.
 
 
 Returns the animation associated with this control.
 
 

+\membersection{wxAnimationCtrl::GetInactiveBitmap}\label{wxanimationctrlgetinactivebitmap}
+
+\constfunc{wxBitmap}{GetInactiveBitmap}{\void}
+
+Returns the inactive bitmap shown in this control when the;
+see \helpref{SetInactiveBitmap}{wxanimationctrlsetinactivebitmap} for more info.
+
+

 \membersection{wxAnimationCtrl::IsPlaying}\label{wxanimationctrlisplaying}
 
 \constfunc{bool}{IsPlaying}{\void}
 \membersection{wxAnimationCtrl::IsPlaying}\label{wxanimationctrlisplaying}
 
 \constfunc{bool}{IsPlaying}{\void}


@@ -132,7 +144,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
 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).
 
 
 displayed).
 
 


@@ -143,11 +155,27 @@ displayed).
 Sets the animation to play in this control.
 If the previous animation is being played, it's \helpref{Stopped}{wxanimationctrlstop}.
 
 Sets the animation to play in this control.
 If the previous animation is being played, it's \helpref{Stopped}{wxanimationctrlstop}.
 

-Until \helpref{Play}{wxanimationctrlplay} isn't called, the first frame
-of the animation is displayed.
+Until \helpref{Play}{wxanimationctrlplay} isn't called, a static image, the first
+frame of the given animation or the background colour will be shown
+(see \helpref{SetInactiveBitmap}{wxanimationctrlsetinactivebitmap} for more info).

 
 

-If {\tt wxNullAnimation} is given as animation, the control will be cleared to display
-the background colour (see \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour}).
+
+\membersection{wxAnimationCtrl::SetInactiveBitmap}\label{wxanimationctrlsetinactivebitmap}
+
+\func{void}{SetInactiveBitmap}{\param{const wxBitmap\& }{bmp}}
+
+Sets the bitmap to show on the control when it's not playing an animation.
+If you set as inactive bitmap {\tt wxNullBitmap} (which is the default), then the
+first frame of the animation is instead shown when the control is inactive; in this case,
+if there's no valid animation associated with the control (see \helpref{SetAnimation}{wxanimationctrlsetanimation}),
+then the background colour of the window is shown.
+
+If the control is not playing the animation, the given bitmap will be immediately
+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}
 
 
 \membersection{wxAnimationCtrl::Stop}\label{wxanimationctrlstop}


@@ -155,5 +183,7 @@ the background colour (see \helpref{wxWindow::GetBackgroundColour}{wxwindowgetba
 \func{void}{Stop}{\void}
 
 Stops playing the animation.
 \func{void}{Stop}{\void}
 
 Stops playing the animation.

-The control will show the last frame rendered of the current animation until
-\helpref{Play}{wxanimationctrlplay} is called.
+The control will show the first frame of the animation, a custom static image or
+the window's background colour as specified by the
+last \helpref{SetInactiveBitmap}{wxanimationctrlsetinactivebitmap} call.
+