]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/mediaevt.tex
Fix "depreciated" to "deprecated".
[wxWidgets.git] / docs / latex / wx / mediaevt.tex
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %% Name: mediaevt.tex
3 %% Purpose: wxMediaEvent docs
4 %% Author: Ryan Norton <wxprojects@comcast.net>
5 %% Modified by:
6 %% Created: 11/7/2004
7 %% RCS-ID: $Id$
8 %% Copyright: (c) Ryan Norton
9 %% License: wxWindows license
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12 \section{\class{wxMediaEvent}}\label{wxmediaevent}
13
14 Event \helpref{wxMediaCtrl}{wxmediactrl} uses.
15
16 \wxheading{Derived from}
17
18 \helpref{wxNotifyEvent}{wxnotifyevent}
19
20 \wxheading{Include files}
21
22 <wx/mediactrl.h>
23
24 \wxheading{Event table macros}
25
26 \twocolwidtha{7cm}
27 \begin{twocollist}\itemsep=0pt
28 \twocolitem{{\bf EVT\_MEDIA\_LOADED(id, func)}}{
29 Sent when a media has loaded enough data that it can start playing.}
30 \twocolitem{{\bf EVT\_MEDIA\_STOP(id, func)}}{
31 Send when a media has switched to the wxMEDIASTATE\_STOPPED state.
32 You may be able to Veto this event to prevent it from stopping,
33 causing it to continue playing - even if it has reached that end of the media
34 (note that this may not have the desired effect - if you want to loop the
35 media, for example, catch the EVT\_MEDIA\_FINISHED and play there instead). }
36 \twocolitem{{\bf EVT\_MEDIA\_FINISHED(id, func)}}{
37 Sent when a media has finished playing in a \helpref{wxMediaCtrl}{wxmediactrl}.
38 }
39 \twocolitem{{\bf EVT\_MEDIA\_STATECHANGED(id, func)}}{
40 Send when a media has switched its state (from any media state).
41 }
42 \twocolitem{{\bf EVT\_MEDIA\_PLAY(id, func)}}{
43 Send when a media has switched to the wxMEDIASTATE\_PLAYING state.
44 }
45 \twocolitem{{\bf EVT\_MEDIA\_PAUSE(id, func)}}{
46 Send when a media has switched to the wxMEDIASTATE\_PAUSED state.
47 }
48 \end{twocollist}
49
50 \latexignore{\rtfignore{\wxheading{Members}}}
51