PageRenderTime 49ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/PyQt-x11-gpl-4.9.4/doc/html/qmovie.html

#
HTML | 309 lines | 237 code | 72 blank | 0 comment | 0 complexity | 9c11f5c28edfd0e4e701378366782225 MD5 | raw file
Possible License(s): GPL-2.0, GPL-3.0 
    

  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
    3. 

  3. <html><head><title>QMovie Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
    4. 

  4. a:link { color: #004faf; text-decoration: none }
    5. 

  5. a:visited { color: #672967; text-decoration: none }
    6. 

  6. td.postheader { font-family: sans-serif }
    7. 

  7. tr.address { font-family: sans-serif }
    8. 

  8. body { background: #ffffff; color: black; }
    9. 

  9. </style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">&#160;&#160;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&#160;&#183; <a href="classes.html"><font color="#004faf">All Classes</font></a>&#160;&#183; <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QMovie Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1><p>The QMovie class is a convenience class for playing movies with
    10. 

  10. <a href="qimagereader.html">QImageReader</a>. <a href="#details">More...</a></p>
    11. 

  11. 

  12. <p>Inherits <a href="qobject.html">QObject</a>.</p><h3>Types</h3><ul><li><div class="fn" />enum <b><a href="qmovie.html#CacheMode-enum">CacheMode</a></b> { CacheNone, CacheAll }</li><li><div class="fn" />enum <b><a href="qmovie.html#MovieState-enum">MovieState</a></b> { NotRunning, Paused, Running }</li></ul><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qmovie.html#QMovie">__init__</a></b> (<i>self</i>, QObject&#160;<i>parent</i>&#160;=&#160;None)</li><li><div class="fn" /><b><a href="qmovie.html#QMovie-2">__init__</a></b> (<i>self</i>, QIODevice&#160;<i>device</i>, QByteArray&#160;<i>format</i>&#160;=&#160;QByteArray(), QObject&#160;<i>parent</i>&#160;=&#160;None)</li><li><div class="fn" /><b><a href="qmovie.html#QMovie-3">__init__</a></b> (<i>self</i>, QString&#160;<i>fileName</i>, QByteArray&#160;<i>format</i>&#160;=&#160;QByteArray(), QObject&#160;<i>parent</i>&#160;=&#160;None)</li><li><div class="fn" />QColor <b><a href="qmovie.html#backgroundColor">backgroundColor</a></b> (<i>self</i>)</li><li><div class="fn" />CacheMode <b><a href="qmovie.html#cacheMode">cacheMode</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qmovie.html#currentFrameNumber">currentFrameNumber</a></b> (<i>self</i>)</li><li><div class="fn" />QImage <b><a href="qmovie.html#currentImage">currentImage</a></b> (<i>self</i>)</li><li><div class="fn" />QPixmap <b><a href="qmovie.html#currentPixmap">currentPixmap</a></b> (<i>self</i>)</li><li><div class="fn" />QIODevice <b><a href="qmovie.html#device">device</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qmovie.html#fileName">fileName</a></b> (<i>self</i>)</li><li><div class="fn" />QByteArray <b><a href="qmovie.html#format">format</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qmovie.html#frameCount">frameCount</a></b> (<i>self</i>)</li><li><div class="fn" />QRect <b><a href="qmovie.html#frameRect">frameRect</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qmovie.html#isValid">isValid</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qmovie.html#jumpToFrame">jumpToFrame</a></b> (<i>self</i>, int&#160;<i>frameNumber</i>)</li><li><div class="fn" />bool <b><a href="qmovie.html#jumpToNextFrame">jumpToNextFrame</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qmovie.html#loopCount">loopCount</a></b> (<i>self</i>)</li><li><div class="fn" />int <b><a href="qmovie.html#nextFrameDelay">nextFrameDelay</a></b> (<i>self</i>)</li><li><div class="fn" />QSize <b><a href="qmovie.html#scaledSize">scaledSize</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qmovie.html#setBackgroundColor">setBackgroundColor</a></b> (<i>self</i>, QColor&#160;<i>color</i>)</li><li><div class="fn" /><b><a href="qmovie.html#setCacheMode">setCacheMode</a></b> (<i>self</i>, CacheMode&#160;<i>mode</i>)</li><li><div class="fn" /><b><a href="qmovie.html#setDevice">setDevice</a></b> (<i>self</i>, QIODevice&#160;<i>device</i>)</li><li><div class="fn" /><b><a href="qmovie.html#setFileName">setFileName</a></b> (<i>self</i>, QString&#160;<i>fileName</i>)</li><li><div class="fn" /><b><a href="qmovie.html#setFormat">setFormat</a></b> (<i>self</i>, QByteArray&#160;<i>format</i>)</li><li><div class="fn" /><b><a href="qmovie.html#setPaused">setPaused</a></b> (<i>self</i>, bool&#160;<i>paused</i>)</li><li><div class="fn" /><b><a href="qmovie.html#setScaledSize">setScaledSize</a></b> (<i>self</i>, QSize&#160;<i>size</i>)</li><li><div class="fn" /><b><a href="qmovie.html#setSpeed">setSpeed</a></b> (<i>self</i>, int&#160;<i>percentSpeed</i>)</li><li><div class="fn" />int <b><a href="qmovie.html#speed">speed</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qmovie.html#start">start</a></b> (<i>self</i>)</li><li><div class="fn" />MovieState <b><a href="qmovie.html#state">state</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qmovie.html#stop">stop</a></b> (<i>self</i>)</li></ul><h3>Static Methods</h3><ul><li><div class="fn" />list-of-QByteArray <b><a href="qmovie.html#supportedFormats">supportedFormats</a></b> ()</li></ul><h3>Qt Signals</h3><ul><li><div class="fn" />void <b><a href="qmovie.html#error">error</a></b> (QImageReader::ImageReaderError)</li><li><div class="fn" />void <b><a href="qmovie.html#finished">finished</a></b> ()</li><li><div class="fn" />void <b><a href="qmovie.html#frameChanged">frameChanged</a></b> (int)</li><li><div class="fn" />void <b><a href="qmovie.html#resized">resized</a></b> (const QSize&amp;)</li><li><div class="fn" />void <b><a href="qmovie.html#started">started</a></b> ()</li><li><div class="fn" />void <b><a href="qmovie.html#stateChanged">stateChanged</a></b> (QMovie::MovieState)</li><li><div class="fn" />void <b><a href="qmovie.html#updated">updated</a></b> (const QRect&amp;)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QMovie class is a convenience class for playing movies with
    13. 

  13. <a href="qimagereader.html">QImageReader</a>.</p>
    14. 

  14. <p>This class is used to show simple animations without sound. If
    15. 

  15. you want to display video and media content, use the <a href="phonon-module.html">Phonon</a> multimedia framework instead.</p>
    16. 

  16. <p>First, create a QMovie object by passing either the name of a
    17. 

  17. file or a pointer to a <a href="qiodevice.html">QIODevice</a>
    18. 

  18. containing an animated image format to QMovie's constructor. You
    19. 

  19. can call <a href="qmovie.html#isValid">isValid</a>() to check if
    20. 

  20. the image data is valid, before starting the movie. To start the
    21. 

  21. movie, call <a href="qmovie.html#start">start</a>(). QMovie will
    22. 

  22. enter <a href="qmovie.html#MovieState-enum">Running</a> state, and
    23. 

  23. emit <a href="qmovie.html#started">started</a>() and <a href="qmovie.html#stateChanged">stateChanged</a>(). To get the current
    24. 

  24. state of the movie, call <a href="qmovie.html#state">state</a>().</p>
    25. 

  25. <p>To display the movie in your application, you can pass your
    26. 

  26. QMovie object to <a href="qlabel.html#setMovie">QLabel.setMovie</a>(). Example:</p>
    27. 

  27. <pre class="cpp">
    28. 

  28.  <span class="type"><a href="qlabel.html">QLabel</a></span> label;
    29. 

  29.  <span class="type">QMovie</span> <span class="operator">*</span>movie <span class="operator">=</span> <span class="keyword">new</span> <span class="type">QMovie</span>(<span class="string">"animations/fire.gif"</span>);
    30. 

  30. 

  31.  label<span class="operator">.</span>setMovie(movie);
    32. 

  32.  movie<span class="operator">-</span><span class="operator">&gt;</span><a href="qmovie.html#start">start</a>();
    33. 

  33. </pre>
    34. 

  34. <p>Whenever a new frame is available in the movie, QMovie will emit
    35. 

  35. <a href="qmovie.html#updated">updated</a>(). If the size of the
    36. 

  36. frame changes, <a href="qmovie.html#resized">resized</a>() is
    37. 

  37. emitted. You can call <a href="qmovie.html#currentImage">currentImage</a>() or <a href="qmovie.html#currentPixmap">currentPixmap</a>() to get a copy of
    38. 

  38. the current frame. When the movie is done, QMovie emits <a href="qmovie.html#finished">finished</a>(). If any error occurs during
    39. 

  39. playback (i.e, the image file is corrupt), QMovie will emit
    40. 

  40. <a href="qmovie.html#error">error</a>().</p>
    41. 

  41. <p>You can control the speed of the movie playback by calling
    42. 

  42. <a href="qmovie.html#speed-prop">setSpeed</a>(), which takes the
    43. 

  43. percentage of the original speed as an argument. Pause the movie by
    44. 

  44. calling setPaused(true). QMovie will then enter <a href="qmovie.html#MovieState-enum">Paused</a> state and emit <a href="qmovie.html#stateChanged">stateChanged</a>(). If you call
    45. 

  45. setPaused(false), QMovie will reenter <a href="qmovie.html#MovieState-enum">Running</a> state and start the movie
    46. 

  46. again. To stop the movie, call <a href="qmovie.html#stop">stop</a>().</p>
    47. 

  47. <p>Certain animation formats allow you to set the background color.
    48. 

  48. You can call <a href="qmovie.html#setBackgroundColor">setBackgroundColor</a>() to set
    49. 

  49. the color, or <a href="qmovie.html#backgroundColor">backgroundColor</a>() to retrieve the
    50. 

  50. current background color.</p>
    51. 

  51. <p><a href="qmovie.html#currentFrameNumber">currentFrameNumber</a>() returns
    52. 

  52. the sequence number of the current frame. The first frame in the
    53. 

  53. animation has the sequence number 0. <a href="qmovie.html#frameCount">frameCount</a>() returns the total number
    54. 

  54. of frames in the animation, if the image format supports this. You
    55. 

  55. can call <a href="qmovie.html#loopCount">loopCount</a>() to get the
    56. 

  56. number of times the movie should loop before finishing. <a href="qmovie.html#nextFrameDelay">nextFrameDelay</a>() returns the
    57. 

  57. number of milliseconds the current frame should be displayed.</p>
    58. 

  58. <p>QMovie can be instructed to cache frames of an animation by
    59. 

  59. calling <a href="qmovie.html#cacheMode-prop">setCacheMode</a>().</p>
    60. 

  60. <p>Call <a href="qmovie.html#supportedFormats">supportedFormats</a>() for a list of
    61. 

  61. formats that QMovie supports.</p>
    62. 

  62. <hr /><h2>Type Documentation</h2><h3 class="fn"><a name="CacheMode-enum" />QMovie.CacheMode</h3><p>This enum describes the different cache modes of <a href="qmovie.html">QMovie</a>.</p>
    63. 

  63. <table class="valuelist">
    64. 

  64. <tr class="odd" valign="top">
    65. 

  65. <th class="tblConst">Constant</th>
    66. 

  66. <th class="tblval">Value</th>
    67. 

  67. <th class="tbldscr">Description</th>
    68. 

  68. </tr>
    69. 

  69. <tr>
    70. 

  70. <td class="topAlign"><tt>QMovie.CacheNone</tt></td>
    71. 

  71. <td class="topAlign"><tt>0</tt></td>
    72. 

  72. <td class="topAlign">No frames are cached (the default).</td>
    73. 

  73. </tr>
    74. 

  74. <tr>
    75. 

  75. <td class="topAlign"><tt>QMovie.CacheAll</tt></td>
    76. 

  76. <td class="topAlign"><tt>1</tt></td>
    77. 

  77. <td class="topAlign">All frames are cached.</td>
    78. 

  78. </tr>
    79. 

  79. </table>
    80. 

  80. 

  81. 

  82. <h3 class="fn"><a name="MovieState-enum" />QMovie.MovieState</h3><p>This enum describes the different states of <a href="qmovie.html">QMovie</a>.</p>
    83. 

  83. <table class="valuelist">
    84. 

  84. <tr class="odd" valign="top">
    85. 

  85. <th class="tblConst">Constant</th>
    86. 

  86. <th class="tblval">Value</th>
    87. 

  87. <th class="tbldscr">Description</th>
    88. 

  88. </tr>
    89. 

  89. <tr>
    90. 

  90. <td class="topAlign"><tt>QMovie.NotRunning</tt></td>
    91. 

  91. <td class="topAlign"><tt>0</tt></td>
    92. 

  92. <td class="topAlign">The movie is not running. This is <a href="qmovie.html">QMovie</a>'s initial state, and the state it enters
    93. 

  93. after <a href="qmovie.html#stop">stop</a>() has been called or the
    94. 

  94. movie is finished.</td>
    95. 

  95. </tr>
    96. 

  96. <tr>
    97. 

  97. <td class="topAlign"><tt>QMovie.Paused</tt></td>
    98. 

  98. <td class="topAlign"><tt>1</tt></td>
    99. 

  99. <td class="topAlign">The movie is paused, and <a href="qmovie.html">QMovie</a> stops emitting <a href="qmovie.html#updated">updated</a>() or <a href="qmovie.html#resized">resized</a>(). This state is entered after
    100. 

  100. calling <a class="compat" href="qmovie-qt3.html#pause">pause</a>()
    101. 

  101. or setPaused(true). The current frame number it kept, and the movie
    102. 

  102. will continue with the next frame when <a class="compat" href="qmovie-qt3.html#unpause">unpause</a>() or
    103. 

  103. setPaused(false) is called.</td>
    104. 

  104. </tr>
    105. 

  105. <tr>
    106. 

  106. <td class="topAlign"><tt>QMovie.Running</tt></td>
    107. 

  107. <td class="topAlign"><tt>2</tt></td>
    108. 

  108. <td class="topAlign">The movie is running.</td>
    109. 

  109. </tr>
    110. 

  110. </table>
    111. 

  111. <hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QMovie" />QMovie.__init__ (<i>self</i>, <a href="qobject.html">QObject</a>&#160;<i>parent</i>&#160;=&#160;None)</h3><p>The <i>parent</i> argument, if not None, causes <i>self</i> to be owned by Qt instead of PyQt.</p><p>Constructs a <a href="qmovie.html">QMovie</a> object, passing
    112. 

  112. the <i>parent</i> object to <a href="qobject.html">QObject</a>'s
    113. 

  113. constructor.</p>
    114. 

  114. <p><b>See also</b> <a href="qmovie.html#setFileName">setFileName</a>(), <a href="qmovie.html#setDevice">setDevice</a>(), and <a href="qmovie.html#setFormat">setFormat</a>().</p>
    115. 

  115. 

  116. 

  117. <h3 class="fn"><a name="QMovie-2" />QMovie.__init__ (<i>self</i>, <a href="qiodevice.html">QIODevice</a>&#160;<i>device</i>, <a href="qbytearray.html">QByteArray</a>&#160;<i>format</i>&#160;=&#160;QByteArray(), <a href="qobject.html">QObject</a>&#160;<i>parent</i>&#160;=&#160;None)</h3><p>The <i>parent</i> argument, if not None, causes <i>self</i> to be owned by Qt instead of PyQt.</p><p>Constructs a <a href="qmovie.html">QMovie</a> object. <a href="qmovie.html">QMovie</a> will use read image data from
    118. 

  118. <i>device</i>, which it assumes is open and readable. If
    119. 

  119. <i>format</i> is not empty, <a href="qmovie.html">QMovie</a> will
    120. 

  120. use the image format <i>format</i> for decoding the image data.
    121. 

  121. Otherwise, <a href="qmovie.html">QMovie</a> will attempt to guess
    122. 

  122. the format.</p>
    123. 

  123. <p>The <i>parent</i> object is passed to <a href="qobject.html">QObject</a>'s constructor.</p>
    124. 

    125. 

  125. 

  126. <h3 class="fn"><a name="QMovie-3" />QMovie.__init__ (<i>self</i>, QString&#160;<i>fileName</i>, <a href="qbytearray.html">QByteArray</a>&#160;<i>format</i>&#160;=&#160;QByteArray(), <a href="qobject.html">QObject</a>&#160;<i>parent</i>&#160;=&#160;None)</h3><p>The <i>parent</i> argument, if not None, causes <i>self</i> to be owned by Qt instead of PyQt.</p><p>Constructs a <a href="qmovie.html">QMovie</a> object. <a href="qmovie.html">QMovie</a> will use read image data from
    127. 

  127. <i>fileName</i>. If <i>format</i> is not empty, <a href="qmovie.html">QMovie</a> will use the image format <i>format</i>
    128. 

  128. for decoding the image data. Otherwise, <a href="qmovie.html">QMovie</a> will attempt to guess the format.</p>
    129. 

  129. <p>The <i>parent</i> object is passed to <a href="qobject.html">QObject</a>'s constructor.</p>
    130. 

    131. 

  131. 

  132. <h3 class="fn"><a name="backgroundColor" /><a href="qcolor.html">QColor</a> QMovie.backgroundColor (<i>self</i>)</h3><p>Returns the background color of the movie. If no background
    133. 

  133. color has been assigned, an invalid <a href="qcolor.html">QColor</a> is returned.</p>
    134. 

  134. <p><b>See also</b> <a href="qmovie.html#setBackgroundColor">setBackgroundColor</a>().</p>
    135. 

  135. 

  136. 

  137. <h3 class="fn"><a name="cacheMode" /><a href="qmovie.html#CacheMode-enum">CacheMode</a> QMovie.cacheMode (<i>self</i>)</h3><h3 class="fn"><a name="currentFrameNumber" />int QMovie.currentFrameNumber (<i>self</i>)</h3><p>Returns the sequence number of the current frame. The number of
    138. 

  138. the first frame in the movie is 0.</p>
    139. 

  139. 

  140. 

  141. <h3 class="fn"><a name="currentImage" /><a href="qimage.html">QImage</a> QMovie.currentImage (<i>self</i>)</h3><p>Returns the current frame as a <a href="qimage.html">QImage</a>.</p>
    142. 

  142. <p><b>See also</b> <a href="qmovie.html#currentPixmap">currentPixmap</a>() and <a href="qmovie.html#updated">updated</a>().</p>
    143. 

  143. 

  144. 

  145. <h3 class="fn"><a name="currentPixmap" /><a href="qpixmap.html">QPixmap</a> QMovie.currentPixmap (<i>self</i>)</h3><p>Returns the current frame as a <a href="qpixmap.html">QPixmap</a>.</p>
    146. 

  146. <p><b>See also</b> <a href="qmovie.html#currentImage">currentImage</a>() and <a href="qmovie.html#updated">updated</a>().</p>
    147. 

  147. 

  148. 

  149. <h3 class="fn"><a name="device" /><a href="qiodevice.html">QIODevice</a> QMovie.device (<i>self</i>)</h3><p>Returns the device <a href="qmovie.html">QMovie</a> reads image
    150. 

  150. data from. If no device has currently been assigned, 0 is
    151. 

  151. returned.</p>
    152. 

  152. <p><b>See also</b> <a href="qmovie.html#setDevice">setDevice</a>()
    153. 

  153. and <a href="qmovie.html#fileName">fileName</a>().</p>
    154. 

  154. 

  155. 

  156. <h3 class="fn"><a name="fileName" />QString QMovie.fileName (<i>self</i>)</h3><p>Returns the name of the file that <a href="qmovie.html">QMovie</a> reads image data from. If no file name has
    157. 

  157. been assigned, or if the assigned device is not a file, an empty
    158. 

  158. <a href="qstring.html">QString</a> is returned.</p>
    159. 

  159. <p><b>See also</b> <a href="qmovie.html#setFileName">setFileName</a>() and <a href="qmovie.html#device">device</a>().</p>
    160. 

  160. 

  161. 

  162. <h3 class="fn"><a name="format" /><a href="qbytearray.html">QByteArray</a> QMovie.format (<i>self</i>)</h3><p>Returns the format that <a href="qmovie.html">QMovie</a> uses
    163. 

  163. when decoding image data. If no format has been assigned, an empty
    164. 

  164. QByteArray() is returned.</p>
    165. 

  165. <p><b>See also</b> <a href="qmovie.html#setFormat">setFormat</a>().</p>
    166. 

  166. 

  167. 

  168. <h3 class="fn"><a name="frameCount" />int QMovie.frameCount (<i>self</i>)</h3><p>Returns the number of frames in the movie.</p>
    169. 

  169. <p>Certain animation formats do not support this feature, in which
    170. 

  170. case 0 is returned.</p>
    171. 

  171. 

  172. 

  173. <h3 class="fn"><a name="frameRect" /><a href="qrect.html">QRect</a> QMovie.frameRect (<i>self</i>)</h3><p>Returns the rect of the last frame. If no frame has yet been
    174. 

  174. updated, an invalid <a href="qrect.html">QRect</a> is returned.</p>
    175. 

  175. <p><b>See also</b> <a href="qmovie.html#currentImage">currentImage</a>() and <a href="qmovie.html#currentPixmap">currentPixmap</a>().</p>
    176. 

  176. 

  177. 

  178. <h3 class="fn"><a name="isValid" />bool QMovie.isValid (<i>self</i>)</h3><p>Returns true if the movie is valid (e.g., the image data is
    179. 

  179. readable and the image format is supported); otherwise returns
    180. 

  180. false.</p>
    181. 

  181. 

  182. 

  183. <h3 class="fn"><a name="jumpToFrame" />bool QMovie.jumpToFrame (<i>self</i>, int&#160;<i>frameNumber</i>)</h3><p>Jumps to frame number <i>frameNumber</i>. Returns true on
    184. 

  184. success; otherwise returns false.</p>
    185. 

  185. 

  186. 

  187. <h3 class="fn"><a name="jumpToNextFrame" />bool QMovie.jumpToNextFrame (<i>self</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>bool jumpToNextFrame()</tt>.</p><p>Jumps to the next frame. Returns true on success; otherwise
    188. 

  188. returns false.</p>
    189. 

  189. 

  190. 

  191. <h3 class="fn"><a name="loopCount" />int QMovie.loopCount (<i>self</i>)</h3><p>Returns the number of times the movie will loop before it
    192. 

  192. finishes. If the movie will only play once (no looping), loopCount
    193. 

  193. returns 0. If the movie loops forever, loopCount returns -1.</p>
    194. 

  194. <p>Note that, if the image data comes from a sequential device
    195. 

  195. (e.g. a socket), <a href="qmovie.html">QMovie</a> can only loop the
    196. 

  196. movie if the <a href="qmovie.html#cacheMode-prop">cacheMode</a> is
    197. 

  197. set to <a href="qmovie.html#CacheMode-enum">QMovie.CacheAll</a>.</p>
    198. 

  198. 

  199. 

  200. <h3 class="fn"><a name="nextFrameDelay" />int QMovie.nextFrameDelay (<i>self</i>)</h3><p>Returns the number of milliseconds <a href="qmovie.html">QMovie</a> will wait before updating the next frame
    201. 

  201. in the animation.</p>
    202. 

  202. 

  203. 

  204. <h3 class="fn"><a name="scaledSize" /><a href="qsize.html">QSize</a> QMovie.scaledSize (<i>self</i>)</h3><p>Returns the scaled size of frames.</p>
    205. 

  205. <p>This function was introduced in Qt 4.1.</p>
    206. 

  206. <p><b>See also</b> <a href="qmovie.html#setScaledSize">setScaledSize</a>() and <a href="qimagereader.html#scaledSize">QImageReader.scaledSize</a>().</p>
    207. 

  207. 

  208. 

  209. <h3 class="fn"><a name="setBackgroundColor" />QMovie.setBackgroundColor (<i>self</i>, <a href="qcolor.html">QColor</a>&#160;<i>color</i>)</h3><p>For image formats that support it, this function sets the
    210. 

  210. background color to <i>color</i>.</p>
    211. 

  211. <p><b>See also</b> <a href="qmovie.html#backgroundColor">backgroundColor</a>().</p>
    212. 

  212. 

  213. 

  214. <h3 class="fn"><a name="setCacheMode" />QMovie.setCacheMode (<i>self</i>, <a href="qmovie.html#CacheMode-enum">CacheMode</a>&#160;<i>mode</i>)</h3><h3 class="fn"><a name="setDevice" />QMovie.setDevice (<i>self</i>, <a href="qiodevice.html">QIODevice</a>&#160;<i>device</i>)</h3><p>Sets the current device to <i>device</i>. <a href="qmovie.html">QMovie</a> will read image data from this device when
    215. 

  215. the movie is running.</p>
    216. 

  216. <p><b>See also</b> <a href="qmovie.html#device">device</a>() and
    217. 

  217. <a href="qmovie.html#setFormat">setFormat</a>().</p>
    218. 

  218. 

  219. 

  220. <h3 class="fn"><a name="setFileName" />QMovie.setFileName (<i>self</i>, QString&#160;<i>fileName</i>)</h3><p>Sets the name of the file that <a href="qmovie.html">QMovie</a>
    221. 

  221. reads image data from, to <i>fileName</i>.</p>
    222. 

  222. <p><b>See also</b> <a href="qmovie.html#fileName">fileName</a>(),
    223. 

  223. <a href="qmovie.html#setDevice">setDevice</a>(), and <a href="qmovie.html#setFormat">setFormat</a>().</p>
    224. 

  224. 

  225. 

  226. <h3 class="fn"><a name="setFormat" />QMovie.setFormat (<i>self</i>, <a href="qbytearray.html">QByteArray</a>&#160;<i>format</i>)</h3><p>Sets the format that <a href="qmovie.html">QMovie</a> will use
    227. 

  227. when decoding image data, to <i>format</i>. By default, <a href="qmovie.html">QMovie</a> will attempt to guess the format of the
    228. 

  228. image data.</p>
    229. 

  229. <p>You can call <a href="qmovie.html#supportedFormats">supportedFormats</a>() for the full
    230. 

  230. list of formats <a href="qmovie.html">QMovie</a> supports.</p>
    231. 

  231. <p><b>See also</b> <a href="qmovie.html#format">format</a>() and
    232. 

  232. <a href="qimagereader.html#supportedImageFormats">QImageReader.supportedImageFormats</a>().</p>
    233. 

  233. 

  234. 

  235. <h3 class="fn"><a name="setPaused" />QMovie.setPaused (<i>self</i>, bool&#160;<i>paused</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void setPaused(bool)</tt>.</p><p>If <i>paused</i> is true, <a href="qmovie.html">QMovie</a> will
    236. 

  236. enter <a href="qmovie.html#MovieState-enum">Paused</a> state and
    237. 

  237. emit stateChanged(Paused); otherwise it will enter <a href="qmovie.html#MovieState-enum">Running</a> state and emit
    238. 

  238. stateChanged(Running).</p>
    239. 

  239. <p><b>See also</b> <a class="compat" href="qmovie-qt3.html#paused">paused</a>() and <a href="qmovie.html#state">state</a>().</p>
    240. 

  240. 

  241. 

  242. <h3 class="fn"><a name="setScaledSize" />QMovie.setScaledSize (<i>self</i>, <a href="qsize.html">QSize</a>&#160;<i>size</i>)</h3><p>Sets the scaled frame size to <i>size</i>.</p>
    243. 

  243. <p>This function was introduced in Qt 4.1.</p>
    244. 

  244. <p><b>See also</b> <a href="qmovie.html#scaledSize">scaledSize</a>() and <a href="qimagereader.html#setScaledSize">QImageReader.setScaledSize</a>().</p>
    245. 

  245. 

  246. 

  247. <h3 class="fn"><a name="setSpeed" />QMovie.setSpeed (<i>self</i>, int&#160;<i>percentSpeed</i>)</h3><h3 class="fn"><a name="speed" />int QMovie.speed (<i>self</i>)</h3><h3 class="fn"><a name="start" />QMovie.start (<i>self</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void start()</tt>.</p><p>Starts the movie. <a href="qmovie.html">QMovie</a> will enter
    248. 

  248. <a href="qmovie.html#MovieState-enum">Running</a> state, and start
    249. 

  249. emitting <a href="qmovie.html#updated">updated</a>() and <a href="qmovie.html#resized">resized</a>() as the movie progresses.</p>
    250. 

  250. <p>If <a href="qmovie.html">QMovie</a> is in the <a href="qmovie.html#MovieState-enum">Paused</a> state, this function is
    251. 

  251. equivalent to calling setPaused(false). If <a href="qmovie.html">QMovie</a> is already in the <a href="qmovie.html#MovieState-enum">Running</a> state, this function does
    252. 

  252. nothing.</p>
    253. 

  253. <p><b>See also</b> <a href="qmovie.html#stop">stop</a>() and
    254. 

  254. <a href="qmovie.html#setPaused">setPaused</a>().</p>
    255. 

  255. 

  256. 

  257. <h3 class="fn"><a name="state" /><a href="qmovie.html#MovieState-enum">MovieState</a> QMovie.state (<i>self</i>)</h3><p>Returns the current state of <a href="qmovie.html">QMovie</a>.</p>
    258. 

  258. <p><b>See also</b> <a href="qmovie.html#MovieState-enum">MovieState</a> and <a href="qmovie.html#stateChanged">stateChanged</a>().</p>
    259. 

  259. 

  260. 

  261. <h3 class="fn"><a name="stop" />QMovie.stop (<i>self</i>)</h3><p>This method is also a Qt slot with the C++ signature <tt>void stop()</tt>.</p><p>Stops the movie. <a href="qmovie.html">QMovie</a> enters
    262. 

  262. <a href="qmovie.html#MovieState-enum">NotRunning</a> state, and
    263. 

  263. stops emitting <a href="qmovie.html#updated">updated</a>() and
    264. 

  264. <a href="qmovie.html#resized">resized</a>(). If <a href="qmovie.html#start">start</a>() is called again, the movie will
    265. 

  265. restart from the beginning.</p>
    266. 

  266. <p>If <a href="qmovie.html">QMovie</a> is already in the <a href="qmovie.html#MovieState-enum">NotRunning</a> state, this function
    267. 

  267. does nothing.</p>
    268. 

  268. <p><b>See also</b> <a href="qmovie.html#start">start</a>() and
    269. 

  269. <a href="qmovie.html#setPaused">setPaused</a>().</p>
    270. 

  270. 

  271. 

  272. <h3 class="fn"><a name="supportedFormats" />list-of-QByteArray QMovie.supportedFormats ()</h3><p>Returns the list of image formats supported by <a href="qmovie.html">QMovie</a>.</p>
    273. 

  273. <p>This function was introduced in Qt 4.1.</p>
    274. 

  274. <p><b>See also</b> <a href="qimagereader.html#supportedImageFormats">QImageReader.supportedImageFormats</a>().</p>
    275. 

  275. 

  276. 

  277. <hr /><h2>Qt Signal Documentation</h2><h3 class="fn"><a name="error" />void error (QImageReader::ImageReaderError)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted by <a href="qmovie.html">QMovie</a> when
    278. 

  278. the error <i>error</i> occurred during playback. <a href="qmovie.html">QMovie</a> will stop the movie, and enter <a href="qmovie.html#MovieState-enum">QMovie.NotRunning</a> state.</p>
    279. 

  279. 

  280. 

  281. <h3 class="fn"><a name="finished" />void finished ()</h3><p>This is the default overload of this signal.</p><p>This signal is emitted when the movie has finished.</p>
    282. 

  282. <p><b>See also</b> <a href="qmovie.html#stop">QMovie.stop</a>().</p>
    283. 

  283. 

  284. 

  285. <h3 class="fn"><a name="frameChanged" />void frameChanged (int)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted when the frame number has changed to
    286. 

  286. <i>frameNumber</i>. You can call <a href="qmovie.html#currentImage">currentImage</a>() or <a href="qmovie.html#currentPixmap">currentPixmap</a>() to get a copy of
    287. 

  287. the frame.</p>
    288. 

  288. <p>This function was introduced in Qt 4.1.</p>
    289. 

  289. 

  290. 

  291. <h3 class="fn"><a name="resized" />void resized (const QSize&amp;)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted when the current frame has been resized
    292. 

  292. to <i>size</i>. This effect is sometimes used in animations as an
    293. 

  293. alternative to replacing the frame. You can call <a href="qmovie.html#currentImage">currentImage</a>() or <a href="qmovie.html#currentPixmap">currentPixmap</a>() to get a copy of
    294. 

  294. the updated frame.</p>
    295. 

  295. 

  296. 

  297. <h3 class="fn"><a name="started" />void started ()</h3><p>This is the default overload of this signal.</p><p>This signal is emitted after <a href="qmovie.html#start">QMovie.start</a>() has been called, and
    298. 

  298. <a href="qmovie.html">QMovie</a> has entered <a href="qmovie.html#MovieState-enum">QMovie.Running</a> state.</p>
    299. 

  299. 

  300. 

  301. <h3 class="fn"><a name="stateChanged" />void stateChanged (QMovie::MovieState)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted every time the state of the movie
    302. 

  302. changes. The new state is specified by <i>state</i>.</p>
    303. 

  303. <p><b>See also</b> <a href="qmovie.html#state">QMovie.state</a>().</p>
    304. 

  304. 

  305. 

  306. <h3 class="fn"><a name="updated" />void updated (const QRect&amp;)</h3><p>This is the default overload of this signal.</p><p>This signal is emitted when the rect <i>rect</i> in the current
    307. 

  307. frame has been updated. You can call <a href="qmovie.html#currentImage">currentImage</a>() or <a href="qmovie.html#currentPixmap">currentPixmap</a>() to get a copy of
    308. 

  308. the updated frame.</p>
    309. 

  309. <address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt&#160;4.9.4 for X11</td><td align="center" width="50%">Copyright &#169; <a href="http://www.riverbankcomputing.com">Riverbank&#160;Computing&#160;Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2012</td><td align="right" width="25%">Qt&#160;4.8.2</td></tr></table></div></address></body></html>
    310.