~ubuntu-branches/ubuntu/oneiric/qwt/oneiric-proposed

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/html/class_qwt_plain_text_engine.html

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-04-12 23:25:58 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090412232558-3bl06x785yr8xm8u
Tags: 5.1.2-1
* New upstream release.
* Bump compat/debhelper to 7.
* Bump Standards-Version to 3.8.1. No changes needed.
* Invert Maintainers and Uploaders field.
* Fix lintian warnings:
  - dh_clean _k deprecated.
  - missing dependency on libc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
3
<title>Qwt User&apos;s Guide: QwtPlainTextEngine Class Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
<link href="tabs.css" rel="stylesheet" type="text/css">
 
6
</head><body>
 
7
<!-- Generated by Doxygen 1.5.0 -->
 
8
<div class="tabs">
 
9
  <ul>
 
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
 
12
    <li><a href="files.html"><span>Files</span></a></li>
 
13
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
14
  </ul></div>
 
15
<div class="tabs">
 
16
  <ul>
 
17
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
 
18
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
 
19
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
 
20
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
 
21
  </ul></div>
 
22
<h1>QwtPlainTextEngine Class Reference</h1><!-- doxytag: class="QwtPlainTextEngine" --><!-- doxytag: inherits="QwtTextEngine" -->Inheritance diagram for QwtPlainTextEngine:<p><center><img src="class_qwt_plain_text_engine__inherit__graph.png" border="0" usemap="#_qwt_plain_text_engine__inherit__map" alt="Inheritance graph"></center>
 
23
<map name="_qwt_plain_text_engine__inherit__map">
 
24
<area href="class_qwt_text_engine.html" shape="rect" coords="22,8,134,32" alt="">
 
25
</map>
 
26
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for QwtPlainTextEngine:<p><center><img src="class_qwt_plain_text_engine__coll__graph.png" border="0" usemap="#_qwt_plain_text_engine__coll__map" alt="Collaboration graph"></center>
 
27
<map name="_qwt_plain_text_engine__coll__map">
 
28
<area href="class_qwt_text_engine.html" shape="rect" coords="22,8,134,32" alt="">
 
29
</map>
 
30
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="class_qwt_plain_text_engine-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
 
31
A text engine for plain texts. 
 
32
<p>
 
33
<a class="el" href="class_qwt_plain_text_engine.html">QwtPlainTextEngine</a> renders texts using the basic Qt classes QPainter and QFontMetrics. 
 
34
<p>
 
35
 
 
36
<p>
 
37
Definition at line <a class="el" href="qwt__text__engine_8h-source.html#l00116">116</a> of file <a class="el" href="qwt__text__engine_8h-source.html">qwt_text_engine.h</a>.<table border="0" cellpadding="0" cellspacing="0">
 
38
<tr><td></td></tr>
 
39
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 
40
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_plain_text_engine.html#0ad29b2229a879afe49b546704eb7079">QwtPlainTextEngine</a> ()</td></tr>
 
41
 
 
42
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_plain_text_engine.html#0ada8796b2caaff7bb8d61e9fb1b5143">~QwtPlainTextEngine</a> ()</td></tr>
 
43
 
 
44
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_plain_text_engine.html#b281901f7e58db3446a46674857eaad8">heightForWidth</a> (const QFont &amp;font, int flags, const QString &amp;text, int width) const</td></tr>
 
45
 
 
46
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QSize&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_plain_text_engine.html#e1a0f30b4496fb275648ef1abe4287b3">textSize</a> (const QFont &amp;font, int flags, const QString &amp;text) const</td></tr>
 
47
 
 
48
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_plain_text_engine.html#4af4c1239dd5146fa633baebe110cf81">draw</a> (QPainter *painter, const QRect &amp;rect, int flags, const QString &amp;text) const</td></tr>
 
49
 
 
50
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_plain_text_engine.html#d210b32f1218447fcff3dafafd0a9fb9">mightRender</a> (const QString &amp;) const</td></tr>
 
51
 
 
52
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_plain_text_engine.html#4bb9a3cb6c1ff17450113e0d5b996a7c">textMargins</a> (const QFont &amp;, const QString &amp;, int &amp;left, int &amp;right, int &amp;top, int &amp;bottom) const</td></tr>
 
