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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qpen.cpp -->
<title>Qt 4.8: QPen Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QPen</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#related-non-members">Related Non-Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#pen-style">Pen Style</a></li>
<li class="level2"><a href="#cap-style">Cap Style</a></li>
<li class="level2"><a href="#join-style">Join Style</a></li>
</ul>
</div>
<h1 class="title">QPen Class Reference</h1>
<!-- $$$QPen-brief -->
<p>The QPen class defines how a <a href="qpainter.html">QPainter</a> should draw lines and outlines of shapes. <a href="#details">More...</a></p>
<!-- @@@QPen -->
<pre class="cpp"> <span class="preprocessor">#include <QPen></span></pre><ul>
<li><a href="qpen-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#QPen">QPen</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#QPen-2">QPen</a></b> ( Qt::PenStyle <i>style</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#QPen-3">QPen</a></b> ( const QColor & <i>color</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#QPen-4">QPen</a></b> ( const QBrush & <i>brush</i>, qreal <i>width</i>, Qt::PenStyle <i>style</i> = Qt::SolidLine, Qt::PenCapStyle <i>cap</i> = Qt::SquareCap, Qt::PenJoinStyle <i>join</i> = Qt::BevelJoin )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#QPen-5">QPen</a></b> ( const QPen & <i>pen</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#dtor.QPen">~QPen</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBrush </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#brush">brush</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::PenCapStyle </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#capStyle">capStyle</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QColor </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#color">color</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#dashOffset">dashOffset</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVector<qreal> </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#dashPattern">dashPattern</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#isCosmetic">isCosmetic</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#isSolid">isSolid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::PenJoinStyle </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#joinStyle">joinStyle</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#miterLimit">miterLimit</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setBrush">setBrush</a></b> ( const QBrush & <i>brush</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setCapStyle">setCapStyle</a></b> ( Qt::PenCapStyle <i>style</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setColor">setColor</a></b> ( const QColor & <i>color</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setCosmetic">setCosmetic</a></b> ( bool <i>cosmetic</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setDashOffset">setDashOffset</a></b> ( qreal <i>offset</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setDashPattern">setDashPattern</a></b> ( const QVector<qreal> & <i>pattern</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setJoinStyle">setJoinStyle</a></b> ( Qt::PenJoinStyle <i>style</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setMiterLimit">setMiterLimit</a></b> ( qreal <i>limit</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setStyle">setStyle</a></b> ( Qt::PenStyle <i>style</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setWidth">setWidth</a></b> ( int <i>width</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#setWidthF">setWidthF</a></b> ( qreal <i>width</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::PenStyle </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#style">style</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#swap">swap</a></b> ( QPen & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#width">width</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#widthF">widthF</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#operator-QVariant">operator QVariant</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#operator-not-eq">operator!=</a></b> ( const QPen & <i>pen</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPen & </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#operator-eq">operator=</a></b> ( const QPen & <i>pen</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#operator-eq-eq">operator==</a></b> ( const QPen & <i>pen</i> ) const</td></tr>
</table>
<a name="related-non-members"></a>
<h2>Related Non-Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#operator-lt-lt-174">operator<<</a></b> ( QDataStream & <i>stream</i>, const QPen & <i>pen</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="qpen.html#operator-gt-gt-97">operator>></a></b> ( QDataStream & <i>stream</i>, QPen & <i>pen</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QPen-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QPen class defines how a <a href="qpainter.html">QPainter</a> should draw lines and outlines of shapes.</p>
<p>A pen has a <a href="qpen.html#style">style</a>(), <a href="qpen.html#width">width</a>(), <a href="qpen.html#brush">brush</a>(), <a href="qpen.html#capStyle">capStyle</a>() and <a href="qpen.html#joinStyle">joinStyle</a>().</p>
<p>The pen style defines the line type. The brush is used to fill strokes generated with the pen. Use the <a href="qbrush.html">QBrush</a> class to specify fill styles. The cap style determines the line end caps that can be drawn using <a href="qpainter.html">QPainter</a>, while the join style describes how joins between two lines are drawn. The pen width can be specified in both integer (<a href="qpen.html#width">width</a>()) and floating point (<a href="qpen.html#widthF">widthF</a>()) precision. A line width of zero indicates a cosmetic pen. This means that the pen width is always drawn one pixel wide, independent of the <a href="qpainter.html#coordinate-transformations">transformation</a> set on the painter.</p>
<p>The various settings can easily be modified using the corresponding <a href="qpen.html#setStyle">setStyle</a>(), <a href="qpen.html#setWidth">setWidth</a>(), <a href="qpen.html#setBrush">setBrush</a>(), <a href="qpen.html#setCapStyle">setCapStyle</a>() and <a href="qpen.html#setJoinStyle">setJoinStyle</a>() functions (note that the painter's pen must be reset when altering the pen's properties).</p>
<p>For example:</p>
<pre class="cpp"> <span class="type"><a href="qpainter.html">QPainter</a></span> painter(<span class="keyword">this</span>);
<span class="type">QPen</span> pen(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>green<span class="operator">,</span> <span class="number">3</span><span class="operator">,</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>DashDotLine<span class="operator">,</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>RoundCap<span class="operator">,</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>RoundJoin);
painter<span class="operator">.</span>setPen(pen);</pre>
<p>which is equivalent to</p>
<pre class="cpp"> <span class="type"><a href="qpainter.html">QPainter</a></span> painter(<span class="keyword">this</span>);
<span class="type">QPen</span> pen; <span class="comment">// creates a default pen</span>
pen<span class="operator">.</span><a href="qpen.html#setStyle">setStyle</a>(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>DashDotLine);
pen<span class="operator">.</span><a href="qpen.html#setWidth">setWidth</a>(<span class="number">3</span>);
pen<span class="operator">.</span><a href="qpen.html#setBrush">setBrush</a>(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>green);
pen<span class="operator">.</span><a href="qpen.html#setCapStyle">setCapStyle</a>(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>RoundCap);
pen<span class="operator">.</span><a href="qpen.html#setJoinStyle">setJoinStyle</a>(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>RoundJoin);
painter<span class="operator">.</span>setPen(pen);</pre>
<p>The default pen is a solid black brush with 0 width, square cap style (<a href="qt.html#PenCapStyle-enum">Qt::SquareCap</a>), and bevel join style (<a href="qt.html#PenJoinStyle-enum">Qt::BevelJoin</a>).</p>
<p>In addition QPen provides the <a href="qpen.html#color">color</a>() and <a href="qpen.html#setColor">setColor</a>() convenience functions to extract and set the color of the pen's brush, respectively. Pens may also be compared and streamed.</p>
<p>For more information about painting in general, see the <a href="paintsystem.html">Paint System</a> documentation.</p>
<a name="pen-style"></a>
<h3>Pen Style</h3>
<p>Qt provides several built-in styles represented by the <a href="qt.html#PenStyle-enum">Qt::PenStyle</a> enum:</p>
<table class="generic">
<tr valign="top" class="odd"><td ><img src="images/qpen-solid.png" alt="" /></td><td ><img src="images/qpen-dash.png" alt="" /></td><td ><img src="images/qpen-dot.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><a href="qt.html#PenStyle-enum">Qt::SolidLine</a></td><td ><a href="qt.html#PenStyle-enum">Qt::DashLine</a></td><td ><a href="qt.html#PenStyle-enum">Qt::DotLine</a></td></tr>
<tr valign="top" class="odd"><td ><img src="images/qpen-dashdot.png" alt="" /></td><td ><img src="images/qpen-dashdotdot.png" alt="" /></td><td ><img src="images/qpen-custom.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><a href="qt.html#PenStyle-enum">Qt::DashDotLine</a></td><td ><a href="qt.html#PenStyle-enum">Qt::DashDotDotLine</a></td><td ><a href="qt.html#PenStyle-enum">Qt::CustomDashLine</a></td></tr>
</table>
<p>Simply use the <a href="qpen.html#setStyle">setStyle</a>() function to convert the pen style to either of the built-in styles, except the <a href="qt.html#PenStyle-enum">Qt::CustomDashLine</a> style which we will come back to shortly. Setting the style to <a href="qt.html#PenStyle-enum">Qt::NoPen</a> tells the painter to not draw lines or outlines. The default pen style is <a href="qt.html#PenStyle-enum">Qt::SolidLine</a>.</p>
<p>Since Qt 4.1 it is also possible to specify a custom dash pattern using the <a href="qpen.html#setDashPattern">setDashPattern</a>() function which implicitly converts the style of the pen to <a href="qt.html#PenStyle-enum">Qt::CustomDashLine</a>. The pattern argument, a <a href="qvector.html">QVector</a>, must be specified as an even number of <a href="qtglobal.html#qreal-typedef">qreal</a> entries where the entries 1, 3, 5... are the dashes and 2, 4, 6... are the spaces. For example, the custom pattern shown above is created using the following code:</p>
<pre class="cpp"> <span class="type">QPen</span> pen;
<span class="type"><a href="qvector.html">QVector</a></span><span class="operator"><</span><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span><span class="operator">></span> dashes;
<span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> space <span class="operator">=</span> <span class="number">4</span>;
dashes <span class="operator"><</span><span class="operator"><</span> <span class="number">1</span> <span class="operator"><</span><span class="operator"><</span> space <span class="operator"><</span><span class="operator"><</span> <span class="number">3</span> <span class="operator"><</span><span class="operator"><</span> space <span class="operator"><</span><span class="operator"><</span> <span class="number">9</span> <span class="operator"><</span><span class="operator"><</span> space
<span class="operator"><</span><span class="operator"><</span> <span class="number">27</span> <span class="operator"><</span><span class="operator"><</span> space <span class="operator"><</span><span class="operator"><</span> <span class="number">9</span> <span class="operator"><</span><span class="operator"><</span> space;
pen<span class="operator">.</span><a href="qpen.html#setDashPattern">setDashPattern</a>(dashes);</pre>
<p>Note that the dash pattern is specified in units of the pens width, e.g. a dash of length 5 in width 10 is 50 pixels long.</p>
<p>The currently set dash pattern can be retrieved using the <a href="qpen.html#dashPattern">dashPattern</a>() function. Use the <a href="qpen.html#isSolid">isSolid</a>() function to determine whether the pen has a solid fill, or not.</p>
<a name="cap-style"></a>
<h3>Cap Style</h3>
<p>The cap style defines how the end points of lines are drawn using <a href="qpainter.html">QPainter</a>. The cap style only apply to wide lines, i.e. when the width is 1 or greater. The <a href="qt.html#PenCapStyle-enum">Qt::PenCapStyle</a> enum provides the following styles:</p>
<table class="generic">
<tr valign="top" class="odd"><td ><img src="images/qpen-square.png" alt="" /></td><td ><img src="images/qpen-flat.png" alt="" /></td><td ><img src="images/qpen-roundcap.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><a href="qt.html#PenCapStyle-enum">Qt::SquareCap</a></td><td ><a href="qt.html#PenCapStyle-enum">Qt::FlatCap</a></td><td ><a href="qt.html#PenCapStyle-enum">Qt::RoundCap</a></td></tr>
</table>
<p>The <a href="qt.html#PenCapStyle-enum">Qt::SquareCap</a> style is a square line end that covers the end point and extends beyond it by half the line width. The <a href="qt.html#PenCapStyle-enum">Qt::FlatCap</a> style is a square line end that does not cover the end point of the line. And the <a href="qt.html#PenCapStyle-enum">Qt::RoundCap</a> style is a rounded line end covering the end point.</p>
<p>The default is <a href="qt.html#PenCapStyle-enum">Qt::SquareCap</a>.</p>
<p>Whether or not end points are drawn when the pen width is 0 or 1 depends on the cap style. Using <a href="qt.html#PenCapStyle-enum">Qt::SquareCap</a> or <a href="qt.html#PenCapStyle-enum">Qt::RoundCap</a> they are drawn, using <a href="qt.html#PenCapStyle-enum">Qt::FlatCap</a> they are not drawn.</p>
<a name="join-style"></a>
<h3>Join Style</h3>
<p>The join style defines how joins between two connected lines can be drawn using <a href="qpainter.html">QPainter</a>. The join style only apply to wide lines, i.e. when the width is 1 or greater. The <a href="qt.html#PenJoinStyle-enum">Qt::PenJoinStyle</a> enum provides the following styles:</p>
<table class="generic">
<tr valign="top" class="odd"><td ><img src="images/qpen-bevel.png" alt="" /></td><td ><img src="images/qpen-miter.png" alt="" /></td><td ><img src="images/qpen-roundjoin.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><a href="qt.html#PenJoinStyle-enum">Qt::BevelJoin</a></td><td ><a href="qt.html#PenJoinStyle-enum">Qt::MiterJoin</a></td><td ><a href="qt.html#PenJoinStyle-enum">Qt::RoundJoin</a></td></tr>
</table>
<p>The <a href="qt.html#PenJoinStyle-enum">Qt::BevelJoin</a> style fills the triangular notch between the two lines. The <a href="qt.html#PenJoinStyle-enum">Qt::MiterJoin</a> style extends the lines to meet at an angle. And the <a href="qt.html#PenJoinStyle-enum">Qt::RoundJoin</a> style fills a circular arc between the two lines.</p>
<p>The default is <a href="qt.html#PenJoinStyle-enum">Qt::BevelJoin</a>.</p>
<p class="centerAlign"><img src="images/qpen-miterlimit.png" alt="" /></p><p>When the <a href="qt.html#PenJoinStyle-enum">Qt::MiterJoin</a> style is applied, it is possible to use the <a href="qpen.html#setMiterLimit">setMiterLimit</a>() function to specify how far the miter join can extend from the join point. The <a href="qpen.html#miterLimit">miterLimit</a>() is used to reduce artifacts between line joins where the lines are close to parallel.</p>
<p>The <a href="qpen.html#miterLimit">miterLimit</a>() must be specified in units of the pens width, e.g. a miter limit of 5 in width 10 is 50 pixels long. The default miter limit is 2, i.e. twice the pen width in pixels.</p>
<table class="generic" width="100%">
<tr valign="top" class="odd"><td ><img src="images/qpen-demo.png" alt="" /></td><td ><b><a href="demos-pathstroke.html">The Path Stroking Demo</a></b><p>The Path Stroking demo shows Qt's built-in dash patterns and shows how custom patterns can be used to extend the range of available patterns.</p>
</td></tr>
</table>
</div>
<p><b>See also </b><a href="qpainter.html">QPainter</a>, <a href="qbrush.html">QBrush</a>, <a href="demos-pathstroke.html">Path Stroking Demo</a>, and <a href="widgets-scribble.html">Scribble Example</a>.</p>
<!-- @@@QPen -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPen[overload1]$$$QPen -->
<h3 class="fn"><a name="QPen"></a>QPen::<span class="name">QPen</span> ()</h3>
<p>Constructs a default black solid line pen with 0 width.</p>
<!-- @@@QPen -->
<!-- $$$QPen$$$QPenQt::PenStyle -->
<h3 class="fn"><a name="QPen-2"></a>QPen::<span class="name">QPen</span> ( <span class="type"><a href="qt.html#PenStyle-enum">Qt::PenStyle</a></span> <i>style</i> )</h3>
<p>Constructs a black pen with 0 width and the given <i>style</i>.</p>
<p><b>See also </b><a href="qpen.html#setStyle">setStyle</a>().</p>
<!-- @@@QPen -->
<!-- $$$QPen$$$QPenconstQColor& -->
<h3 class="fn"><a name="QPen-3"></a>QPen::<span class="name">QPen</span> ( const <span class="type"><a href="qcolor.html">QColor</a></span> & <i>color</i> )</h3>
<p>Constructs a solid line pen with 0 width and the given <i>color</i>.</p>
<p><b>See also </b><a href="qpen.html#setBrush">setBrush</a>() and <a href="qpen.html#setColor">setColor</a>().</p>
<!-- @@@QPen -->
<!-- $$$QPen$$$QPenconstQBrush&qrealQt::PenStyleQt::PenCapStyleQt::PenJoinStyle -->
<h3 class="fn"><a name="QPen-4"></a>QPen::<span class="name">QPen</span> ( const <span class="type"><a href="qbrush.html">QBrush</a></span> & <i>brush</i>, <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>width</i>, <span class="type"><a href="qt.html#PenStyle-enum">Qt::PenStyle</a></span> <i>style</i> = Qt::SolidLine, <span class="type"><a href="qt.html#PenCapStyle-enum">Qt::PenCapStyle</a></span> <i>cap</i> = Qt::SquareCap, <span class="type"><a href="qt.html#PenJoinStyle-enum">Qt::PenJoinStyle</a></span> <i>join</i> = Qt::BevelJoin )</h3>
<p>Constructs a pen with the specified <i>brush</i>, <i>width</i>, pen <i>style</i>, <i>cap</i> style and <i>join</i> style.</p>
<p><b>See also </b><a href="qpen.html#setBrush">setBrush</a>(), <a href="qpen.html#setWidth">setWidth</a>(), <a href="qpen.html#setStyle">setStyle</a>(), <a href="qpen.html#setCapStyle">setCapStyle</a>(), and <a href="qpen.html#setJoinStyle">setJoinStyle</a>().</p>
<!-- @@@QPen -->
<!-- $$$QPen$$$QPenconstQPen& -->
<h3 class="fn"><a name="QPen-5"></a>QPen::<span class="name">QPen</span> ( const <span class="type">QPen</span> & <i>pen</i> )</h3>
<p>Constructs a pen that is a copy of the given <i>pen</i>.</p>
<!-- @@@QPen -->
<!-- $$$~QPen[overload1]$$$~QPen -->
<h3 class="fn"><a name="dtor.QPen"></a>QPen::<span class="name">~QPen</span> ()</h3>
<p>Destroys the pen.</p>
<!-- @@@~QPen -->
<!-- $$$brush[overload1]$$$brush -->
<h3 class="fn"><a name="brush"></a><span class="type"><a href="qbrush.html">QBrush</a></span> QPen::<span class="name">brush</span> () const</h3>
<p>Returns the brush used to fill strokes generated with this pen.</p>
<p><b>See also </b><a href="qpen.html#setBrush">setBrush</a>().</p>
<!-- @@@brush -->
<!-- $$$capStyle[overload1]$$$capStyle -->
<h3 class="fn"><a name="capStyle"></a><span class="type"><a href="qt.html#PenCapStyle-enum">Qt::PenCapStyle</a></span> QPen::<span class="name">capStyle</span> () const</h3>
<p>Returns the pen's cap style.</p>
<p><b>See also </b><a href="qpen.html#setCapStyle">setCapStyle</a>() and <a href="qpen.html#cap-style">Cap Style</a>.</p>
<!-- @@@capStyle -->
<!-- $$$color[overload1]$$$color -->
<h3 class="fn"><a name="color"></a><span class="type"><a href="qcolor.html">QColor</a></span> QPen::<span class="name">color</span> () const</h3>
<p>Returns the color of this pen's brush.</p>
<p><b>See also </b><a href="qpen.html#brush">brush</a>() and <a href="qpen.html#setColor">setColor</a>().</p>
<!-- @@@color -->
<!-- $$$dashOffset[overload1]$$$dashOffset -->
<h3 class="fn"><a name="dashOffset"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QPen::<span class="name">dashOffset</span> () const</h3>
<p>Returns the dash offset for the pen.</p>
<p><b>See also </b><a href="qpen.html#setDashOffset">setDashOffset</a>().</p>
<!-- @@@dashOffset -->
<!-- $$$dashPattern[overload1]$$$dashPattern -->
<h3 class="fn"><a name="dashPattern"></a><span class="type"><a href="qvector.html">QVector</a></span><<span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span>> QPen::<span class="name">dashPattern</span> () const</h3>
<p>Returns the dash pattern of this pen.</p>
<p><b>See also </b><a href="qpen.html#setDashPattern">setDashPattern</a>(), <a href="qpen.html#style">style</a>(), and <a href="qpen.html#isSolid">isSolid</a>().</p>
<!-- @@@dashPattern -->
<!-- $$$isCosmetic[overload1]$$$isCosmetic -->
<h3 class="fn"><a name="isCosmetic"></a><span class="type">bool</span> QPen::<span class="name">isCosmetic</span> () const</h3>
<p>Returns true if the pen is cosmetic; otherwise returns false.</p>
<p>Cosmetic pens are used to draw strokes that have a constant width regardless of any transformations applied to the <a href="qpainter.html">QPainter</a> they are used with. Drawing a shape with a cosmetic pen ensures that its outline will have the same thickness at different scale factors.</p>
<p>A zero width pen is cosmetic by default; pens with a non-zero width are non-cosmetic.</p>
<p><b>See also </b><a href="qpen.html#setCosmetic">setCosmetic</a>() and <a href="qpen.html#widthF">widthF</a>().</p>
<!-- @@@isCosmetic -->
<!-- $$$isSolid[overload1]$$$isSolid -->
<h3 class="fn"><a name="isSolid"></a><span class="type">bool</span> QPen::<span class="name">isSolid</span> () const</h3>
<p>Returns true if the pen has a solid fill, otherwise false.</p>
<p><b>See also </b><a href="qpen.html#style">style</a>() and <a href="qpen.html#dashPattern">dashPattern</a>().</p>
<!-- @@@isSolid -->
<!-- $$$joinStyle[overload1]$$$joinStyle -->
<h3 class="fn"><a name="joinStyle"></a><span class="type"><a href="qt.html#PenJoinStyle-enum">Qt::PenJoinStyle</a></span> QPen::<span class="name">joinStyle</span> () const</h3>
<p>Returns the pen's join style.</p>
<p><b>See also </b><a href="qpen.html#setJoinStyle">setJoinStyle</a>() and <a href="qpen.html#join-style">Join Style</a>.</p>
<!-- @@@joinStyle -->
<!-- $$$miterLimit[overload1]$$$miterLimit -->
<h3 class="fn"><a name="miterLimit"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QPen::<span class="name">miterLimit</span> () const</h3>
<p>Returns the miter limit of the pen. The miter limit is only relevant when the join style is set to <a href="qt.html#PenJoinStyle-enum">Qt::MiterJoin</a>.</p>
<p><b>See also </b><a href="qpen.html#setMiterLimit">setMiterLimit</a>() and <a href="qpen.html#join-style">Join Style</a>.</p>
<!-- @@@miterLimit -->
<!-- $$$setBrush[overload1]$$$setBrushconstQBrush& -->
<h3 class="fn"><a name="setBrush"></a><span class="type">void</span> QPen::<span class="name">setBrush</span> ( const <span class="type"><a href="qbrush.html">QBrush</a></span> & <i>brush</i> )</h3>
<p>Sets the brush used to fill strokes generated with this pen to the given <i>brush</i>.</p>
<p><b>See also </b><a href="qpen.html#brush">brush</a>() and <a href="qpen.html#setColor">setColor</a>().</p>
<!-- @@@setBrush -->
<!-- $$$setCapStyle[overload1]$$$setCapStyleQt::PenCapStyle -->
<h3 class="fn"><a name="setCapStyle"></a><span class="type">void</span> QPen::<span class="name">setCapStyle</span> ( <span class="type"><a href="qt.html#PenCapStyle-enum">Qt::PenCapStyle</a></span> <i>style</i> )</h3>
<p>Sets the pen's cap style to the given <i>style</i>. The default value is <a href="qt.html#PenCapStyle-enum">Qt::SquareCap</a>.</p>
<p><b>See also </b><a href="qpen.html#capStyle">capStyle</a>() and <a href="qpen.html#cap-style">Cap Style</a>.</p>
<!-- @@@setCapStyle -->
<!-- $$$setColor[overload1]$$$setColorconstQColor& -->
<h3 class="fn"><a name="setColor"></a><span class="type">void</span> QPen::<span class="name">setColor</span> ( const <span class="type"><a href="qcolor.html">QColor</a></span> & <i>color</i> )</h3>
<p>Sets the color of this pen's brush to the given <i>color</i>.</p>
<p><b>See also </b><a href="qpen.html#setBrush">setBrush</a>() and <a href="qpen.html#color">color</a>().</p>
<!-- @@@setColor -->
<!-- $$$setCosmetic[overload1]$$$setCosmeticbool -->
<h3 class="fn"><a name="setCosmetic"></a><span class="type">void</span> QPen::<span class="name">setCosmetic</span> ( <span class="type">bool</span> <i>cosmetic</i> )</h3>
<p>Sets this pen to cosmetic or non-cosmetic, depending on the value of <i>cosmetic</i>.</p>
<p><b>See also </b><a href="qpen.html#isCosmetic">isCosmetic</a>().</p>
<!-- @@@setCosmetic -->
<!-- $$$setDashOffset[overload1]$$$setDashOffsetqreal -->
<h3 class="fn"><a name="setDashOffset"></a><span class="type">void</span> QPen::<span class="name">setDashOffset</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>offset</i> )</h3>
<p>Sets the dash offset (the starting point on the dash pattern) for this pen to the <i>offset</i> specified. The offset is measured in terms of the units used to specify the dash pattern.</p>
<table class="generic">
<tr valign="top" class="odd"><td ><img src="images/qpen-dashpattern.png" alt="" /></td><td >For example, a pattern where each stroke is four units long, followed by a gap of two units, will begin with the stroke when drawn as a line.<p>However, if the dash offset is set to 4.0, any line drawn will begin with the gap. Values of the offset up to 4.0 will cause part of the stroke to be drawn first, and values of the offset between 4.0 and 6.0 will cause the line to begin with part of the gap.</p>
</td></tr>
</table>
<p><b>Note:</b> This implicitly converts the style of the pen to <a href="qt.html#PenStyle-enum">Qt::CustomDashLine</a>.</p>
<p><b>See also </b><a href="qpen.html#dashOffset">dashOffset</a>().</p>
<!-- @@@setDashOffset -->
<!-- $$$setDashPattern[overload1]$$$setDashPatternconstQVector<qreal>& -->
<h3 class="fn"><a name="setDashPattern"></a><span class="type">void</span> QPen::<span class="name">setDashPattern</span> ( const <span class="type"><a href="qvector.html">QVector</a></span><<span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span>> & <i>pattern</i> )</h3>
<p>Sets the dash pattern for this pen to the given <i>pattern</i>. This implicitly converts the style of the pen to <a href="qt.html#PenStyle-enum">Qt::CustomDashLine</a>.</p>
<p>The pattern must be specified as an even number of positive entries where the entries 1, 3, 5... are the dashes and 2, 4, 6... are the spaces. For example:</p>
<table class="generic" width="100%">
<tr valign="top" class="odd"><td ><img src="images/qpen-custom.png" alt="" /></td><td ><pre class="cpp"> <span class="type"><a href="qpen.html">QPen</a></span> pen;
<span class="type"><a href="qvector.html">QVector</a></span><span class="operator"><</span><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span><span class="operator">></span> dashes;
<span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> space <span class="operator">=</span> <span class="number">4</span>;
dashes <span class="operator"><</span><span class="operator"><</span> <span class="number">1</span> <span class="operator"><</span><span class="operator"><</span> space <span class="operator"><</span><span class="operator"><</span> <span class="number">3</span> <span class="operator"><</span><span class="operator"><</span> space <span class="operator"><</span><span class="operator"><</span> <span class="number">9</span> <span class="operator"><</span><span class="operator"><</span> space
<span class="operator"><</span><span class="operator"><</span> <span class="number">27</span> <span class="operator"><</span><span class="operator"><</span> space <span class="operator"><</span><span class="operator"><</span> <span class="number">9</span> <span class="operator"><</span><span class="operator"><</span> space;
pen<span class="operator">.</span>setDashPattern(dashes);</pre>
</td></tr>
</table>
<p>The dash pattern is specified in units of the pens width; e.g. a dash of length 5 in width 10 is 50 pixels long. Note that a pen with zero width is equivalent to a cosmetic pen with a width of 1 pixel.</p>
<p>Each dash is also subject to cap styles so a dash of 1 with square cap set will extend 0.5 pixels out in each direction resulting in a total width of 2.</p>
<p>Note that the default cap style is <a href="qt.html#PenCapStyle-enum">Qt::SquareCap</a>, meaning that a square line end covers the end point and extends beyond it by half the line width.</p>
<p><b>See also </b><a href="qpen.html#setStyle">setStyle</a>(), <a href="qpen.html#dashPattern">dashPattern</a>(), <a href="qpen.html#setCapStyle">setCapStyle</a>(), and <a href="qpen.html#setCosmetic">setCosmetic</a>().</p>
<!-- @@@setDashPattern -->
<!-- $$$setJoinStyle[overload1]$$$setJoinStyleQt::PenJoinStyle -->
<h3 class="fn"><a name="setJoinStyle"></a><span class="type">void</span> QPen::<span class="name">setJoinStyle</span> ( <span class="type"><a href="qt.html#PenJoinStyle-enum">Qt::PenJoinStyle</a></span> <i>style</i> )</h3>
<p>Sets the pen's join style to the given <i>style</i>. The default value is <a href="qt.html#PenJoinStyle-enum">Qt::BevelJoin</a>.</p>
<p><b>See also </b><a href="qpen.html#joinStyle">joinStyle</a>() and <a href="qpen.html#join-style">Join Style</a>.</p>
<!-- @@@setJoinStyle -->
<!-- $$$setMiterLimit[overload1]$$$setMiterLimitqreal -->
<h3 class="fn"><a name="setMiterLimit"></a><span class="type">void</span> QPen::<span class="name">setMiterLimit</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>limit</i> )</h3>
<p>Sets the miter limit of this pen to the given <i>limit</i>.</p>
<p class="centerAlign"><img src="images/qpen-miterlimit.png" alt="" /></p><p>The miter limit describes how far a miter join can extend from the join point. This is used to reduce artifacts between line joins where the lines are close to parallel.</p>
<p>This value does only have effect when the pen style is set to <a href="qt.html#PenJoinStyle-enum">Qt::MiterJoin</a>. The value is specified in units of the pen's width, e.g. a miter limit of 5 in width 10 is 50 pixels long. The default miter limit is 2, i.e. twice the pen width in pixels.</p>
<p><b>See also </b><a href="qpen.html#miterLimit">miterLimit</a>(), <a href="qpen.html#setJoinStyle">setJoinStyle</a>(), and <a href="qpen.html#join-style">Join Style</a>.</p>
<!-- @@@setMiterLimit -->
<!-- $$$setStyle[overload1]$$$setStyleQt::PenStyle -->
<h3 class="fn"><a name="setStyle"></a><span class="type">void</span> QPen::<span class="name">setStyle</span> ( <span class="type"><a href="qt.html#PenStyle-enum">Qt::PenStyle</a></span> <i>style</i> )</h3>
<p>Sets the pen style to the given <i>style</i>.</p>
<p>See the <a href="qt.html#PenStyle-enum">Qt::PenStyle</a> documentation for a list of the available styles. Since Qt 4.1 it is also possible to specify a custom dash pattern using the <a href="qpen.html#setDashPattern">setDashPattern</a>() function which implicitly converts the style of the pen to <a href="qt.html#PenStyle-enum">Qt::CustomDashLine</a>.</p>
<p><b>Note:</b> This function resets the dash offset to zero.</p>
<p><b>See also </b><a href="qpen.html#style">style</a>() and <a href="qpen.html#pen-style">Pen Style</a>.</p>
<!-- @@@setStyle -->
<!-- $$$setWidth[overload1]$$$setWidthint -->
<h3 class="fn"><a name="setWidth"></a><span class="type">void</span> QPen::<span class="name">setWidth</span> ( <span class="type">int</span> <i>width</i> )</h3>
<p>Sets the pen width to the given <i>width</i> in pixels with integer precision.</p>
<p>A line width of zero indicates a cosmetic pen. This means that the pen width is always drawn one pixel wide, independent of the <a href="qpainter.html#coordinate-transformations">transformation</a> set on the painter.</p>
<p>Setting a pen width with a negative value is not supported.</p>
<p><b>See also </b><a href="qpen.html#setWidthF">setWidthF</a>() and <a href="qpen.html#width">width</a>().</p>
<!-- @@@setWidth -->
<!-- $$$setWidthF[overload1]$$$setWidthFqreal -->
<h3 class="fn"><a name="setWidthF"></a><span class="type">void</span> QPen::<span class="name">setWidthF</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>width</i> )</h3>
<p>Sets the pen width to the given <i>width</i> in pixels with floating point precision.</p>
<p>A line width of zero indicates a cosmetic pen. This means that the pen width is always drawn one pixel wide, independent of the <a href="qpainter.html#coordinate-transformations">transformation</a> on the painter.</p>
<p>Setting a pen width with a negative value is not supported.</p>
<p><b>See also </b><a href="qpen.html#setWidth">setWidth</a>() and <a href="qpen.html#widthF">widthF</a>().</p>
<!-- @@@setWidthF -->
<!-- $$$style[overload1]$$$style -->
<h3 class="fn"><a name="style"></a><span class="type"><a href="qt.html#PenStyle-enum">Qt::PenStyle</a></span> QPen::<span class="name">style</span> () const</h3>
<p>Returns the pen style.</p>
<p><b>See also </b><a href="qpen.html#setStyle">setStyle</a>() and <a href="qpen.html#pen-style">Pen Style</a>.</p>
<!-- @@@style -->
<!-- $$$swap[overload1]$$$swapQPen& -->
<h3 class="fn"><a name="swap"></a><span class="type">void</span> QPen::<span class="name">swap</span> ( <span class="type">QPen</span> & <i>other</i> )</h3>
<p>Swaps pen <i>other</i> with this pen. This operation is very fast and never fails.</p>
<p>This function was introduced in Qt 4.8.</p>
<!-- @@@swap -->
<!-- $$$width[overload1]$$$width -->
<h3 class="fn"><a name="width"></a><span class="type">int</span> QPen::<span class="name">width</span> () const</h3>
<p>Returns the pen width with integer precision.</p>
<p><b>See also </b><a href="qpen.html#setWidth">setWidth</a>() and <a href="qpen.html#widthF">widthF</a>().</p>
<!-- @@@width -->
<!-- $$$widthF[overload1]$$$widthF -->
<h3 class="fn"><a name="widthF"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QPen::<span class="name">widthF</span> () const</h3>
<p>Returns the pen width with floating point precision.</p>
<p><b>See also </b><a href="qpen.html#setWidthF">setWidthF</a>() and <a href="qpen.html#width">width</a>().</p>
<!-- @@@widthF -->
<!-- $$$operator QVariant[overload1]$$$operator QVariant -->
<h3 class="fn"><a name="operator-QVariant"></a>QPen::<span class="name">operator QVariant</span> () const</h3>
<p>Returns the pen as a <a href="qvariant.html">QVariant</a>.</p>
<!-- @@@operator QVariant -->
<!-- $$$operator!=[overload1]$$$operator!=constQPen& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QPen::<span class="name">operator!=</span> ( const <span class="type">QPen</span> & <i>pen</i> ) const</h3>
<p>Returns true if the pen is different from the given <i>pen</i>; otherwise false. Two pens are different if they have different styles, widths or colors.</p>
<p><b>See also </b><a href="qpen.html#operator-eq-eq">operator==</a>().</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPen& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QPen</span> & QPen::<span class="name">operator=</span> ( const <span class="type">QPen</span> & <i>pen</i> )</h3>
<p>Assigns the given <i>pen</i> to this pen and returns a reference to this pen.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPen& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QPen::<span class="name">operator==</span> ( const <span class="type">QPen</span> & <i>pen</i> ) const</h3>
<p>Returns true if the pen is equal to the given <i>pen</i>; otherwise false. Two pens are equal if they have equal styles, widths and colors.</p>
<p><b>See also </b><a href="qpen.html#operator-not-eq">operator!=</a>().</p>
<!-- @@@operator== -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$operator<<$$$operator<<QDataStream&constQPen& -->
<h3 class="fn"><a name="operator-lt-lt-174"></a><span class="type"><a href="qdatastream.html">QDataStream</a></span> & <span class="name">operator<<</span> ( <span class="type"><a href="qdatastream.html">QDataStream</a></span> & <i>stream</i>, const <span class="type">QPen</span> & <i>pen</i> )</h3>
<p>Writes the given <i>pen</i> to the given <i>stream</i> and returns a reference to the <i>stream</i>.</p>
<p><b>See also </b><a href="datastreamformat.html">Serializing Qt Data Types</a>.</p>
<!-- @@@operator<< -->
<!-- $$$operator>>$$$operator>>QDataStream&QPen& -->
<h3 class="fn"><a name="operator-gt-gt-97"></a><span class="type"><a href="qdatastream.html">QDataStream</a></span> & <span class="name">operator>></span> ( <span class="type"><a href="qdatastream.html">QDataStream</a></span> & <i>stream</i>, <span class="type">QPen</span> & <i>pen</i> )</h3>
<p>Reads a pen from the given <i>stream</i> into the given <i>pen</i> and returns a reference to the <i>stream</i>.</p>
<p><b>See also </b><a href="datastreamformat.html">Serializing Qt Data Types</a>.</p>
<!-- @@@operator>> -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
