123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162 |
- .TH "QwtTextEngine" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
- .ad l
- .nh
- .SH NAME
- QwtTextEngine \- Abstract base class for rendering text strings\&.
- .SH SYNOPSIS
- .br
- .PP
- .PP
- \fC#include <qwt_text_engine\&.h>\fP
- .PP
- Inherited by \fBQwtMathMLTextEngine\fP, \fBQwtPlainTextEngine\fP, and \fBQwtRichTextEngine\fP\&.
- .SS "Public Member Functions"
- .in +1c
- .ti -1c
- .RI "virtual \fB~QwtTextEngine\fP ()"
- .br
- .RI "Destructor\&. "
- .ti -1c
- .RI "virtual double \fBheightForWidth\fP (const QFont &font, int flags, const QString &text, double width) const =0"
- .br
- .ti -1c
- .RI "virtual QSizeF \fBtextSize\fP (const QFont &font, int flags, const QString &text) const =0"
- .br
- .ti -1c
- .RI "virtual bool \fBmightRender\fP (const QString &text) const =0"
- .br
- .ti -1c
- .RI "virtual void \fBtextMargins\fP (const QFont &font, const QString &text, double &left, double &right, double &top, double &bottom) const =0"
- .br
- .ti -1c
- .RI "virtual void \fBdraw\fP (QPainter *painter, const QRectF &rect, int flags, const QString &text) const =0"
- .br
- .in -1c
- .SS "Protected Member Functions"
- .in +1c
- .ti -1c
- .RI "\fBQwtTextEngine\fP ()"
- .br
- .RI "Constructor\&. "
- .in -1c
- .SH "Detailed Description"
- .PP
- Abstract base class for rendering text strings\&.
- A text engine is responsible for rendering texts for a specific text format\&. They are used by \fBQwtText\fP to render a text\&.
- .PP
- \fBQwtPlainTextEngine\fP and \fBQwtRichTextEngine\fP are part of the Qwt library\&. The implementation of \fBQwtMathMLTextEngine\fP uses code from the Qt solution package\&. Because of license implications it is built into a separate library\&.
- .PP
- \fBSee also\fP
- .RS 4
- \fBQwtText::setTextEngine()\fP
- .RE
- .PP
- .SH "Member Function Documentation"
- .PP
- .SS "virtual void QwtTextEngine::draw (QPainter * painter, const QRectF & rect, int flags, const QString & text) const\fC [pure virtual]\fP"
- Draw the text in a clipping rectangle
- .PP
- \fBParameters\fP
- .RS 4
- \fIpainter\fP Painter
- .br
- \fIrect\fP Clipping rectangle
- .br
- \fIflags\fP Bitwise OR of the flags like in for QPainter::drawText()
- .br
- \fItext\fP Text to be rendered
- .RE
- .PP
- .PP
- Implemented in \fBQwtMathMLTextEngine\fP, \fBQwtRichTextEngine\fP, and \fBQwtPlainTextEngine\fP\&.
- .SS "virtual double QwtTextEngine::heightForWidth (const QFont & font, int flags, const QString & text, double width) const\fC [pure virtual]\fP"
- Find the height for a given width
- .PP
- \fBParameters\fP
- .RS 4
- \fIfont\fP Font of the text
- .br
- \fIflags\fP Bitwise OR of the flags used like in QPainter::drawText
- .br
- \fItext\fP Text to be rendered
- .br
- \fIwidth\fP Width
- .RE
- .PP
- \fBReturns\fP
- .RS 4
- Calculated height
- .RE
- .PP
- .PP
- Implemented in \fBQwtMathMLTextEngine\fP, \fBQwtRichTextEngine\fP, and \fBQwtPlainTextEngine\fP\&.
- .SS "virtual bool QwtTextEngine::mightRender (const QString & text) const\fC [pure virtual]\fP"
- Test if a string can be rendered by this text engine
- .PP
- \fBParameters\fP
- .RS 4
- \fItext\fP Text to be tested
- .RE
- .PP
- \fBReturns\fP
- .RS 4
- true, if it can be rendered
- .RE
- .PP
- .PP
- Implemented in \fBQwtMathMLTextEngine\fP, \fBQwtRichTextEngine\fP, and \fBQwtPlainTextEngine\fP\&.
- .SS "virtual void QwtTextEngine::textMargins (const QFont & font, const QString & text, double & left, double & right, double & top, double & bottom) const\fC [pure virtual]\fP"
- Return margins around the texts
- .PP
- The textSize might include margins around the text, like QFontMetrics::descent()\&. In situations where texts need to be aligned in detail, knowing these margins might improve the layout calculations\&.
- .PP
- \fBParameters\fP
- .RS 4
- \fIfont\fP Font of the text
- .br
- \fItext\fP Text to be rendered
- .br
- \fIleft\fP Return value for the left margin
- .br
- \fIright\fP Return value for the right margin
- .br
- \fItop\fP Return value for the top margin
- .br
- \fIbottom\fP Return value for the bottom margin
- .RE
- .PP
- .PP
- Implemented in \fBQwtMathMLTextEngine\fP, \fBQwtRichTextEngine\fP, and \fBQwtPlainTextEngine\fP\&.
- .SS "virtual QSizeF QwtTextEngine::textSize (const QFont & font, int flags, const QString & text) const\fC [pure virtual]\fP"
- Returns the size, that is needed to render text
- .PP
- \fBParameters\fP
- .RS 4
- \fIfont\fP Font of the text
- .br
- \fIflags\fP Bitwise OR of the flags like in for QPainter::drawText
- .br
- \fItext\fP Text to be rendered
- .RE
- .PP
- \fBReturns\fP
- .RS 4
- Calculated size
- .RE
- .PP
- .PP
- Implemented in \fBQwtMathMLTextEngine\fP, \fBQwtRichTextEngine\fP, and \fBQwtPlainTextEngine\fP\&.
- .SH "Author"
- .PP
- Generated automatically by Doxygen for Qwt User's Guide from the source code\&.
|