53
 
 
54
</table>
 
55
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
56
<a class="anchor" name="0ad29b2229a879afe49b546704eb7079"></a><!-- doxytag: member="QwtPlainTextEngine::QwtPlainTextEngine" ref="0ad29b2229a879afe49b546704eb7079" args="()" -->
 
57
<div class="memitem">
 
58
<div class="memproto">
 
59
      <table class="memname">
 
60
        <tr>
 
61
          <td class="memname">QwtPlainTextEngine::QwtPlainTextEngine           </td>
 
62
          <td>(</td>
 
63
          <td class="paramname">          </td>
 
64
          <td>&nbsp;)&nbsp;</td>
 
65
          <td width="100%"></td>
 
66
        </tr>
 
67
      </table>
 
68
</div>
 
69
<div class="memdoc">
 
70
 
 
71
<p>
 
72
Constructor. 
 
73
<p>
 
74
 
 
75
<p>
 
76
Definition at line <a class="el" href="qwt__text__engine_8cpp-source.html#l00180">180</a> of file <a class="el" href="qwt__text__engine_8cpp-source.html">qwt_text_engine.cpp</a>.
 
77
</div>
 
78
</div><p>
 
79
<a class="anchor" name="0ada8796b2caaff7bb8d61e9fb1b5143"></a><!-- doxytag: member="QwtPlainTextEngine::~QwtPlainTextEngine" ref="0ada8796b2caaff7bb8d61e9fb1b5143" args="()" -->
 
80
<div class="memitem">
 
81
<div class="memproto">
 
82
      <table class="memname">
 
83
        <tr>
 
84
          <td class="memname">QwtPlainTextEngine::~QwtPlainTextEngine           </td>
 
85
          <td>(</td>
 
86
          <td class="paramname">          </td>
 
87
          <td>&nbsp;)&nbsp;</td>
 
88
          <td width="100%"><code> [virtual]</code></td>
 
89
        </tr>
 
90
      </table>
 
91
</div>
 
92
<div class="memdoc">
 
93
 
 
94
<p>
 
95
Destructor. 
 
96
<p>
 
97
 
 
98
<p>
 
99
Definition at line <a class="el" href="qwt__text__engine_8cpp-source.html#l00186">186</a> of file <a class="el" href="qwt__text__engine_8cpp-source.html">qwt_text_engine.cpp</a>.
 
100
</div>
 
101
</div><p>
 
102
<hr><h2>Member Function Documentation</h2>
 
103
<a class="anchor" name="b281901f7e58db3446a46674857eaad8"></a><!-- doxytag: member="QwtPlainTextEngine::heightForWidth" ref="b281901f7e58db3446a46674857eaad8" args="(const QFont &amp;font, int flags, const QString &amp;text, int width) const" -->
 
104
<div class="memitem">
 
105
<div class="memproto">
 
106
      <table class="memname">
 
107
        <tr>
 
108
          <td class="memname">int QwtPlainTextEngine::heightForWidth           </td>
 
109
          <td>(</td>
 
110
          <td class="paramtype">const QFont &amp;&nbsp;</td>
 
111
          <td class="paramname"> <em>font</em>, </td>
 
112
        </tr>
 
113
        <tr>
 
114
          <td class="paramkey"></td>
 
115
          <td></td>
 
116
          <td class="paramtype">int&nbsp;</td>
 
117
          <td class="paramname"> <em>flags</em>, </td>
 
118
        </tr>
 
119
        <tr>
 
120
          <td class="paramkey"></td>
 
121
          <td></td>
 
122
          <td class="paramtype">const QString &amp;&nbsp;</td>
 
123
          <td class="paramname"> <em>text</em>, </td>
 
124
        </tr>
 
125
        <tr>
 
126
          <td class="paramkey"></td>
 
127
          <td></td>
 
128
          <td class="paramtype">int&nbsp;</td>
 
129
          <td class="paramname"> <em>width</em></td><td>&nbsp;</td>
 
130
        </tr>
 
131
        <tr>
 
132
          <td></td>
 
133
          <td>)</td>
 
134
          <td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
 
135
        </tr>
 
136
      </table>
 
137
</div>
 
138
<div class="memdoc">
 
139
 
 
140
<p>
 
141
Find the height for a given width<p>
 
