Files
qwt/doc/man/man3/QwtRichTextEngine.3
2023-10-31 09:22:42 +01:00

153 lines
3.7 KiB
Groff

.TH "QwtRichTextEngine" 3 "Sun Jul 18 2021" "Version 6.2.0" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtRichTextEngine \- A text engine for Qt rich texts\&.
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_text_engine\&.h>\fP
.PP
Inherits \fBQwtTextEngine\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBQwtRichTextEngine\fP ()"
.br
.RI "Constructor\&. "
.ti -1c
.RI "virtual double \fBheightForWidth\fP (const QFont &font, int flags, const QString &text, double width) const override"
.br
.ti -1c
.RI "virtual QSizeF \fBtextSize\fP (const QFont &font, int flags, const QString &text) const override"
.br
.ti -1c
.RI "virtual void \fBdraw\fP (QPainter *, const QRectF &rect, int flags, const QString &text) const override"
.br
.ti -1c
.RI "virtual bool \fBmightRender\fP (const QString &) const override"
.br
.ti -1c
.RI "virtual void \fBtextMargins\fP (const QFont &, const QString &, double &left, double &right, double &top, double &bottom) const override"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP
A text engine for Qt rich texts\&.
\fBQwtRichTextEngine\fP renders Qt rich texts using the classes of the Scribe framework of Qt\&.
.PP
Definition at line 147 of file qwt_text_engine\&.h\&.
.SH "Member Function Documentation"
.PP
.SS "void QwtRichTextEngine::draw (QPainter * painter, const QRectF & rect, int flags, const QString & text) const\fC [override]\fP, \fC [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
Implements \fBQwtTextEngine\fP\&.
.PP
Definition at line 305 of file qwt_text_engine\&.cpp\&.
.SS "double QwtRichTextEngine::heightForWidth (const QFont & font, int flags, const QString & text, double width) const\fC [override]\fP, \fC [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
Implements \fBQwtTextEngine\fP\&.
.PP
Definition at line 262 of file qwt_text_engine\&.cpp\&.
.SS "bool QwtRichTextEngine::mightRender (const QString & text) const\fC [override]\fP, \fC [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
Qt::mightBeRichText(text);
.RE
.PP
.PP
Implements \fBQwtTextEngine\fP\&.
.PP
Definition at line 331 of file qwt_text_engine\&.cpp\&.
.SS "void QwtRichTextEngine::textMargins (const QFont &, const QString &, double & left, double & right, double & top, double & bottom) const\fC [override]\fP, \fC [virtual]\fP"
Return margins around the texts
.PP
\fBParameters\fP
.RS 4
\fIleft\fP Return 0
.br
\fIright\fP Return 0
.br
\fItop\fP Return 0
.br
\fIbottom\fP Return 0
.RE
.PP
.PP
Implements \fBQwtTextEngine\fP\&.
.PP
Definition at line 344 of file qwt_text_engine\&.cpp\&.
.SS "QSizeF QwtRichTextEngine::textSize (const QFont & font, int flags, const QString & text) const\fC [override]\fP, \fC [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 used like in QPainter::drawText()
.br
\fItext\fP Text to be rendered
.RE
.PP
\fBReturns\fP
.RS 4
Calculated size
.RE
.PP
.PP
Implements \fBQwtTextEngine\fP\&.
.PP
Definition at line 281 of file qwt_text_engine\&.cpp\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.