summaryrefslogtreecommitdiffstats
path: root/doc/html/qsimplerichtext.html
diff options
context:
space:
mode:
authorTimothy Pearson <[email protected]>2011-11-08 12:31:36 -0600
committerTimothy Pearson <[email protected]>2011-11-08 12:31:36 -0600
commitd796c9dd933ab96ec83b9a634feedd5d32e1ba3f (patch)
tree6e3dcca4f77e20ec8966c666aac7c35bd4704053 /doc/html/qsimplerichtext.html
downloadtqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.tar.gz
tqt3-d796c9dd933ab96ec83b9a634feedd5d32e1ba3f.zip
Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731
Diffstat (limited to 'doc/html/qsimplerichtext.html')
-rw-r--r--doc/html/qsimplerichtext.html223
1 files changed, 223 insertions, 0 deletions
diff --git a/doc/html/qsimplerichtext.html b/doc/html/qsimplerichtext.html
new file mode 100644
index 000000000..c0d9d4cf5
--- /dev/null
+++ b/doc/html/qsimplerichtext.html
@@ -0,0 +1,223 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qsimplerichtext.cpp:75 -->
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>TQSimpleRichText Class</title>
+<style type="text/css"><!--
+fn { margin-left: 1cm; text-indent: -1cm; }
+a:link { color: #004faf; text-decoration: none }
+a:visited { color: #672967; text-decoration: none }
+body { background: #ffffff; color: black; }
+--></style>
+</head>
+<body>
+
+<table border="0" cellpadding="0" cellspacing="0" width="100%">
+<tr bgcolor="#E5E5E5">
+<td valign=center>
+ <a href="index.html">
+<font color="#004faf">Home</font></a>
+ | <a href="classes.html">
+<font color="#004faf">All&nbsp;Classes</font></a>
+ | <a href="mainclasses.html">
+<font color="#004faf">Main&nbsp;Classes</font></a>
+ | <a href="annotated.html">
+<font color="#004faf">Annotated</font></a>
+ | <a href="groups.html">
+<font color="#004faf">Grouped&nbsp;Classes</font></a>
+ | <a href="functions.html">
+<font color="#004faf">Functions</font></a>
+</td>
+<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQSimpleRichText Class Reference</h1>
+
+<p>The TQSimpleRichText class provides a small displayable piece of rich text.
+<a href="#details">More...</a>
+<p><tt>#include &lt;<a href="qsimplerichtext-h.html">qsimplerichtext.h</a>&gt;</tt>
+<p><a href="qsimplerichtext-members.html">List of all member functions.</a>
+<h2>Public Members</h2>
+<ul>
+<li class=fn><a href="#TQSimpleRichText"><b>TQSimpleRichText</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;text, const&nbsp;TQFont&nbsp;&amp;&nbsp;fnt, const&nbsp;TQString&nbsp;&amp;&nbsp;context = TQString::null, const&nbsp;TQStyleSheet&nbsp;*&nbsp;sheet = 0 )</li>
+<li class=fn><a href="#TQSimpleRichText-2"><b>TQSimpleRichText</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;text, const&nbsp;TQFont&nbsp;&amp;&nbsp;fnt, const&nbsp;TQString&nbsp;&amp;&nbsp;context, const&nbsp;TQStyleSheet&nbsp;*&nbsp;sheet, const&nbsp;TQMimeSourceFactory&nbsp;*&nbsp;factory, int&nbsp;pageBreak = -1, const&nbsp;TQColor&nbsp;&amp;&nbsp;linkColor = TQt::blue, bool&nbsp;linkUnderline = TRUE )</li>
+<li class=fn><a href="#~TQSimpleRichText"><b>~TQSimpleRichText</b></a> ()</li>
+<li class=fn>void <a href="#setWidth-2"><b>setWidth</b></a> ( int&nbsp;w )</li>
+<li class=fn>void <a href="#setWidth"><b>setWidth</b></a> ( TQPainter&nbsp;*&nbsp;p, int&nbsp;w )</li>
+<li class=fn>void <a href="#setDefaultFont"><b>setDefaultFont</b></a> ( const&nbsp;TQFont&nbsp;&amp;&nbsp;f )</li>
+<li class=fn>int <a href="#width"><b>width</b></a> () const</li>
+<li class=fn>int <a href="#widthUsed"><b>widthUsed</b></a> () const</li>
+<li class=fn>int <a href="#height"><b>height</b></a> () const</li>
+<li class=fn>void <a href="#adjustSize"><b>adjustSize</b></a> ()</li>
+<li class=fn>void <a href="#draw"><b>draw</b></a> ( TQPainter&nbsp;*&nbsp;p, int&nbsp;x, int&nbsp;y, const&nbsp;TQRect&nbsp;&amp;&nbsp;clipRect, const&nbsp;TQColorGroup&nbsp;&amp;&nbsp;cg, const&nbsp;TQBrush&nbsp;*&nbsp;paper = 0 ) const</li>
+<li class=fn>void draw ( TQPainter&nbsp;*&nbsp;p, int&nbsp;x, int&nbsp;y, const&nbsp;TQRegion&nbsp;&amp;&nbsp;clipRegion, const&nbsp;TQColorGroup&nbsp;&amp;&nbsp;cg, const&nbsp;TQBrush&nbsp;*&nbsp;paper = 0 ) const &nbsp;<em>(obsolete)</em></li>
+<li class=fn>TQString <a href="#context"><b>context</b></a> () const</li>
+<li class=fn>TQString <a href="#anchorAt"><b>anchorAt</b></a> ( const&nbsp;TQPoint&nbsp;&amp;&nbsp;pos ) const</li>
+<li class=fn>bool <a href="#inText"><b>inText</b></a> ( const&nbsp;TQPoint&nbsp;&amp;&nbsp;pos ) const</li>
+</ul>
+<hr><a name="details"></a><h2>Detailed Description</h2>
+
+
+The TQSimpleRichText class provides a small displayable piece of rich text.
+<p>
+
+<p> 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
+<a href="qstylesheet.html">TQStyleSheet</a> 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.
+<p> Once created, the rich text object can be queried for its <a href="#width">width</a>(),
+<a href="#height">height</a>(), and the actual width used (see <a href="#widthUsed">widthUsed</a>()). Most
+importantly, it can be drawn on any given <a href="qpainter.html">TQPainter</a> with <a href="#draw">draw</a>().
+TQSimpleRichText can also be used to implement hypertext or active
+text facilities by using <a href="#anchorAt">anchorAt</a>(). A hit test through <a href="#inText">inText</a>()
+makes it possible to use simple rich text for text objects in
+editable drawing canvases.
+<p> 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.
+<p> For large documents use <a href="qtextedit.html">TQTextEdit</a> or <a href="qtextbrowser.html">TQTextBrowser</a>. For very small
+items of rich text you can use a <a href="qlabel.html">TQLabel</a>.
+<p> If you are using TQSimpleRichText to print in high resolution you
+should call <a href="#setWidth">setWidth</a>(TQPainter, int) so that the content will be
+laid out properly on the page.
+<p>See also <a href="text.html">Text Related Classes</a>.
+
+<hr><h2>Member Function Documentation</h2>
+<h3 class=fn><a name="TQSimpleRichText"></a>TQSimpleRichText::TQSimpleRichText ( const&nbsp;<a href="qstring.html">TQString</a>&nbsp;&amp;&nbsp;text, const&nbsp;<a href="qfont.html">TQFont</a>&nbsp;&amp;&nbsp;fnt, const&nbsp;<a href="qstring.html">TQString</a>&nbsp;&amp;&nbsp;context = TQString::null, const&nbsp;<a href="qstylesheet.html">TQStyleSheet</a>&nbsp;*&nbsp;sheet = 0 )
+</h3>
+Constructs a TQSimpleRichText from the rich text string <em>text</em> and
+the font <em>fnt</em>.
+<p> The font is used as a basis for the text rendering. When using
+rich text rendering on a widget <em>w</em>, you would normally specify
+the widget's font, for example:
+<p> <pre>
+ TQSimpleRichText myrichtext( contents, mywidget-&gt;font() );
+ </pre>
+
+<p> <em>context</em> is the optional context of the rich text object. This
+becomes important if <em>text</em> contains relative references, for
+example within image tags. TQSimpleRichText always uses the default
+mime source factory (see <a href="qmimesourcefactory.html#defaultFactory">TQMimeSourceFactory::defaultFactory</a>())
+to resolve those references. The context will then be used to
+calculate the absolute path. See
+<a href="qmimesourcefactory.html#makeAbsolute">TQMimeSourceFactory::makeAbsolute</a>() for details.
+<p> The <em>sheet</em> is an optional style sheet. If it is 0, the default
+style sheet will be used (see <a href="qstylesheet.html#defaultSheet">TQStyleSheet::defaultSheet</a>()).
+
+<h3 class=fn><a name="TQSimpleRichText-2"></a>TQSimpleRichText::TQSimpleRichText ( const&nbsp;<a href="qstring.html">TQString</a>&nbsp;&amp;&nbsp;text, const&nbsp;<a href="qfont.html">TQFont</a>&nbsp;&amp;&nbsp;fnt, const&nbsp;<a href="qstring.html">TQString</a>&nbsp;&amp;&nbsp;context, const&nbsp;<a href="qstylesheet.html">TQStyleSheet</a>&nbsp;*&nbsp;sheet, const&nbsp;<a href="qmimesourcefactory.html">TQMimeSourceFactory</a>&nbsp;*&nbsp;factory, int&nbsp;pageBreak = -1, const&nbsp;<a href="qcolor.html">TQColor</a>&nbsp;&amp;&nbsp;linkColor = TQt::blue, bool&nbsp;linkUnderline = TRUE )
+</h3>
+Constructs a TQSimpleRichText from the rich text string <em>text</em> and
+the font <em>fnt</em>.
+<p> This is a slightly more complex constructor for TQSimpleRichText
+that takes an additional mime source factory <em>factory</em>, a page
+break parameter <em>pageBreak</em> and a bool <em>linkUnderline</em>. <em>linkColor</em> is only provided for compatibility, but has no effect,
+as <a href="qcolorgroup.html">TQColorGroup</a>'s <a href="qcolorgroup.html#link">TQColorGroup::link</a>() color is used now.
+<p> <em>context</em> is the optional context of the rich text object. This
+becomes important if <em>text</em> contains relative references, for
+example within image tags. TQSimpleRichText always uses the default
+mime source factory (see <a href="qmimesourcefactory.html#defaultFactory">TQMimeSourceFactory::defaultFactory</a>())
+to resolve those references. The context will then be used to
+calculate the absolute path. See
+<a href="qmimesourcefactory.html#makeAbsolute">TQMimeSourceFactory::makeAbsolute</a>() for details.
+<p> The <em>sheet</em> is an optional style sheet. If it is 0, the default
+style sheet will be used (see <a href="qstylesheet.html#defaultSheet">TQStyleSheet::defaultSheet</a>()).
+<p> This constructor is useful for creating a TQSimpleRichText object
+suitable for printing. Set <em>pageBreak</em> to be the height of the
+contents area of the pages.
+
+<h3 class=fn><a name="~TQSimpleRichText"></a>TQSimpleRichText::~TQSimpleRichText ()
+</h3>
+Destroys the rich text object, freeing memory.
+
+<h3 class=fn>void <a name="adjustSize"></a>TQSimpleRichText::adjustSize ()
+</h3>
+Adjusts the richt text object to a reasonable size.
+<p> <p>See also <a href="#setWidth">setWidth</a>().
+
+<h3 class=fn><a href="qstring.html">TQString</a> <a name="anchorAt"></a>TQSimpleRichText::anchorAt ( const&nbsp;<a href="qpoint.html">TQPoint</a>&nbsp;&amp;&nbsp;pos ) const
+</h3>
+Returns the anchor at the requested position, <em>pos</em>. An empty
+string is returned if no anchor is specified for this position.
+
+<h3 class=fn><a href="qstring.html">TQString</a> <a name="context"></a>TQSimpleRichText::context () const
+</h3>
+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.
+
+<h3 class=fn>void <a name="draw"></a>TQSimpleRichText::draw ( <a href="qpainter.html">TQPainter</a>&nbsp;*&nbsp;p, int&nbsp;x, int&nbsp;y, const&nbsp;<a href="qrect.html">TQRect</a>&nbsp;&amp;&nbsp;clipRect, const&nbsp;<a href="qcolorgroup.html">TQColorGroup</a>&nbsp;&amp;&nbsp;cg, const&nbsp;<a href="qbrush.html">TQBrush</a>&nbsp;*&nbsp;paper = 0 ) const
+</h3>
+Draws the formatted text with painter <em>p</em>, at position (<em>x</em>, <em>y</em>), clipped to <em>clipRect</em>. The clipping rectangle is given in the
+rich text object's coordinates translated by (<em>x</em>, <em>y</em>). Passing
+an null rectangle results in no clipping. Colors from the color
+group <em>cg</em> are used as needed, and if not 0, <em>*paper</em> is used as
+the background brush.
+<p> Note that the display code is highly optimized to reduce flicker,
+so passing a brush for <em>paper</em> is preferable to simply clearing
+the area to be painted and then calling this without a brush.
+
+<p>Examples: <a href="qaction-application-example.html#x1158">action/application.cpp</a>, <a href="simple-application-example.html#x1576">application/application.cpp</a>, <a href="helpviewer-example.html#x1014">helpviewer/helpwindow.cpp</a>, and <a href="mdi-example.html#x2061">mdi/application.cpp</a>.
+<h3 class=fn>void <a name="draw-2"></a>TQSimpleRichText::draw ( <a href="qpainter.html">TQPainter</a>&nbsp;*&nbsp;p, int&nbsp;x, int&nbsp;y, const&nbsp;<a href="qregion.html">TQRegion</a>&nbsp;&amp;&nbsp;clipRegion, const&nbsp;<a href="qcolorgroup.html">TQColorGroup</a>&nbsp;&amp;&nbsp;cg, const&nbsp;<a href="qbrush.html">TQBrush</a>&nbsp;*&nbsp;paper = 0 ) const
+</h3>
+<p> <b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code.
+<p> 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).
+
+<h3 class=fn>int <a name="height"></a>TQSimpleRichText::height () const
+</h3>
+Returns the height of the rich text object in pixels.
+<p> <p>See also <a href="#setWidth">setWidth</a>().
+
+<p>Examples: <a href="qaction-application-example.html#x1159">action/application.cpp</a>, <a href="simple-application-example.html#x1577">application/application.cpp</a>, <a href="helpviewer-example.html#x1015">helpviewer/helpwindow.cpp</a>, and <a href="mdi-example.html#x2062">mdi/application.cpp</a>.
+<h3 class=fn>bool <a name="inText"></a>TQSimpleRichText::inText ( const&nbsp;<a href="qpoint.html">TQPoint</a>&nbsp;&amp;&nbsp;pos ) const
+</h3>
+Returns TRUE if <em>pos</em> is within a text line of the rich text
+object; otherwise returns FALSE.
+
+<h3 class=fn>void <a name="setDefaultFont"></a>TQSimpleRichText::setDefaultFont ( const&nbsp;<a href="qfont.html">TQFont</a>&nbsp;&amp;&nbsp;f )
+</h3>
+Sets the default font for the rich text object to <em>f</em>
+
+<h3 class=fn>void <a name="setWidth"></a>TQSimpleRichText::setWidth ( <a href="qpainter.html">TQPainter</a>&nbsp;*&nbsp;p, int&nbsp;w )
+</h3>
+Sets the width of the rich text object to <em>w</em> pixels,
+recalculating the layout as if it were to be drawn with painter <em>p</em>.
+<p> Passing a painter is useful when you intend drawing on devices
+other than the screen, for example a <a href="qprinter.html">TQPrinter</a>.
+<p> <p>See also <a href="#height">height</a>() and <a href="#adjustSize">adjustSize</a>().
+
+<p>Examples: <a href="qaction-application-example.html#x1160">action/application.cpp</a>, <a href="simple-application-example.html#x1578">application/application.cpp</a>, <a href="helpviewer-example.html#x1016">helpviewer/helpwindow.cpp</a>, and <a href="mdi-example.html#x2063">mdi/application.cpp</a>.
+<h3 class=fn>void <a name="setWidth-2"></a>TQSimpleRichText::setWidth ( int&nbsp;w )
+</h3>
+This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
+<p> Sets the width of the rich text object to <em>w</em> pixels.
+<p> <p>See also <a href="#height">height</a>() and <a href="#adjustSize">adjustSize</a>().
+
+<h3 class=fn>int <a name="width"></a>TQSimpleRichText::width () const
+</h3>
+Returns the set width of the rich text object in pixels.
+<p> <p>See also <a href="#widthUsed">widthUsed</a>().
+
+<h3 class=fn>int <a name="widthUsed"></a>TQSimpleRichText::widthUsed () const
+</h3>
+Returns the width in pixels that is actually used by the rich text
+object. This can be smaller or wider than the set width.
+<p> 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.
+<p> <p>See also <a href="#width">width</a>().
+
+<!-- eof -->
+<hr><p>
+This file is part of the <a href="index.html">TQt toolkit</a>.
+Copyright &copy; 1995-2007
+<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
+<table width=100% cellspacing=0 border=0><tr>
+<td>Copyright &copy; 2007
+<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
+<td align=right><div align=right>TQt 3.3.8</div>
+</table></div></address></body>
+</html>