~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QRubberBand Class Reference</h1>

<p>The QRubberBand class provides a rectangle or line that can indicate a selection or a boundary. <a href="#details">More...</a></p>

<pre>#include <QRubberBand></pre><p>Part of the <a href="qtgui.html">QtGui</a> module.</p>

<p>Inherits <a href="qwidget.html">QWidget</a>.</p>

<ul>

<li><a href="qrubberband-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Types</h3>

<ul>

<li><div class="fn"/>enum <b><a href="qrubberband.html#Shape-enum">Shape</a></b> { Line, Rectangle }</li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qrubberband.html#QRubberBand">QRubberBand</a></b> ( Shape <i>s</i>, QWidget * <i>p</i> = 0 )</li>

<li><div class="fn"/><b><a href="qrubberband.html#dtor.QRubberBand">~QRubberBand</a></b> ()</li>

<li><div class="fn"/>void <b><a href="qrubberband.html#move-2">move</a></b> ( const QPoint & <i>p</i> )</li>

<li><div class="fn"/>void <b><a href="qrubberband.html#resize">resize</a></b> ( int <i>width</i>, int <i>height</i> )</li>

<li><div class="fn"/>void <b><a href="qrubberband.html#resize-2">resize</a></b> ( const QSize & <i>size</i> )</li>

<li><div class="fn"/>void <b><a href="qrubberband.html#setGeometry">setGeometry</a></b> ( const QRect & <i>rect</i> )</li>

<li><div class="fn"/>void <b><a href="qrubberband.html#setGeometry-2">setGeometry</a></b> ( int <i>x</i>, int <i>y</i>, int <i>w</i>, int <i>h</i> )</li>

<li><div class="fn"/>Shape <b><a href="qrubberband.html#shape">shape</a></b> () const</li>

</ul>

<ul>

<li><div class="fn"/>183 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>

<li><div class="fn"/>28 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>

<li><div class="fn"/>10 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>

</ul>

<h3>Additional Inherited Members</h3>

<ul>

<li><div class="fn"/>52 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>

<li><div class="fn"/>1 property inherited from <a href="qobject.html#properties">QObject</a></li>

<li><div class="fn"/>17 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>

<li><div class="fn"/>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>

<li><div class="fn"/>4 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li>

<li><div class="fn"/>4 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>

<li><div class="fn"/>39 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>

<li><div class="fn"/>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QRubberBand class provides a rectangle or line that can indicate a selection or a boundary.</p>

<p>A rubber band is often used to show a new bounding area (as in a <a href="qsplitter.html">QSplitter</a> or a <a href="qdockwidget.html">QDockWidget</a> that is undocking). Historically this has been implemented using a <a href="qpainter.html">QPainter</a> and XOR, but this approach doesn't always work properly since rendering can happen in the window below the rubber band, but before the rubber band has been "erased".</p>

<p>You can create a QRubberBand whenever you need to render a rubber band around a given area (or to represent a single line), then call <a href="qrubberband.html#setGeometry">setGeometry</a>(), <a href="qrubberband.html#move">move</a>() or <a href="qrubberband.html#resize">resize</a>() to position and size it; hiding (or destroying) the widget will make the rubber band disappear. The rubber band can be a <tt>Rectangle</tt> or a <tt>Line</tt>, depending on the <a href="qrubberband.html#shape">shape</a>() it was given when constructed.</p>

<hr />

<h2>Member Type Documentation</h2>

<h3 class="fn"><a name="Shape-enum"></a>enum QRubberBand::Shape</h3>

<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>

<tr><td valign="top"><tt>QRubberBand::Line</tt></td><td align="center" valign="top"><tt>0</tt></td></tr>

<tr><td valign="top"><tt>QRubberBand::Rectangle</tt></td><td align="center" valign="top"><tt>1</tt></td></tr>

</table>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="QRubberBand"></a>QRubberBand::QRubberBand ( <a href="qrubberband.html#Shape-enum">Shape</a> <i>s</i>, <a href="qwidget.html">QWidget</a> * <i>p</i> = 0 )</h3>

<p>Constructs a rubber band of shape <i>s</i>, with parent <i>p</i>.</p>

<p>By default a rectangular <a href="qrubberband.html">QRubberBand</a> (<i>s</i> is <tt>Rectangle</tt>) will be set to auto mask, so that the boundary of the rectangle is all that is visible. Some styles (for example native Mac OS X) will change this and call <a href="qwidget.html#windowOpacity-prop">QWidget::setWindowOpacity</a>() to make the window only partially opaque.</p>

<h3 class="fn"><a name="dtor.QRubberBand"></a>QRubberBand::~QRubberBand ()</h3>

<p>Destructor.</p>

<h3 class="fn"><a name="move"></a>void QRubberBand::move ( int <i>x</i>, int <i>y</i> )</h3>

<p>Moves the rubberband to point (<i>x</i>, <i>y</i>).</p>

<p>See also <a href="qrubberband.html#resize">resize</a>().</p>

<h3 class="fn"><a name="move-2"></a>void QRubberBand::move ( const <a href="qpoint.html">QPoint</a> & <i>p</i> )</h3>

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

<p>Moves the rubberband to point <i>p</i>.</p>

<p>See also <a href="qrubberband.html#resize">resize</a>().</p>

<h3 class="fn"><a name="resize"></a>void QRubberBand::resize ( int <i>width</i>, int <i>height</i> )</h3>

<p>Resizes the rubberband so that its width is <i>width</i>, and its height is <i>height</i>.</p>

<h3 class="fn"><a name="resize-2"></a>void QRubberBand::resize ( const <a href="qsize.html">QSize</a> & <i>size</i> )</h3>

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

<p>Resizes the rubberband so that its new size is <i>size</i>.</p>

<h3 class="fn"><a name="setGeometry"></a>void QRubberBand::setGeometry ( const <a href="qrect.html">QRect</a> & <i>rect</i> )</h3>

<p>Changes the rubberband's geometry to the geometry of the rectangle <i>rect</i>.</p>

100

<p>See also <a href="qrubberband.html#move">move</a>() and <a href="qrubberband.html#resize">resize</a>().</p>

101

<h3 class="fn"><a name="setGeometry-2"></a>void QRubberBand::setGeometry ( int <i>x</i>, int <i>y</i>, int <i>w</i>, int <i>h</i> )</h3>

102

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

103

<p>Changes the rubberband's geometry to have a top-left corner of (<i>x</i>, <i>y</i>), a width of <i>w</i>, and a height of <i>h</i>.</p>

104

<p>See also <a href="qrubberband.html#move">move</a>() and <a href="qrubberband.html#resize">resize</a>().</p>

105

<h3 class="fn"><a name="shape"></a><a href="qrubberband.html#Shape-enum">Shape</a> QRubberBand::shape () const</h3>

106

<p>Returns the shape of this rubber band. The shape can only be set upon construction.</p>

107

108

109

110

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

111

112

</tr></table></div></address></body>

113

</html>

Older »