142
<dl compact><dt><b>Parameters:</b></dt><dd>
 
143
  <table border="0" cellspacing="2" cellpadding="0">
 
144
    <tr><td valign="top"></td><td valign="top"><em>font</em>&nbsp;</td><td>Font of the text </td></tr>
 
145
    <tr><td valign="top"></td><td valign="top"><em>flags</em>&nbsp;</td><td>Bitwise OR of the flags used like in QPainter::drawText </td></tr>
 
146
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>Text to be rendered </td></tr>
 
147
    <tr><td valign="top"></td><td valign="top"><em>width</em>&nbsp;</td><td>Width</td></tr>
 
148
  </table>
 
149
</dl>
 
150
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Calculated height </dd></dl>
 
151
 
 
152
<p>
 
153
Implements <a class="el" href="class_qwt_text_engine.html#7bbf807eeb2b741587054b194776af8a">QwtTextEngine</a>.
 
154
<p>
 
155
Definition at line <a class="el" href="qwt__text__engine_8cpp-source.html#l00201">201</a> of file <a class="el" href="qwt__text__engine_8cpp-source.html">qwt_text_engine.cpp</a>.
 
156
</div>
 
157
</div><p>
 
158
<a class="anchor" name="e1a0f30b4496fb275648ef1abe4287b3"></a><!-- doxytag: member="QwtPlainTextEngine::textSize" ref="e1a0f30b4496fb275648ef1abe4287b3" args="(const QFont &amp;font, int flags, const QString &amp;text) const" -->
 
159
<div class="memitem">
 
160
<div class="memproto">
 
161
      <table class="memname">
 
162
        <tr>
 
163
          <td class="memname">QSize QwtPlainTextEngine::textSize           </td>
 
164
          <td>(</td>
 
165
          <td class="paramtype">const QFont &amp;&nbsp;</td>
 
166
          <td class="paramname"> <em>font</em>, </td>
 
167
        </tr>
 
168
        <tr>
 
169
          <td class="paramkey"></td>
 
170
          <td></td>
 
171
          <td class="paramtype">int&nbsp;</td>
 
172
          <td class="paramname"> <em>flags</em>, </td>
 
173
        </tr>
 
174
        <tr>
 
175
          <td class="paramkey"></td>
 
176
          <td></td>
 
177
          <td class="paramtype">const QString &amp;&nbsp;</td>
 
178
          <td class="paramname"> <em>text</em></td><td>&nbsp;</td>
 
179
        </tr>
 
180
        <tr>
 
181
          <td></td>
 
182
          <td>)</td>
 
183
          <td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
 
184
        </tr>
 
185
      </table>
 
186
</div>
 
187
<div class="memdoc">
 
188
 
 
189
<p>
 
190
Returns the size, that is needed to render text<p>
 
191
<dl compact><dt><b>Parameters:</b></dt><dd>
 
192
  <table border="0" cellspacing="2" cellpadding="0">
 
193
    <tr><td valign="top"></td><td valign="top"><em>font</em>&nbsp;</td><td>Font of the text </td></tr>
 
194
    <tr><td valign="top"></td><td valign="top"><em>flags</em>&nbsp;</td><td>Bitwise OR of the flags used like in QPainter::drawText </td></tr>
 
195
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>Text to be rendered</td></tr>
 
196
  </table>
 
197
</dl>
 
198
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Caluclated size </dd></dl>
 
199
 
 
200
<p>
 
201
Implements <a class="el" href="class_qwt_text_engine.html#9998036ccfade5f82a5077e1ea9d86f0">QwtTextEngine</a>.
 
202
<p>
 
203
Definition at line <a class="el" href="qwt__text__engine_8cpp-source.html#l00220">220</a> of file <a class="el" href="qwt__text__engine_8cpp-source.html">qwt_text_engine.cpp</a>.
 
204
</div>
 
205
</div><p>
 
206
<a class="anchor" name="4af4c1239dd5146fa633baebe110cf81"></a><!-- doxytag: member="QwtPlainTextEngine::draw" ref="4af4c1239dd5146fa633baebe110cf81" args="(QPainter *painter, const QRect &amp;rect, int flags, const QString &amp;text) const" -->
 
207
<div class="memitem">
 
208
<div class="memproto">
 
