← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.1.1/doc/man/man3/QwtMathMLTextEngine.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2008-05-26 10:26:31 UTC
  • mfrom: (1.1.3 upstream) (2.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080526102631-bp95mfccnrb957nx
Tags: 5.1.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.1/doc/man/man3/QwtMathMLTextEngine.3
 
1
.TH "QwtMathMLTextEngine" 3 "24 May 2008" "Version 5.1.1" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtMathMLTextEngine \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherits \fBQwtTextEngine\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
Text Engine for the MathML renderer of the Qt solutions package. 
 
14
 
 
15
The Qt Solution package includes a renderer for MathML http://www.trolltech.com/products/qt/addon/solutions/catalog/4/Widgets/qtmmlwidget that is available for owners of a commercial Qt license. You need a version >= 2.1, that is only available for Qt4.
 
16
.PP
 
17
To enable MathML support the following code needs to be added to the application: 
 
18
.PP
 
19
.nf
 
20
 
 
21
#include <qwt_mathml_text_engine.h>
 
22
 
 
23
QwtText::setTextEngine(QwtText::MathMLText, new QwtMathMLTextEngine());
 
24
  
 
25
.fi
 
26
.PP
 
27
.PP
 
28
\fBSee also:\fP
 
29
.RS 4
 
30
\fBQwtTextEngine\fP, \fBQwtText::setTextEngine\fP 
 
31
.RE
 
32
.PP
 
33
\fBWarning:\fP
 
34
.RS 4
 
35
Unfortunately the MathML renderer doesn't support rotating of texts. 
 
36
.RE
 
37
.PP
 
38
 
 
39
.PP
 
40
Definition at line 39 of file qwt_mathml_text_engine.h.
 
41
.SS "Public Member Functions"
 
42
 
 
43
.in +1c
 
44
.ti -1c
 
45
.RI "\fBQwtMathMLTextEngine\fP ()"
 
46
.br
 
47
.ti -1c
 
48
.RI "virtual \fB~QwtMathMLTextEngine\fP ()"
 
49
.br
 
50
.ti -1c
 
51
.RI "virtual int \fBheightForWidth\fP (const QFont &font, int flags, const QString &text, int width) const"
 
52
.br
 
53
.ti -1c
 
54
.RI "virtual QSize \fBtextSize\fP (const QFont &font, int flags, const QString &text) const"
 
55
.br
 
56
.ti -1c
 
57
.RI "virtual void \fBdraw\fP (QPainter *painter, const QRect &rect, int flags, const QString &text) const"
 
58
.br
 
59
.ti -1c
 
60
.RI "virtual bool \fBmightRender\fP (const QString &) const"
 
61
.br
 
62
.ti -1c
 
63
.RI "virtual void \fBtextMargins\fP (const QFont &, const QString &, int &left, int &right, int &top, int &bottom) const"
 
64
.br
 
65
.in -1c
 
66
.SH "Constructor & Destructor Documentation"
 
67
.PP 
 
68
.SS "QwtMathMLTextEngine::QwtMathMLTextEngine ()"
 
69
.PP
 
70
Constructor. 
 
71
.PP
 
72
Definition at line 22 of file qwt_mathml_text_engine.cpp.
 
73
.SS "QwtMathMLTextEngine::~QwtMathMLTextEngine ()\fC [virtual]\fP"
 
74
.PP
 
75
Destructor. 
 
76
.PP
 
77
Definition at line 27 of file qwt_mathml_text_engine.cpp.
 
78
.SH "Member Function Documentation"
 
79
.PP 
 
80
.SS "int QwtMathMLTextEngine::heightForWidth (const QFont & font, int flags, const QString & text, int width) const\fC [virtual]\fP"
 
81
.PP
 
82
Find the height for a given width
 
83
.PP
 
84
\fBParameters:\fP
 
85
.RS 4
 
86
\fIfont\fP Font of the text 
 
87
.br
 
88
\fIflags\fP Bitwise OR of the flags used like in QPainter::drawText 
 
89
.br
 
90
\fItext\fP Text to be rendered 
 
91
.br
 
92
\fIwidth\fP Width
 
93
.RE
 
94
.PP
 
95
\fBReturns:\fP
 
96
.RS 4
 
97
Calculated height 
 
98
.RE
 
99
.PP
 
100
 
 
101
.PP
 
102
Implements \fBQwtTextEngine\fP.
 
103
.PP
 
104
Definition at line 41 of file qwt_mathml_text_engine.cpp.
 
105
.PP
 
106
References textSize().
 
107
.SS "QSize QwtMathMLTextEngine::textSize (const QFont & font, int flags, const QString & text) const\fC [virtual]\fP"
 
108
.PP
 
109
Returns the size, that is needed to render text
 
110
.PP
 
111
\fBParameters:\fP
 
112
.RS 4
 
113
\fIfont\fP Font of the text 
 
114
.br
 
115
\fIflags\fP Bitwise OR of the flags used like in QPainter::drawText 
 
116
.br
 
117
\fItext\fP Text to be rendered
 
118
.RE
 
119
.PP
 
120
\fBReturns:\fP
 
121
.RS 4
 
122
Caluclated size 
 
123
.RE
 
124
.PP
 
125
 
 
126
.PP
 
127
Implements \fBQwtTextEngine\fP.
 
128
.PP
 
129
Definition at line 56 of file qwt_mathml_text_engine.cpp.
 
130
.PP
 
131
Referenced by heightForWidth().
 
132
.SS "void QwtMathMLTextEngine::draw (QPainter * painter, const QRect & rect, int flags, const QString & text) const\fC [virtual]\fP"
 
133
.PP
 
134
Draw the text in a clipping rectangle
 
135
.PP
 
136
\fBParameters:\fP
 
137
.RS 4
 
138
\fIpainter\fP Painter 
 
139
.br
 
140
\fIrect\fP Clipping rectangle 
 
141
.br
 
142
\fIflags\fP Bitwise OR of the flags like in for QPainter::drawText 
 
143
.br
 
144
\fItext\fP Text to be rendered 
 
145
.RE
 
146
.PP
 
147
 
 
148
.PP
 
149
Implements \fBQwtTextEngine\fP.
 
150
.PP
 
151
Definition at line 97 of file qwt_mathml_text_engine.cpp.
 
152
.SS "bool QwtMathMLTextEngine::mightRender (const QString & text) const\fC [virtual]\fP"
 
153
.PP
 
154
Test if a string can be rendered by \fBQwtMathMLTextEngine\fP
 
155
.PP
 
156
\fBParameters:\fP
 
157
.RS 4
 
158
\fItext\fP Text to be tested 
 
159
.RE
 
160
.PP
 
161
\fBReturns:\fP
 
162
.RS 4
 
163
true, if text begins with '<math>'. 
 
164
.RE
 
165
.PP
 
166
 
 
167
.PP
 
168
Implements \fBQwtTextEngine\fP.
 
169
.PP
 
170
Definition at line 131 of file qwt_mathml_text_engine.cpp.
 
171
.SS "void QwtMathMLTextEngine::textMargins (const QFont &, const QString &, int & left, int & right, int & top, int & bottom) const\fC [virtual]\fP"
 
172
.PP
 
173
Return margins around the texts
 
174
.PP
 
175
\fBParameters:\fP
 
176
.RS 4
 
177
\fIleft\fP Return 0 
 
178
.br
 
179
\fIright\fP Return 0 
 
180
.br
 
181
\fItop\fP Return 0 
 
182
.br
 
183
\fIbottom\fP Return 0 
 
184
.RE
 
185
.PP
 
186
 
 
187
.PP
 
188
Implements \fBQwtTextEngine\fP.
 
189
.PP
 
190
Definition at line 83 of file qwt_mathml_text_engine.cpp.
 
191
 
 
192
.SH "Author"
 
193
.PP 
 
194
Generated automatically by Doxygen for Qwt User's Guide from the source code.