docs/latex/wx/moviectrl.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        moviectrl.tex
   3 %% Purpose:     wxMovieCtrl 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{wxMovieCtrl}}\label{wxmoviectrl}
  13
  14 PRELIMINARY
  15
  16 Plays movies - Currently Windows and Mac only.
  17
  18
  19 \wxheading{Derived from}
  20
  21 \helpref{wxControl}{wxcontrol}
  22
  23 \wxheading{Include files}
  24
  25 <wx/moviectrl.h>
  26
  27 \latexignore{\rtfignore{\wxheading{Members}}}
  28
  29
  30 \membersection{wxMovieCtrl::wxMovieCtrl}\label{wxmoviectrlwxmoviectrl}
  31
  32 \func{}{wxMovieCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{fileName}, \param{const wxString\& }{label = wxT("")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}, \param{const wxString\& }{name = wxPanelNameStr}}
  33
  34
  35 \func{}{wxMovieCtrl}{\void}
  36
  37 Contructors
  38
  39 \docparam{parent}{parent of this control.  Must not be NULL.}
  40 \docparam{id}{id to use for events}
  41 \docparam{fileName}{If not empty, loads this file and starts playing it immediately.}
  42 \docparam{label}{Control label - possible caption for the movie.}
  43 \docparam{pos}{Position to put control at.}
  44 \docparam{size}{Size to put the control at and to stretch movie to.}
  45 \docparam{style}{Optional styles.}
  46 \docparam{name}{Window name.}
  47
  48
  49 \membersection{wxMovieCtrl::Create}\label{wxmoviectrlcreate}
  50
  51 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{fileName}, \param{const wxString\& }{label = wxT("")}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}, \param{const wxString\& }{name = wxPanelNameStr}}
  52
  53 Creates this control.  Returns \tt{false} if it can't load the movie located at \tt{fileName}
  54
  55
  56 \docparam{parent}{parent of this control.  Must not be NULL.}
  57 \docparam{id}{id to use for events}
  58 \docparam{fileName}{If not empty, loads this file and starts playing it immediately.}
  59 \docparam{label}{Control label - possible caption for the movie.}
  60 \docparam{pos}{Position to put control at.}
  61 \docparam{size}{Size to put the control at and to stretch movie to.}
  62 \docparam{style}{Optional styles.}
  63 \docparam{name}{Window name.}
  64
  65
  66 \membersection{wxMovieCtrl::GetPlaybackRate}\label{wxmoviectrlgetplaybackrate}
  67
  68 \func{double}{GetPlaybackRate}{\void}
  69
  70 Obtains the current playback speed of the movie. 1.0 equals normal speed, 0.5 half, etc.
  71
  72
  73 \membersection{wxMovieCtrl::GetState}\label{wxmoviectrlgetstate}
  74
  75 \func{wxMovieCtrlState}{GetState}{\void}
  76
  77 Obtains the state the playback of the movie is in -
  78
  79 \twocolwidtha{7cm}
  80 \begin{twocollist}\itemsep=0pt
  81 \twocolitem{{\bf wxMOVIECTRL\_STOPPED}}{The movie has stopped.}
  82 \twocolitem{{\bf wxMOVIECTRL\_PAUSED}}{The movie is paused.}
  83 \twocolitem{{\bf wxMOVIECTRL\_PLAYING}}{The movie is currently playing.}
  84 \end{twocollist}
  85
  86
  87 \membersection{wxMovieCtrl::Length}\label{wxmoviectrllength}
  88
  89 \func{wxTimeSpan}{Length}{\void}
  90
  91 Obtains the length - the total amount of time the movie has
  92
  93 \membersection{wxMovieCtrl::Load}\label{wxmoviectrlload}
  94
  95 \func{bool}{Load}{\param{const wxString\& }{fileName}}
  96
  97 Loads the file that \tt{fileName} refers to.
  98
  99 Unlike Create, you must manually call Play() to start playing the file.
 100
 101 \membersection{wxMovieCtrl::Pause}\label{wxmoviectrlpause}
 102
 103 \func{bool}{Pause}{\void}
 104
 105 Pauses playback of the movie.
 106
 107
 108 \membersection{wxMovieCtrl::Play}\label{wxmoviectrlplay}
 109
 110 \func{bool}{Play}{\void}
 111
 112 Resumes playback of the movie.
 113
 114
 115 \membersection{wxMovieCtrl::Seek}\label{wxmoviectrlseek}
 116
 117 \func{bool}{Seek}{\param{const wxTimeSpan\& }{where}}
 118
 119 Seeks to a position within the movie.
 120
 121
 122 \membersection{wxMovieCtrl::SetPlaybackRate}\label{wxmoviectrlsetplaybackrate}
 123
 124 \func{bool}{SetPlaybackRate}{\param{double }{dRate}}
 125
 126 Sets the current playback speed of the movie. 1.0 equals normal speed, 0.5 half, etc.
 127
 128
 129 \membersection{wxMovieCtrl::Stop}\label{wxmoviectrlstop}
 130
 131 \func{bool}{Stop}{\void}
 132
 133 Stops the movie and rewinds the movie to the start.
 134
 135
 136 \membersection{wxMovieCtrl::Tell}\label{wxmoviectrltell}
 137
 138 \func{wxTimeSpan}{Tell}{\void}
 139
 140 Obtains the current position in time within the movie.