summaryrefslogtreecommitdiffstats
path: root/doc/html/qimageconsumer.html
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-08 12:31:36 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-08 12:31:36 -0600
commitd796c9dd933ab96ec83b9a634feedd5d32e1ba3f (patch)
tree6e3dcca4f77e20ec8966c666aac7c35bd4704053 /doc/html/qimageconsumer.html
downloadtqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.tar.gz
tqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.zip
Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731
Diffstat (limited to 'doc/html/qimageconsumer.html')
-rw-r--r--doc/html/qimageconsumer.html142
1 files changed, 142 insertions, 0 deletions
diff --git a/doc/html/qimageconsumer.html b/doc/html/qimageconsumer.html
new file mode 100644
index 000000000..4d06fb950
--- /dev/null
+++ b/doc/html/qimageconsumer.html
@@ -0,0 +1,142 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qasyncimageio.cpp:51 -->
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>TQImageConsumer Class</title>
+<style type="text/css"><!--
+fn { margin-left: 1cm; text-indent: -1cm; }
+a:link { color: #004faf; text-decoration: none }
+a:visited { color: #672967; text-decoration: none }
+body { background: #ffffff; color: black; }
+--></style>
+</head>
+<body>
+
+<table border="0" cellpadding="0" cellspacing="0" width="100%">
+<tr bgcolor="#E5E5E5">
+<td valign=center>
+ <a href="index.html">
+<font color="#004faf">Home</font></a>
+ | <a href="classes.html">
+<font color="#004faf">All&nbsp;Classes</font></a>
+ | <a href="mainclasses.html">
+<font color="#004faf">Main&nbsp;Classes</font></a>
+ | <a href="annotated.html">
+<font color="#004faf">Annotated</font></a>
+ | <a href="groups.html">
+<font color="#004faf">Grouped&nbsp;Classes</font></a>
+ | <a href="functions.html">
+<font color="#004faf">Functions</font></a>
+</td>
+<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQImageConsumer Class Reference</h1>
+
+<p>The TQImageConsumer class is an abstraction used by TQImageDecoder.
+<a href="#details">More...</a>
+<p><tt>#include &lt;<a href="qasyncimageio-h.html">qasyncimageio.h</a>&gt;</tt>
+<p><a href="qimageconsumer-members.html">List of all member functions.</a>
+<h2>Public Members</h2>
+<ul>
+<li class=fn>virtual void <a href="#end"><b>end</b></a> () = 0</li>
+<li class=fn>virtual void <a href="#changed"><b>changed</b></a> ( const TQRect &amp; ) = 0</li>
+<li class=fn>virtual void <a href="#frameDone"><b>frameDone</b></a> () = 0</li>
+<li class=fn>virtual void <a href="#frameDone-2"><b>frameDone</b></a> ( const&nbsp;TQPoint&nbsp;&amp;&nbsp;offset, const&nbsp;TQRect&nbsp;&amp;&nbsp;rect ) = 0</li>
+<li class=fn>virtual void <a href="#setLooping"><b>setLooping</b></a> ( int&nbsp;n ) = 0</li>
+<li class=fn>virtual void <a href="#setFramePeriod"><b>setFramePeriod</b></a> ( int&nbsp;milliseconds ) = 0</li>
+<li class=fn>virtual void <a href="#setSize"><b>setSize</b></a> ( int, int ) = 0</li>
+</ul>
+<hr><a name="details"></a><h2>Detailed Description</h2>
+
+
+The TQImageConsumer class is an abstraction used by <a href="qimagedecoder.html">TQImageDecoder</a>.
+<p>
+
+
+<p> The <a href="qmovie.html">TQMovie</a> class, or <a href="qlabel.html#setMovie">TQLabel::setMovie</a>(), are easy to use and for
+most situations do what you want with regards animated images.
+<p> A TQImageConsumer consumes information about changes to the <a href="qimage.html">TQImage</a>
+maintained by a TQImageDecoder. Think of the TQImage as the model or
+source of the image data, with the TQImageConsumer as a view of
+that data and the TQImageDecoder being the controller that
+orchestrates the relationship between the model and the view.
+<p> You'd use the TQImageConsumer class, for example, if you were
+implementing a web browser with your own image loaders.
+<p> <p>See also <a href="qimagedecoder.html">TQImageDecoder</a>, <a href="graphics.html">Graphics Classes</a>, <a href="images.html">Image Processing Classes</a>, and <a href="multimedia.html">Multimedia Classes</a>.
+
+<hr><h2>Member Function Documentation</h2>
+<h3 class=fn>void <a name="changed"></a>TQImageConsumer::changed ( const&nbsp;<a href="qrect.html">TQRect</a>&nbsp;&amp; )<tt> [pure virtual]</tt>
+</h3>
+
+<p> Called when the given area of the image has changed.
+
+<h3 class=fn>void <a name="end"></a>TQImageConsumer::end ()<tt> [pure virtual]</tt>
+</h3>
+
+<p> Called when all the data from all the frames has been decoded and
+revealed as <a href="#changed">changed</a>().
+
+<h3 class=fn>void <a name="frameDone"></a>TQImageConsumer::frameDone ()<tt> [pure virtual]</tt>
+</h3>
+
+<p> One of the two <a href="#frameDone">frameDone</a>() functions will be called when a frame
+of an animated image has ended and been revealed as <a href="#changed">changed</a>().
+<p> When this function is called, the current image should be
+displayed.
+<p> The decoder will not make any further changes to the image until
+the next call to <a href="qimageformat.html#decode">TQImageFormat::decode</a>().
+
+<h3 class=fn>void <a name="frameDone-2"></a>TQImageConsumer::frameDone ( const&nbsp;<a href="qpoint.html">TQPoint</a>&nbsp;&amp;&nbsp;offset, const&nbsp;<a href="qrect.html">TQRect</a>&nbsp;&amp;&nbsp;rect )<tt> [pure virtual]</tt>
+</h3>
+This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
+<p> One of the two <a href="#frameDone">frameDone</a>() functions will be called when a frame
+of an animated image has ended and been revealed as <a href="#changed">changed</a>().
+<p> When this function is called, the area <em>rect</em> in the current
+image should be moved by <em>offset</em> and displayed.
+<p> The decoder will not make any further changes to the image until
+the next call to <a href="qimageformat.html#decode">TQImageFormat::decode</a>().
+
+<h3 class=fn>void <a name="setFramePeriod"></a>TQImageConsumer::setFramePeriod ( int&nbsp;milliseconds )<tt> [pure virtual]</tt>
+</h3>
+
+<p> Notes that the frame about to be decoded should not be displayed
+until the given number of <em>milliseconds</em> after the time that this
+function is called. Of course, the image may not have been
+decoded by then, in which case the frame should not be displayed
+until it is complete. A value of -1 (the assumed default)
+indicates that the image should be displayed even while it is only
+partially loaded.
+
+<h3 class=fn>void <a name="setLooping"></a>TQImageConsumer::setLooping ( int&nbsp;n )<tt> [pure virtual]</tt>
+</h3>
+
+<p> Called to indicate that the sequence of frames in the image
+should be repeated <em>n</em> times, including the sequence during
+decoding.
+<p> <ul>
+<li> 0 = Forever
+<li> 1 = Only display frames the first time through
+<li> 2 = Repeat once after first pass through images
+<li> etc.
+</ul>
+<p> To make the <a href="qimagedecoder.html">TQImageDecoder</a> do this, just delete it and pass the
+information to it again for decoding (<a href="#setLooping">setLooping</a>() will be called
+again, of course, but that can be ignored), or keep copies of the
+changed areas at the ends of frames.
+
+<h3 class=fn>void <a name="setSize"></a>TQImageConsumer::setSize ( int, int )<tt> [pure virtual]</tt>
+</h3>
+
+<p> This function is called as soon as the size of the image has been
+determined.
+
+<!-- eof -->
+<hr><p>
+This file is part of the <a href="index.html">TQt toolkit</a>.
+Copyright &copy; 1995-2007
+<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
+<table width=100% cellspacing=0 border=0><tr>
+<td>Copyright &copy; 2007
+<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
+<td align=right><div align=right>TQt 3.3.8</div>
+</table></div></address></body>
+</html>