diff options
Diffstat (limited to 'doc/man/man3/tqsimplerichtext.3qt')
| -rw-r--r-- | doc/man/man3/tqsimplerichtext.3qt | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/man/man3/tqsimplerichtext.3qt b/doc/man/man3/tqsimplerichtext.3qt index 6ce135764..30e1fc782 100644 --- a/doc/man/man3/tqsimplerichtext.3qt +++ b/doc/man/man3/tqsimplerichtext.3qt @@ -14,10 +14,10 @@ QSimpleRichText \- Small displayable piece of rich text .SS "Public Members" .in +1c .ti -1c -.BI "\fBQSimpleRichText\fR ( const TQString & text, const QFont & fnt, const TQString & context = TQString::null, const TQStyleSheet * sheet = 0 )" +.BI "\fBQSimpleRichText\fR ( const TQString & text, const TQFont & fnt, const TQString & context = TQString::null, const TQStyleSheet * sheet = 0 )" .br .ti -1c -.BI "\fBQSimpleRichText\fR ( const TQString & text, const QFont & fnt, const TQString & context, const TQStyleSheet * sheet, const TQMimeSourceFactory * factory, int pageBreak = -1, const TQColor & linkColor = TQt::blue, bool linkUnderline = TRUE )" +.BI "\fBQSimpleRichText\fR ( const TQString & text, const TQFont & fnt, const TQString & context, const TQStyleSheet * sheet, const TQMimeSourceFactory * factory, int pageBreak = -1, const TQColor & linkColor = TQt::blue, bool linkUnderline = TRUE )" .br .ti -1c .BI "\fB~QSimpleRichText\fR ()" @@ -26,10 +26,10 @@ QSimpleRichText \- Small displayable piece of rich text .BI "void \fBsetWidth\fR ( int w )" .br .ti -1c -.BI "void \fBsetWidth\fR ( QPainter * p, int w )" +.BI "void \fBsetWidth\fR ( TQPainter * p, int w )" .br .ti -1c -.BI "void \fBsetDefaultFont\fR ( const QFont & f )" +.BI "void \fBsetDefaultFont\fR ( const TQFont & f )" .br .ti -1c .BI "int \fBwidth\fR () const" @@ -44,10 +44,10 @@ QSimpleRichText \- Small displayable piece of rich text .BI "void \fBadjustSize\fR ()" .br .ti -1c -.BI "void \fBdraw\fR ( QPainter * p, int x, int y, const QRect & clipRect, const QColorGroup & cg, const QBrush * paper = 0 ) const" +.BI "void \fBdraw\fR ( TQPainter * p, int x, int y, const QRect & clipRect, const TQColorGroup & cg, const TQBrush * paper = 0 ) const" .br .ti -1c -.BI "void draw ( QPainter * p, int x, int y, const QRegion & clipRegion, const QColorGroup & cg, const QBrush * paper = 0 ) const \fI(obsolete)\fR" +.BI "void draw ( TQPainter * p, int x, int y, const QRegion & clipRegion, const TQColorGroup & cg, const TQBrush * paper = 0 ) const \fI(obsolete)\fR" .br .ti -1c .BI "TQString \fBcontext\fR () const" @@ -64,17 +64,17 @@ The QSimpleRichText class provides a small displayable piece of rich text. .PP This class encapsulates simple rich text usage in which a string is interpreted as rich text and can be drawn. This is particularly useful if you want to display some rich text in a custom widget. A TQStyleSheet is needed to interpret the tags and format the rich text. TQt provides a default HTML-like style sheet, but you may define custom style sheets. .PP -Once created, the rich text object can be queried for its width(), height(), and the actual width used (see widthUsed()). Most importantly, it can be drawn on any given QPainter with draw(). QSimpleRichText can also be used to implement hypertext or active text facilities by using anchorAt(). A hit test through inText() makes it possible to use simple rich text for text objects in editable drawing canvases. +Once created, the rich text object can be queried for its width(), height(), and the actual width used (see widthUsed()). Most importantly, it can be drawn on any given TQPainter with draw(). QSimpleRichText can also be used to implement hypertext or active text facilities by using anchorAt(). A hit test through inText() makes it possible to use simple rich text for text objects in editable drawing canvases. .PP Once constructed from a string the contents cannot be changed, only resized. If the contents change, just throw the rich text object away and make a new one with the new contents. .PP For large documents use TQTextEdit or TQTextBrowser. For very small items of rich text you can use a QLabel. .PP -If you are using QSimpleRichText to print in high resolution you should call setWidth(QPainter, int) so that the content will be laid out properly on the page. +If you are using QSimpleRichText to print in high resolution you should call setWidth(TQPainter, int) so that the content will be laid out properly on the page. .PP See also Text Related Classes. .SH MEMBER FUNCTION DOCUMENTATION -.SH "QSimpleRichText::QSimpleRichText ( const TQString & text, const QFont & fnt, const TQString & context = TQString::null, const TQStyleSheet * sheet = 0 )" +.SH "QSimpleRichText::QSimpleRichText ( const TQString & text, const TQFont & fnt, const TQString & context = TQString::null, const TQStyleSheet * sheet = 0 )" Constructs a QSimpleRichText from the rich text string \fItext\fR and the font \fIfnt\fR. .PP The font is used as a basis for the text rendering. When using rich text rendering on a widget \fIw\fR, you would normally specify the widget's font, for example: @@ -88,10 +88,10 @@ The font is used as a basis for the text rendering. When using rich text renderi \fIcontext\fR is the optional context of the rich text object. This becomes important if \fItext\fR contains relative references, for example within image tags. QSimpleRichText always uses the default mime source factory (see TQMimeSourceFactory::defaultFactory()) to resolve those references. The context will then be used to calculate the absolute path. See TQMimeSourceFactory::makeAbsolute() for details. .PP The \fIsheet\fR is an optional style sheet. If it is 0, the default style sheet will be used (see TQStyleSheet::defaultSheet()). -.SH "QSimpleRichText::QSimpleRichText ( const TQString & text, const QFont & fnt, const TQString & context, const TQStyleSheet * sheet, const TQMimeSourceFactory * factory, int pageBreak = -1, const TQColor & linkColor = TQt::blue, bool linkUnderline = TRUE )" +.SH "QSimpleRichText::QSimpleRichText ( const TQString & text, const TQFont & fnt, const TQString & context, const TQStyleSheet * sheet, const TQMimeSourceFactory * factory, int pageBreak = -1, const TQColor & linkColor = TQt::blue, bool linkUnderline = TRUE )" Constructs a QSimpleRichText from the rich text string \fItext\fR and the font \fIfnt\fR. .PP -This is a slightly more complex constructor for QSimpleRichText that takes an additional mime source factory \fIfactory\fR, a page break parameter \fIpageBreak\fR and a bool \fIlinkUnderline\fR. \fIlinkColor\fR is only provided for compatibility, but has no effect, as QColorGroup's QColorGroup::link() color is used now. +This is a slightly more complex constructor for QSimpleRichText that takes an additional mime source factory \fIfactory\fR, a page break parameter \fIpageBreak\fR and a bool \fIlinkUnderline\fR. \fIlinkColor\fR is only provided for compatibility, but has no effect, as TQColorGroup's TQColorGroup::link() color is used now. .PP \fIcontext\fR is the optional context of the rich text object. This becomes important if \fItext\fR contains relative references, for example within image tags. QSimpleRichText always uses the default mime source factory (see TQMimeSourceFactory::defaultFactory()) to resolve those references. The context will then be used to calculate the absolute path. See TQMimeSourceFactory::makeAbsolute() for details. .PP @@ -108,14 +108,14 @@ See also setWidth(). Returns the anchor at the requested position, \fIpos\fR. An empty string is returned if no anchor is specified for this position. .SH "TQString QSimpleRichText::context () const" Returns the context of the rich text object. If no context has been specified in the constructor, a null string is returned. The context is the path to use to look up relative links, such as image tags and anchor references. -.SH "void QSimpleRichText::draw ( QPainter * p, int x, int y, const QRect & clipRect, const QColorGroup & cg, const QBrush * paper = 0 ) const" +.SH "void QSimpleRichText::draw ( TQPainter * p, int x, int y, const QRect & clipRect, const TQColorGroup & cg, const TQBrush * paper = 0 ) const" Draws the formatted text with painter \fIp\fR, at position (\fIx\fR, \fIy\fR), clipped to \fIclipRect\fR. The clipping rectangle is given in the rich text object's coordinates translated by (\fIx\fR, \fIy\fR). Passing an null rectangle results in no clipping. Colors from the color group \fIcg\fR are used as needed, and if not 0, \fI*paper\fR is used as the background brush. .PP Note that the display code is highly optimized to reduce flicker, so passing a brush for \fIpaper\fR is preferable to simply clearing the area to be painted and then calling this without a brush. .PP Examples: .)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. -.SH "void QSimpleRichText::draw ( QPainter * p, int x, int y, const QRegion & clipRegion, const QColorGroup & cg, const QBrush * paper = 0 ) const" +.SH "void QSimpleRichText::draw ( TQPainter * p, int x, int y, const QRegion & clipRegion, const TQColorGroup & cg, const TQBrush * paper = 0 ) const" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP Use the version with clipRect instead. The region version has problems with larger documents on some platforms (on X11 regions internally are represented with 16bit coordinates). @@ -128,9 +128,9 @@ Examples: .)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. .SH "bool QSimpleRichText::inText ( const QPoint & pos ) const" Returns TRUE if \fIpos\fR is within a text line of the rich text object; otherwise returns FALSE. -.SH "void QSimpleRichText::setDefaultFont ( const QFont & f )" +.SH "void QSimpleRichText::setDefaultFont ( const TQFont & f )" Sets the default font for the rich text object to \fIf\fR -.SH "void QSimpleRichText::setWidth ( QPainter * p, int w )" +.SH "void QSimpleRichText::setWidth ( TQPainter * p, int w )" Sets the width of the rich text object to \fIw\fR pixels, recalculating the layout as if it were to be drawn with painter \fIp\fR. .PP Passing a painter is useful when you intend drawing on devices other than the screen, for example a QPrinter. |