summaryrefslogtreecommitdiffstats
path: root/doc/html/qpaintevent.html
blob: cb065ba37bb67ebf0d7da3852efdf42030e650f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<!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/qevent.cpp:1251 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QPaintEvent 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>QPaintEvent Class Reference</h1>

<p>The QPaintEvent class contains event parameters for paint events.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qevent-h.html">qevent.h</a>&gt;</tt>
<p>Inherits <a href="qevent.html">QEvent</a>.
<p><a href="qpaintevent-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QPaintEvent"><b>QPaintEvent</b></a> ( const&nbsp;QRegion&nbsp;&amp;&nbsp;paintRegion, bool&nbsp;erased = TRUE )</li>
<li class=fn><a href="#QPaintEvent-2"><b>QPaintEvent</b></a> ( const&nbsp;QRect&nbsp;&amp;&nbsp;paintRect, bool&nbsp;erased = TRUE )</li>
<li class=fn><a href="#QPaintEvent-3"><b>QPaintEvent</b></a> ( const&nbsp;QRegion&nbsp;&amp;&nbsp;paintRegion, const&nbsp;QRect&nbsp;&amp;&nbsp;paintRect, bool&nbsp;erased = TRUE )</li>
<li class=fn>const QRect &amp; <a href="#rect"><b>rect</b></a> () const</li>
<li class=fn>const QRegion &amp; <a href="#region"><b>region</b></a> () const</li>
<li class=fn>bool <a href="#erased"><b>erased</b></a> () const</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QPaintEvent class contains event parameters for paint events.
<p> 
<p> Paint events are sent to widgets that need to update themselves,
for instance when part of a widget is exposed because a covering
widget is moved.
<p> The event contains a <a href="#region">region</a>() that needs to be updated, and a
<a href="#rect">rect</a>() that is the bounding rectangle of that region. Both are
provided because many widgets can't make much use of region(), and
rect() can be much faster than region().boundingRect(). Painting
is clipped to region() during processing of a paint event.
<p> The <a href="#erased">erased</a>() function returns TRUE if the region() has been
cleared to the widget's background (see
<a href="qwidget.html#backgroundMode">QWidget::backgroundMode</a>()), and FALSE if the region's contents are
arbitrary.
<p> <p>See also <a href="qpainter.html">QPainter</a>, <a href="qwidget.html#update">QWidget::update</a>(), <a href="qwidget.html#repaint">QWidget::repaint</a>(), <a href="qwidget.html#paintEvent">QWidget::paintEvent</a>(), <a href="qwidget.html#backgroundMode-prop">QWidget::backgroundMode</a>, <a href="qregion.html">QRegion</a>, and <a href="events.html">Event Classes</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QPaintEvent"></a>QPaintEvent::QPaintEvent ( const&nbsp;<a href="qregion.html">QRegion</a>&nbsp;&amp;&nbsp;paintRegion, bool&nbsp;erased = TRUE )
</h3>

<p> Constructs a paint event object with the region that should be
updated. The region is given by <em>paintRegion</em>. If <em>erased</em> is
TRUE the region will be cleared before repainting.

<h3 class=fn><a name="QPaintEvent-2"></a>QPaintEvent::QPaintEvent ( const&nbsp;<a href="qrect.html">QRect</a>&nbsp;&amp;&nbsp;paintRect, bool&nbsp;erased = TRUE )
</h3>

<p> Constructs a paint event object with the rectangle that should be
updated. The region is also given by <em>paintRect</em>. If <em>erased</em> is
TRUE the region will be cleared before repainting.

<h3 class=fn><a name="QPaintEvent-3"></a>QPaintEvent::QPaintEvent ( const&nbsp;<a href="qregion.html">QRegion</a>&nbsp;&amp;&nbsp;paintRegion, const&nbsp;<a href="qrect.html">QRect</a>&nbsp;&amp;&nbsp;paintRect, bool&nbsp;erased = TRUE )
</h3>

<p> Constructs a paint event object with the rectangle <em>paintRect</em>
that should be updated. The region is given by <em>paintRegion</em>. If
<em>erased</em> is TRUE the region will be cleared before repainting.

<h3 class=fn>bool <a name="erased"></a>QPaintEvent::erased () const
</h3>

<p> Returns TRUE if the paint event region (or rectangle) has been
erased with the widget's background; otherwise returns FALSE.

<h3 class=fn>const&nbsp;<a href="qrect.html">QRect</a>&nbsp;&amp; <a name="rect"></a>QPaintEvent::rect () const
</h3>

<p> Returns the rectangle that should be updated.
<p> <p>See also <a href="#region">region</a>() and <a href="qpainter.html#setClipRect">QPainter::setClipRect</a>().

<p>Examples: <a href="life-example.html#x1892">life/life.cpp</a>, <a href="qfd-example.html#x2001">qfd/fontdisplayer.cpp</a>, <a href="showimg-example.html#x1340">showimg/showimg.cpp</a>, <a href="tutorial1-10.html#x2357">t10/cannon.cpp</a>, <a href="tutorial1-11.html#x2369">t11/cannon.cpp</a>, <a href="tutorial1-13.html#x2405">t13/cannon.cpp</a>, and <a href="tooltip-example.html#x446">tooltip/tooltip.cpp</a>.
<h3 class=fn>const&nbsp;<a href="qregion.html">QRegion</a>&nbsp;&amp; <a name="region"></a>QPaintEvent::region () const
</h3>

<p> Returns the region that should be updated.
<p> <p>See also <a href="#rect">rect</a>() and <a href="qpainter.html#setClipRegion">QPainter::setClipRegion</a>().

<p>Examples: <a href="qfd-example.html#x2002">qfd/fontdisplayer.cpp</a> and <a href="scribble-example.html#x920">scribble/scribble.cpp</a>.
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt 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>Qt 3.3.8</div>
</table></div></address></body>
</html>