209
      <table class="memname">
 
210
        <tr>
 
211
          <td class="memname">void QwtPlainTextEngine::draw           </td>
 
212
          <td>(</td>
 
213
          <td class="paramtype">QPainter *&nbsp;</td>
 
214
          <td class="paramname"> <em>painter</em>, </td>
 
215
        </tr>
 
216
        <tr>
 
217
          <td class="paramkey"></td>
 
218
          <td></td>
 
219
          <td class="paramtype">const QRect &amp;&nbsp;</td>
 
220
          <td class="paramname"> <em>rect</em>, </td>
 
221
        </tr>
 
222
        <tr>
 
223
          <td class="paramkey"></td>
 
224
          <td></td>
 
225
          <td class="paramtype">int&nbsp;</td>
 
226
          <td class="paramname"> <em>flags</em>, </td>
 
227
        </tr>
 
228
        <tr>
 
229
          <td class="paramkey"></td>
 
230
          <td></td>
 
231
          <td class="paramtype">const QString &amp;&nbsp;</td>
 
232
          <td class="paramname"> <em>text</em></td><td>&nbsp;</td>
 
233
        </tr>
 
234
        <tr>
 
235
          <td></td>
 
236
          <td>)</td>
 
237
          <td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
 
238
        </tr>
 
239
      </table>
 
240
</div>
 
241
<div class="memdoc">
 
242
 
 
243
<p>
 
244
Draw the text in a clipping rectangle. 
 
245
<p>
 
246
A wrapper for QPainter::drawText.<p>
 
247
<dl compact><dt><b>Parameters:</b></dt><dd>
 
248
  <table border="0" cellspacing="2" cellpadding="0">
 
249
    <tr><td valign="top"></td><td valign="top"><em>painter</em>&nbsp;</td><td>Painter </td></tr>
 
250
    <tr><td valign="top"></td><td valign="top"><em>rect</em>&nbsp;</td><td>Clipping rectangle </td></tr>
 
251
    <tr><td valign="top"></td><td valign="top"><em>flags</em>&nbsp;</td><td>Bitwise OR of the flags used like in QPainter::drawText </td></tr>
 
252
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>Text to be rendered </td></tr>
 
253
  </table>
 
254
</dl>
 
255
 
 
256
<p>
 
257
Implements <a class="el" href="class_qwt_text_engine.html#f889288bbeb2076795f8d86add8ca01f">QwtTextEngine</a>.
 
258
<p>
 
259
Definition at line <a class="el" href="qwt__text__engine_8cpp-source.html#l00259">259</a> of file <a class="el" href="qwt__text__engine_8cpp-source.html">qwt_text_engine.cpp</a>.
 
260
<p>
 
261
References <a class="el" href="qwt__painter_8cpp-source.html#l00310">QwtPainter::drawText()</a>.
 
262
</div>
 
263
</div><p>
 
264
<a class="anchor" name="d210b32f1218447fcff3dafafd0a9fb9"></a><!-- doxytag: member="QwtPlainTextEngine::mightRender" ref="d210b32f1218447fcff3dafafd0a9fb9" args="(const QString &amp;) const" -->
 
265
<div class="memitem">
 
266
<div class="memproto">
 
267
      <table class="memname">
 
268
        <tr>
 
269
          <td class="memname">bool QwtPlainTextEngine::mightRender           </td>
 
270
          <td>(</td>
 
271
          <td class="paramtype">const QString &amp;&nbsp;</td>
 
272
          <td class="paramname">          </td>
 
273
          <td>&nbsp;)&nbsp;</td>
 
274
          <td width="100%"> const<code> [virtual]</code></td>
 
275
        </tr>
 
276
      </table>
 
277
</div>
 
278
<div class="memdoc">
 
279
 
 
280
<p>
 
281
Test if a string can be rendered by this text engine. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Always true. All texts can be rendered by <a class="el" href="class_qwt_plain_text_engine.html">QwtPlainTextEngine</a> </dd></dl>
 
282
 
 
283
<p>
 
284
Implements <a class="el" href="class_qwt_text_engine.html#98316f2f6f4f50216ceffbe9babe2901">QwtTextEngine</a>.
 
285
<p>
 
