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{Library}
  25
  26 \helpref{wxMedia}{librarieslist}
  27
  28 \wxheading{Event table macros}
  29
  30 \twocolwidtha{7cm}
  31 \begin{twocollist}\itemsep=0pt
  32 \twocolitem{{\bf EVT\_MEDIA\_LOADED(id, func)}}{
  33 Sent when a media has loaded enough data that it can start playing.}
  34 \twocolitem{{\bf EVT\_MEDIA\_STOP(id, func)}}{
  35 Send when a media has switched to the wxMEDIASTATE\_STOPPED state.
  36 You may be able to Veto this event to prevent it from stopping,
  37 causing it to continue playing - even if it has reached that end of the media
  38 (note that this may not have the desired effect - if you want to loop the
  39 media, for example, catch the EVT\_MEDIA\_FINISHED and play there instead). }
  40 \twocolitem{{\bf EVT\_MEDIA\_FINISHED(id, func)}}{
  41 Sent when a media has finished playing in a \helpref{wxMediaCtrl}{wxmediactrl}.
  42 }
  43 \twocolitem{{\bf EVT\_MEDIA\_STATECHANGED(id, func)}}{
  44 Send when a media has switched its state (from any media state).
  45 }
  46 \twocolitem{{\bf EVT\_MEDIA\_PLAY(id, func)}}{
  47 Send when a media has switched to the wxMEDIASTATE\_PLAYING state.
  48 }
  49 \twocolitem{{\bf EVT\_MEDIA\_PAUSE(id, func)}}{
  50 Send when a media has switched to the wxMEDIASTATE\_PAUSED state.
  51 }
  52 \end{twocollist}
  53
  54 \latexignore{\rtfignore{\wxheading{Members}}}
  55