]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/mediaevt.tex
interface headers reviewed
[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 \helpref{wxCommandEvent}{wxcommandevent}\\
20 \helpref{wxEvent}{wxevent}\\
21 \helpref{wxObject}{wxobject}
22
23 \wxheading{Include files}
24
25 <wx/mediactrl.h>
26
27 \wxheading{Library}
28
29 \helpref{wxMedia}{librarieslist}
30
31 \wxheading{Event table macros}
32
33 \twocolwidtha{7cm}
34 \begin{twocollist}\itemsep=0pt
35 \twocolitem{{\bf EVT\_MEDIA\_LOADED(id, func)}}{
36 Sent when a media has loaded enough data that it can start playing.}
37 \twocolitem{{\bf EVT\_MEDIA\_STOP(id, func)}}{
38 Send when a media has switched to the wxMEDIASTATE\_STOPPED state.
39 You may be able to Veto this event to prevent it from stopping,
40 causing it to continue playing - even if it has reached that end of the media
41 (note that this may not have the desired effect - if you want to loop the
42 media, for example, catch the EVT\_MEDIA\_FINISHED and play there instead). }
43 \twocolitem{{\bf EVT\_MEDIA\_FINISHED(id, func)}}{
44 Sent when a media has finished playing in a \helpref{wxMediaCtrl}{wxmediactrl}.
45 }
46 \twocolitem{{\bf EVT\_MEDIA\_STATECHANGED(id, func)}}{
47 Send when a media has switched its state (from any media state).
48 }
49 \twocolitem{{\bf EVT\_MEDIA\_PLAY(id, func)}}{
50 Send when a media has switched to the wxMEDIASTATE\_PLAYING state.
51 }
52 \twocolitem{{\bf EVT\_MEDIA\_PAUSE(id, func)}}{
53 Send when a media has switched to the wxMEDIASTATE\_PAUSED state.
54 }
55 \end{twocollist}
56
57 \latexignore{\rtfignore{\wxheading{Members}}}
58