286
Definition at line <a class="el" href="qwt__text__engine_8cpp-source.html#l00269">269</a> of file <a class="el" href="qwt__text__engine_8cpp-source.html">qwt_text_engine.cpp</a>.
 
287
</div>
 
288
</div><p>
 
289
<a class="anchor" name="4bb9a3cb6c1ff17450113e0d5b996a7c"></a><!-- doxytag: member="QwtPlainTextEngine::textMargins" ref="4bb9a3cb6c1ff17450113e0d5b996a7c" args="(const QFont &amp;, const QString &amp;, int &amp;left, int &amp;right, int &amp;top, int &amp;bottom) const" -->
 
290
<div class="memitem">
 
291
<div class="memproto">
 
292
      <table class="memname">
 
293
        <tr>
 
294
          <td class="memname">void QwtPlainTextEngine::textMargins           </td>
 
295
          <td>(</td>
 
296
          <td class="paramtype">const QFont &amp;&nbsp;</td>
 
297
          <td class="paramname"> <em>font</em>, </td>
 
298
        </tr>
 
299
        <tr>
 
300
          <td class="paramkey"></td>
 
301
          <td></td>
 
302
          <td class="paramtype">const QString &amp;&nbsp;</td>
 
303
          <td class="paramname">, </td>
 
304
        </tr>
 
305
        <tr>
 
306
          <td class="paramkey"></td>
 
307
          <td></td>
 
308
          <td class="paramtype">int &amp;&nbsp;</td>
 
309
          <td class="paramname"> <em>left</em>, </td>
 
310
        </tr>
 
311
        <tr>
 
312
          <td class="paramkey"></td>
 
313
          <td></td>
 
314
          <td class="paramtype">int &amp;&nbsp;</td>
 
315
          <td class="paramname"> <em>right</em>, </td>
 
316
        </tr>
 
317
        <tr>
 
318
          <td class="paramkey"></td>
 
319
          <td></td>
 
320
          <td class="paramtype">int &amp;&nbsp;</td>
 
321
          <td class="paramname"> <em>top</em>, </td>
 
322
        </tr>
 
323
        <tr>
 
324
          <td class="paramkey"></td>
 
325
          <td></td>
 
326
          <td class="paramtype">int &amp;&nbsp;</td>
 
327
          <td class="paramname"> <em>bottom</em></td><td>&nbsp;</td>
 
328
        </tr>
 
329
        <tr>
 
330
          <td></td>
 
331
          <td>)</td>
 
332
          <td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
 
333
        </tr>
 
334
      </table>
 
335
</div>
 
336
<div class="memdoc">
 
337
 
 
338
<p>
 
339
Return margins around the texts<p>
 
340
<dl compact><dt><b>Parameters:</b></dt><dd>
 
341
  <table border="0" cellspacing="2" cellpadding="0">
 
342
    <tr><td valign="top"></td><td valign="top"><em>font</em>&nbsp;</td><td>Font of the text </td></tr>
 
343
    <tr><td valign="top"></td><td valign="top"><em>left</em>&nbsp;</td><td>Return 0 </td></tr>
 
344
    <tr><td valign="top"></td><td valign="top"><em>right</em>&nbsp;</td><td>Return 0 </td></tr>
 
345
    <tr><td valign="top"></td><td valign="top"><em>top</em>&nbsp;</td><td>Return value for the top margin </td></tr>
 
346
    <tr><td valign="top"></td><td valign="top"><em>bottom</em>&nbsp;</td><td>Return value for the bottom margin </td></tr>
 
347
  </table>
 
348
</dl>
 
349
 
 
350
<p>
 
351
Implements <a class="el" href="class_qwt_text_engine.html#d84ebda640e65f23ebd758cd545a5b9a">QwtTextEngine</a>.
 
352
<p>
 
353
Definition at line <a class="el" href="qwt__text__engine_8cpp-source.html#l00239">239</a> of file <a class="el" href="qwt__text__engine_8cpp-source.html">qwt_text_engine.cpp</a>.
 
354
</div>
 
355
</div><p>
 
356
<hr size="1"><address style="align: right;"><small>Generated on Sun Mar 22 16:54:53 2009 for Qwt User's Guide by&nbsp;
 
357
<a href="http://www.doxygen.org/index.html">
 
358
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
 
359
</body>
 
360
</html>