summaryrefslogtreecommitdiffstats
path: root/doc/man/man3/tqsimplerichtext.3qt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/man3/tqsimplerichtext.3qt')
-rw-r--r--doc/man/man3/tqsimplerichtext.3qt66
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/man/man3/tqsimplerichtext.3qt b/doc/man/man3/tqsimplerichtext.3qt
index 6b4208e96..c1f02b62f 100644
--- a/doc/man/man3/tqsimplerichtext.3qt
+++ b/doc/man/man3/tqsimplerichtext.3qt
@@ -1,5 +1,5 @@
'\" t
-.TH QSimpleRichText 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
+.TH TQSimpleRichText 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the
.\" license file included in the distribution for a complete license
.\" statement.
@@ -7,20 +7,20 @@
.ad l
.nh
.SH NAME
-QSimpleRichText \- Small displayable piece of rich text
+TQSimpleRichText \- Small displayable piece of rich text
.SH SYNOPSIS
-\fC#include <ntqsimplerichtext.h>\fR
+\fC#include <tqsimplerichtext.h>\fR
.PP
.SS "Public Members"
.in +1c
.ti -1c
-.BI "\fBQSimpleRichText\fR ( const TQString & text, const TQFont & fnt, const TQString & context = TQString::null, const TQStyleSheet * sheet = 0 )"
+.BI "\fBTQSimpleRichText\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 TQFont & fnt, const TQString & context, const TQStyleSheet * sheet, const TQMimeSourceFactory * factory, int pageBreak = -1, const TQColor & linkColor = TQt::blue, bool linkUnderline = TRUE )"
+.BI "\fBTQSimpleRichText\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 ()"
+.BI "\fB~TQSimpleRichText\fR ()"
.br
.ti -1c
.BI "void \fBsetWidth\fR ( int w )"
@@ -60,77 +60,77 @@ QSimpleRichText \- Small displayable piece of rich text
.br
.in -1c
.SH DESCRIPTION
-The QSimpleRichText class provides a small displayable piece of rich text.
+The TQSimpleRichText 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 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.
+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(). TQSimpleRichText 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.
+For large documents use TQTextEdit or TQTextBrowser. For very small items of rich text you can use a TQLabel.
.PP
-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.
+If you are using TQSimpleRichText 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 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.
+.SH "TQSimpleRichText::TQSimpleRichText ( const TQString & text, const TQFont & fnt, const TQString & context = TQString::null, const TQStyleSheet * sheet = 0 )"
+Constructs a TQSimpleRichText 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:
.PP
.nf
.br
- QSimpleRichText myrichtext( contents, mywidget->font() );
+ TQSimpleRichText myrichtext( contents, mywidget->font() );
.br
.fi
.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.
+\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. TQSimpleRichText 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 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.
+.SH "TQSimpleRichText::TQSimpleRichText ( 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 TQSimpleRichText 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 TQColorGroup's TQColorGroup::link() color is used now.
+This is a slightly more complex constructor for TQSimpleRichText 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.
+\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. TQSimpleRichText 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()).
.PP
-This constructor is useful for creating a QSimpleRichText object suitable for printing. Set \fIpageBreak\fR to be the height of the contents area of the pages.
-.SH "QSimpleRichText::~QSimpleRichText ()"
+This constructor is useful for creating a TQSimpleRichText object suitable for printing. Set \fIpageBreak\fR to be the height of the contents area of the pages.
+.SH "TQSimpleRichText::~TQSimpleRichText ()"
Destroys the rich text object, freeing memory.
-.SH "void QSimpleRichText::adjustSize ()"
+.SH "void TQSimpleRichText::adjustSize ()"
Adjusts the richt text object to a reasonable size.
.PP
See also setWidth().
-.SH "TQString QSimpleRichText::anchorAt ( const TQPoint & pos ) const"
+.SH "TQString TQSimpleRichText::anchorAt ( const TQPoint & pos ) const"
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"
+.SH "TQString TQSimpleRichText::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 ( TQPainter * p, int x, int y, const TQRect & clipRect, const TQColorGroup & cg, const TQBrush * paper = 0 ) const"
+.SH "void TQSimpleRichText::draw ( TQPainter * p, int x, int y, const TQRect & 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 ( TQPainter * p, int x, int y, const TQRegion & clipRegion, const TQColorGroup & cg, const TQBrush * paper = 0 ) const"
+.SH "void TQSimpleRichText::draw ( TQPainter * p, int x, int y, const TQRegion & 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).
-.SH "int QSimpleRichText::height () const"
+.SH "int TQSimpleRichText::height () const"
Returns the height of the rich text object in pixels.
.PP
See also setWidth().
.PP
Examples:
.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp.
-.SH "bool QSimpleRichText::inText ( const TQPoint & pos ) const"
+.SH "bool TQSimpleRichText::inText ( const TQPoint & 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 TQFont & f )"
+.SH "void TQSimpleRichText::setDefaultFont ( const TQFont & f )"
Sets the default font for the rich text object to \fIf\fR
-.SH "void QSimpleRichText::setWidth ( TQPainter * p, int w )"
+.SH "void TQSimpleRichText::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 TQPrinter.
@@ -139,17 +139,17 @@ See also height() and adjustSize().
.PP
Examples:
.)l action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp.
-.SH "void QSimpleRichText::setWidth ( int w )"
+.SH "void TQSimpleRichText::setWidth ( int w )"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Sets the width of the rich text object to \fIw\fR pixels.
.PP
See also height() and adjustSize().
-.SH "int QSimpleRichText::width () const"
+.SH "int TQSimpleRichText::width () const"
Returns the set width of the rich text object in pixels.
.PP
See also widthUsed().
-.SH "int QSimpleRichText::widthUsed () const"
+.SH "int TQSimpleRichText::widthUsed () const"
Returns the width in pixels that is actually used by the rich text object. This can be smaller or wider than the set width.
.PP
It may be wider, for example, if the text contains images or non-breakable words that are already wider than the available space. It's smaller when the object only consists of lines that do not fill the width completely.
@@ -157,7 +157,7 @@ It may be wider, for example, if the text contains images or non-breakable words
See also width().
.SH "SEE ALSO"
-.BR http://doc.trolltech.com/ntqsimplerichtext.html
+.BR http://doc.trolltech.com/tqsimplerichtext.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the