<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /builddir/build/BUILD/libqxt/src/gui/qxtflowview.cpp -->
<head>
<title>QxtFlowView Class Reference</title>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://libqxt.org"><img src="images/qxt-logo.png" width="50" height="40" align="left" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="classes.html"><font color="#004faf">Classes</font></a> · <a href="namespaces.html"><font color="#004faf">Namespaces</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QxtFlowView Class Reference<br /><span class="small-subtitle">[<a href="qxtgui.html">QxtGui</a> module]</span>
</h1>
<p>The QxtFlowView widget is an item view for images with impressive flow effects <a href="#details">More...</a></p>
<pre> #include <QxtFlowView></pre><p>Inherits <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a>.</p>
<ul>
<li><a href="qxtflowview-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h3>Public Types</h3>
<ul>
<li><div class="fn"></div>enum <b><a href="qxtflowview.html#ReflectionEffect-enum">ReflectionEffect</a></b> { NoReflection, PlainReflection, BlurredReflection }</li>
</ul>
<a name="properties"></a>
<h3>Properties</h3>
<p><table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr><td width="45%" valign="top"><ul>
<li><div class="fn"></div><b><a href="qxtflowview.html#backgroundColor-prop">backgroundColor</a></b> : QColor</li>
<li><div class="fn"></div><b><a href="qxtflowview.html#currentIndex-prop">currentIndex</a></b> : QModelIndex</li>
<li><div class="fn"></div><b><a href="qxtflowview.html#pictureColumn-prop">pictureColumn</a></b> : int</li>
<li><div class="fn"></div><b><a href="qxtflowview.html#pictureRole-prop">pictureRole</a></b> : int</li>
</ul></td><td valign="top"><ul>
<li><div class="fn"></div><b><a href="qxtflowview.html#reflectionEffect-prop">reflectionEffect</a></b> : ReflectionEffect</li>
<li><div class="fn"></div><b><a href="qxtflowview.html#rootIndex-prop">rootIndex</a></b> : QModelIndex</li>
<li><div class="fn"></div><b><a href="qxtflowview.html#slideSize-prop">slideSize</a></b> : QSize</li>
</ul>
</td></tr>
</table></p>
<ul>
<li><div class="fn"></div>57 properties inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#properties">QWidget</a></li>
<li><div class="fn"></div>1 property inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"></div><b><a href="qxtflowview.html#QxtFlowView">QxtFlowView</a></b> ( QWidget * <i>parent</i> = 0 )</li>
<li><div class="fn"></div><b><a href="qxtflowview.html#dtor.QxtFlowView">~QxtFlowView</a></b> ()</li>
<li><div class="fn"></div>QColor <b><a href="qxtflowview.html#backgroundColor-prop">backgroundColor</a></b> () const</li>
<li><div class="fn"></div>QModelIndex <b><a href="qxtflowview.html#currentIndex-prop">currentIndex</a></b> () const</li>
<li><div class="fn"></div>QAbstractItemModel * <b><a href="qxtflowview.html#model">model</a></b> ()</li>
<li><div class="fn"></div>int <b><a href="qxtflowview.html#pictureColumn-prop">pictureColumn</a></b> ()</li>
<li><div class="fn"></div>int <b><a href="qxtflowview.html#pictureRole-prop">pictureRole</a></b> ()</li>
<li><div class="fn"></div>ReflectionEffect <b><a href="qxtflowview.html#reflectionEffect-prop">reflectionEffect</a></b> () const</li>
<li><div class="fn"></div>QModelIndex <b><a href="qxtflowview.html#rootIndex-prop">rootIndex</a></b> () const</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#backgroundColor-prop">setBackgroundColor</a></b> ( const QColor & <i>c</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#setModel">setModel</a></b> ( QAbstractItemModel * <i>model</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#pictureColumn-prop">setPictureColumn</a></b> ( int )</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#pictureRole-prop">setPictureRole</a></b> ( int )</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#reflectionEffect-prop">setReflectionEffect</a></b> ( ReflectionEffect <i>effect</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#rootIndex-prop">setRootIndex</a></b> ( QModelIndex <i>index</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#slideSize-prop">setSlideSize</a></b> ( QSize <i>size</i> )</li>
<li><div class="fn"></div>QSize <b><a href="qxtflowview.html#slideSize-prop">slideSize</a></b> () const</li>
</ul>
<ul>
<li><div class="fn"></div>207 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#public-functions">QWidget</a></li>
<li><div class="fn"></div>12 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qpaintdevice.html#public-functions">QPaintDevice</a></li>
<li><div class="fn"></div>29 public functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h3>Public Slots</h3>
<ul>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#render">render</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#currentIndex-prop">setCurrentIndex</a></b> ( QModelIndex <i>index</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#showNext">showNext</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#showPrevious">showPrevious</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#showSlide">showSlide</a></b> ( QModelIndex <i>index</i> )</li>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#triggerRender">triggerRender</a></b> ()</li>
</ul>
<ul>
<li><div class="fn"></div>19 public slots inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#public-slots">QWidget</a></li>
<li><div class="fn"></div>1 public slot inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h3>Signals</h3>
<ul>
<li><div class="fn"></div>void <b><a href="qxtflowview.html#currentIndexChanged">currentIndexChanged</a></b> ( QModelIndex <i>index</i> )</li>
</ul>
<ul>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#signals">QWidget</a></li>
<li><div class="fn"></div>1 signal inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>1 public type inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#static-public-members">QWidget</a></li>
<li><div class="fn"></div>1 static public member inherited from <a href="http://doc.qtsoftware.com/4.5/qpaintdevice.html#static-public-members">QPaintDevice</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"></div>37 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#protected-functions">QWidget</a></li>
<li><div class="fn"></div>1 protected function inherited from <a href="http://doc.qtsoftware.com/4.5/qpaintdevice.html#protected-functions">QPaintDevice</a></li>
<li><div class="fn"></div>7 protected functions inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-functions">QObject</a></li>
<li><div class="fn"></div>1 protected slot inherited from <a href="http://doc.qtsoftware.com/4.5/qwidget.html#protected-slots">QWidget</a></li>
<li><div class="fn"></div>1 protected type inherited from <a href="http://doc.qtsoftware.com/4.5/qpaintdevice.html#protected-variables">QPaintDevice</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://doc.qtsoftware.com/4.5/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QxtFlowView widget is an item view for images with impressive flow effects</p>
<p>A widget for showin images with animation effects, like Apple's Cover Flow (in iTunes and iPod). Images are arranged in form of slides, one main slide is shown at the center with few slides on the left and right sides of the center slide. When the next or previous slide is brought to the front, the whole slides flow to the left or to the right with smooth animation effect; until the new slide is finally placed at the center.</p>
<p align="center"><img src="images/qxtflowview.png" alt=""QxtFlowView in action."" /></p><p>This is a derived work of <a href="http://pictureflow.googlecode.com">PictureFlow</a></p>
<hr />
<h2>Member Type Documentation</h2>
<h3 class="fn"><a name="ReflectionEffect-enum"></a>enum QxtFlowView::ReflectionEffect</h3>
<p>This enum describes available reflection effects.</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QxtFlowView::NoReflection</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">No reflection</td></tr>
<tr><td valign="top"><tt>QxtFlowView::PlainReflection</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">Plain reflection</td></tr>
<tr><td valign="top"><tt>QxtFlowView::BlurredReflection</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">Blurred reflection</td></tr>
</table></p>
<hr />
<h2>Property Documentation</h2>
<h3 class="fn"><a name="backgroundColor-prop"></a>backgroundColor : <a href="http://doc.qtsoftware.com/4.5/qcolor.html">QColor</a></h3>
<p>This property holds the background color.</p>
<p>The default value is black.</p>
<p>Access functions:</p>
<ul>
<li><div class="fn"></div><b>QColor backgroundColor () const</b></li>
<li><div class="fn"></div><b>void setBackgroundColor ( const QColor & <i>c</i> )</b></li>
</ul>
<h3 class="fn"><a name="currentIndex-prop"></a>currentIndex : <a href="http://doc.qtsoftware.com/4.5/qmodelindex.html">QModelIndex</a></h3>
<p>This property holds the current index.</p>
<p>The slide of the current index is shown in the middle of the viewport.</p>
<p><b>Note:</b> No animation effect will be produced.</p>
<p>Access functions:</p>
<ul>
<li><div class="fn"></div><b>QModelIndex currentIndex () const</b></li>
<li><div class="fn"></div><b>void setCurrentIndex ( QModelIndex <i>index</i> )</b></li>
</ul>
<p>See also <a href="qxtflowview.html#showSlide">showSlide</a>().</p>
<h3 class="fn"><a name="pictureColumn-prop"></a>pictureColumn : int</h3>
<p>This property holds the picture column.</p>
<p>The default value is <tt>0</tt>.</p>
<p>Access functions:</p>
<ul>
<li><div class="fn"></div><b>int pictureColumn ()</b></li>
<li><div class="fn"></div><b>void setPictureColumn ( int )</b></li>
</ul>
<h3 class="fn"><a name="pictureRole-prop"></a>pictureRole : int</h3>
<p>This property holds the picture role.</p>
<p>The default value is <a href="http://doc.qtsoftware.com/4.5/qt.html#ItemDataRole-enum">Qt::DecorationRole</a>.</p>
<p>Access functions:</p>
<ul>
<li><div class="fn"></div><b>int pictureRole ()</b></li>
<li><div class="fn"></div><b>void setPictureRole ( int )</b></li>
</ul>
<h3 class="fn"><a name="reflectionEffect-prop"></a>reflectionEffect : <a href="qxtflowview.html#ReflectionEffect-enum">ReflectionEffect</a></h3>
<p>This property holds the reflection effect.</p>
<p>The default value is <a href="qxtflowview.html#ReflectionEffect-enum">PlainReflection</a>.</p>
<p>Access functions:</p>
<ul>
<li><div class="fn"></div><b>ReflectionEffect reflectionEffect () const</b></li>
<li><div class="fn"></div><b>void setReflectionEffect ( ReflectionEffect <i>effect</i> )</b></li>
</ul>
<h3 class="fn"><a name="rootIndex-prop"></a>rootIndex : <a href="http://doc.qtsoftware.com/4.5/qmodelindex.html">QModelIndex</a></h3>
<p>This property holds the root index.</p>
<p>The root index is the parent index to the view's toplevel items. The root can be invalid.</p>
<p>Access functions:</p>
<ul>
<li><div class="fn"></div><b>QModelIndex rootIndex () const</b></li>
<li><div class="fn"></div><b>void setRootIndex ( QModelIndex <i>index</i> )</b></li>
</ul>
<h3 class="fn"><a name="slideSize-prop"></a>slideSize : <a href="http://doc.qtsoftware.com/4.5/qsize.html">QSize</a></h3>
<p>This property holds the slide size.</p>
<p>The slide dimensions are in pixels.</p>
<p>The default value is 150x200.</p>
<p>Access functions:</p>
<ul>
<li><div class="fn"></div><b>QSize slideSize () const</b></li>
<li><div class="fn"></div><b>void setSlideSize ( QSize <i>size</i> )</b></li>
</ul>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QxtFlowView"></a>QxtFlowView::QxtFlowView ( <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>parent</i> = 0 )</h3>
<p>Constructs a new <a href="qxtflowview.html">QxtFlowView</a> with <i>parent</i>.</p>
<h3 class="fn"><a name="dtor.QxtFlowView"></a>QxtFlowView::~QxtFlowView ()</h3>
<p>Destructs the flow view.</p>
<h3 class="fn"><a name="currentIndexChanged"></a>void QxtFlowView::currentIndexChanged ( <a href="http://doc.qtsoftware.com/4.5/qmodelindex.html">QModelIndex</a> <i>index</i> ) <tt> [signal]</tt></h3>
<p>This signal is emitted whenever the current <i>index</i> has changed.</p>
<h3 class="fn"><a name="model"></a><a href="http://doc.qtsoftware.com/4.5/qabstractitemmodel.html">QAbstractItemModel</a> * QxtFlowView::model ()</h3>
<p>Returns the model.</p>
<p>See also <a href="qxtflowview.html#setModel">setModel</a>().</p>
<h3 class="fn"><a name="render"></a>void QxtFlowView::render () <tt> [slot]</tt></h3>
<p>Rerender the widget. Normally this function will be automatically invoked whenever necessary, e.g. during the transition animation.</p>
<h3 class="fn"><a name="setModel"></a>void QxtFlowView::setModel ( <a href="http://doc.qtsoftware.com/4.5/qabstractitemmodel.html">QAbstractItemModel</a> * <i>model</i> )</h3>
<p>Sets the <i>model</i>.</p>
<p><b>Note:</b> The view does not take ownership of the model unless it is the model's parent object because it may be shared between many different views.</p>
<p>See also <a href="qxtflowview.html#model">model</a>().</p>
<h3 class="fn"><a name="showNext"></a>void QxtFlowView::showNext () <tt> [slot]</tt></h3>
<p>Shows next slide using animation effect.</p>
<h3 class="fn"><a name="showPrevious"></a>void QxtFlowView::showPrevious () <tt> [slot]</tt></h3>
<p>Shows previous slide using animation effect.</p>
<h3 class="fn"><a name="showSlide"></a>void QxtFlowView::showSlide ( <a href="http://doc.qtsoftware.com/4.5/qmodelindex.html">QModelIndex</a> <i>index</i> ) <tt> [slot]</tt></h3>
<p>Go to specified slide at <i>index</i> using animation effect.</p>
<h3 class="fn"><a name="triggerRender"></a>void QxtFlowView::triggerRender () <tt> [slot]</tt></h3>
<p>Schedules a rendering update. Unlike <a href="qxtflowview.html#render">render</a>(), this function does not cause immediate rendering.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2007-2010
<a href="mailto:foundation@libqxt.org">Qxt Foundation</a></td>
<td align="right"><div align="right">
<a href="http://libqxt.org">Qxt</a> 0.6.1</div></td>
</tr></table></div></address></body>
</html>
