| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|---|
| 2 | <!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qsimplerichtext.cpp:75 -->
|
|---|
| 3 | <html>
|
|---|
| 4 | <head>
|
|---|
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|---|
| 6 | <title>QSimpleRichText Class</title>
|
|---|
| 7 | <style type="text/css"><!--
|
|---|
| 8 | fn { margin-left: 1cm; text-indent: -1cm; }
|
|---|
| 9 | a:link { color: #004faf; text-decoration: none }
|
|---|
| 10 | a:visited { color: #672967; text-decoration: none }
|
|---|
| 11 | body { background: #ffffff; color: black; }
|
|---|
| 12 | --></style>
|
|---|
| 13 | </head>
|
|---|
| 14 | <body>
|
|---|
| 15 |
|
|---|
| 16 | <table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|---|
| 17 | <tr bgcolor="#E5E5E5">
|
|---|
| 18 | <td valign=center>
|
|---|
| 19 | <a href="index.html">
|
|---|
| 20 | <font color="#004faf">Home</font></a>
|
|---|
| 21 | | <a href="classes.html">
|
|---|
| 22 | <font color="#004faf">All Classes</font></a>
|
|---|
| 23 | | <a href="mainclasses.html">
|
|---|
| 24 | <font color="#004faf">Main Classes</font></a>
|
|---|
| 25 | | <a href="annotated.html">
|
|---|
| 26 | <font color="#004faf">Annotated</font></a>
|
|---|
| 27 | | <a href="groups.html">
|
|---|
| 28 | <font color="#004faf">Grouped Classes</font></a>
|
|---|
| 29 | | <a href="functions.html">
|
|---|
| 30 | <font color="#004faf">Functions</font></a>
|
|---|
| 31 | </td>
|
|---|
| 32 | <td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QSimpleRichText Class Reference</h1>
|
|---|
| 33 |
|
|---|
| 34 | <p>The QSimpleRichText class provides a small displayable piece of rich text.
|
|---|
| 35 | <a href="#details">More...</a>
|
|---|
| 36 | <p><tt>#include <<a href="qsimplerichtext-h.html">qsimplerichtext.h</a>></tt>
|
|---|
| 37 | <p><a href="qsimplerichtext-members.html">List of all member functions.</a>
|
|---|
| 38 | <h2>Public Members</h2>
|
|---|
| 39 | <ul>
|
|---|
| 40 | <li class=fn><a href="#QSimpleRichText"><b>QSimpleRichText</b></a> ( const QString & text, const QFont & fnt, const QString & context = QString::null, const QStyleSheet * sheet = 0 )</li>
|
|---|
| 41 | <li class=fn><a href="#QSimpleRichText-2"><b>QSimpleRichText</b></a> ( const QString & text, const QFont & fnt, const QString & context, const QStyleSheet * sheet, const QMimeSourceFactory * factory, int pageBreak = -1, const QColor & linkColor = Qt::blue, bool linkUnderline = TRUE )</li>
|
|---|
| 42 | <li class=fn><a href="#~QSimpleRichText"><b>~QSimpleRichText</b></a> ()</li>
|
|---|
| 43 | <li class=fn>void <a href="#setWidth-2"><b>setWidth</b></a> ( int w )</li>
|
|---|
| 44 | <li class=fn>void <a href="#setWidth"><b>setWidth</b></a> ( QPainter * p, int w )</li>
|
|---|
| 45 | <li class=fn>void <a href="#setDefaultFont"><b>setDefaultFont</b></a> ( const QFont & f )</li>
|
|---|
| 46 | <li class=fn>int <a href="#width"><b>width</b></a> () const</li>
|
|---|
| 47 | <li class=fn>int <a href="#widthUsed"><b>widthUsed</b></a> () const</li>
|
|---|
| 48 | <li class=fn>int <a href="#height"><b>height</b></a> () const</li>
|
|---|
| 49 | <li class=fn>void <a href="#adjustSize"><b>adjustSize</b></a> ()</li>
|
|---|
| 50 | <li class=fn>void <a href="#draw"><b>draw</b></a> ( QPainter * p, int x, int y, const QRect & clipRect, const QColorGroup & cg, const QBrush * paper = 0 ) const</li>
|
|---|
| 51 | <li class=fn>void draw ( QPainter * p, int x, int y, const QRegion & clipRegion, const QColorGroup & cg, const QBrush * paper = 0 ) const <em>(obsolete)</em></li>
|
|---|
| 52 | <li class=fn>QString <a href="#context"><b>context</b></a> () const</li>
|
|---|
| 53 | <li class=fn>QString <a href="#anchorAt"><b>anchorAt</b></a> ( const QPoint & pos ) const</li>
|
|---|
| 54 | <li class=fn>bool <a href="#inText"><b>inText</b></a> ( const QPoint & pos ) const</li>
|
|---|
| 55 | </ul>
|
|---|
| 56 | <hr><a name="details"></a><h2>Detailed Description</h2>
|
|---|
| 57 |
|
|---|
| 58 |
|
|---|
| 59 | The QSimpleRichText class provides a small displayable piece of rich text.
|
|---|
| 60 | <p>
|
|---|
| 61 |
|
|---|
| 62 | <p> This class encapsulates simple rich text usage in which a string
|
|---|
| 63 | is interpreted as rich text and can be drawn. This is particularly
|
|---|
| 64 | useful if you want to display some rich text in a custom widget. A
|
|---|
| 65 | <a href="qstylesheet.html">QStyleSheet</a> is needed to interpret the tags and format the rich
|
|---|
| 66 | text. Qt provides a default HTML-like style sheet, but you may
|
|---|
| 67 | define custom style sheets.
|
|---|
| 68 | <p> Once created, the rich text object can be queried for its <a href="#width">width</a>(),
|
|---|
| 69 | <a href="#height">height</a>(), and the actual width used (see <a href="#widthUsed">widthUsed</a>()). Most
|
|---|
| 70 | importantly, it can be drawn on any given <a href="qpainter.html">QPainter</a> with <a href="#draw">draw</a>().
|
|---|
| 71 | QSimpleRichText can also be used to implement hypertext or active
|
|---|
| 72 | text facilities by using <a href="#anchorAt">anchorAt</a>(). A hit test through <a href="#inText">inText</a>()
|
|---|
| 73 | makes it possible to use simple rich text for text objects in
|
|---|
| 74 | editable drawing canvases.
|
|---|
| 75 | <p> Once constructed from a string the contents cannot be changed,
|
|---|
| 76 | only resized. If the contents change, just throw the rich text
|
|---|
| 77 | object away and make a new one with the new contents.
|
|---|
| 78 | <p> For large documents use <a href="qtextedit.html">QTextEdit</a> or <a href="qtextbrowser.html">QTextBrowser</a>. For very small
|
|---|
| 79 | items of rich text you can use a <a href="qlabel.html">QLabel</a>.
|
|---|
| 80 | <p> If you are using QSimpleRichText to print in high resolution you
|
|---|
| 81 | should call <a href="#setWidth">setWidth</a>(QPainter, int) so that the content will be
|
|---|
| 82 | laid out properly on the page.
|
|---|
| 83 | <p>See also <a href="text.html">Text Related Classes</a>.
|
|---|
| 84 |
|
|---|
| 85 | <hr><h2>Member Function Documentation</h2>
|
|---|
| 86 | <h3 class=fn><a name="QSimpleRichText"></a>QSimpleRichText::QSimpleRichText ( const <a href="qstring.html">QString</a> & text, const <a href="qfont.html">QFont</a> & fnt, const <a href="qstring.html">QString</a> & context = QString::null, const <a href="qstylesheet.html">QStyleSheet</a> * sheet = 0 )
|
|---|
| 87 | </h3>
|
|---|
| 88 | Constructs a QSimpleRichText from the rich text string <em>text</em> and
|
|---|
| 89 | the font <em>fnt</em>.
|
|---|
| 90 | <p> The font is used as a basis for the text rendering. When using
|
|---|
| 91 | rich text rendering on a widget <em>w</em>, you would normally specify
|
|---|
| 92 | the widget's font, for example:
|
|---|
| 93 | <p> <pre>
|
|---|
| 94 | QSimpleRichText myrichtext( contents, mywidget->font() );
|
|---|
| 95 | </pre>
|
|---|
| 96 |
|
|---|
| 97 | <p> <em>context</em> is the optional context of the rich text object. This
|
|---|
| 98 | becomes important if <em>text</em> contains relative references, for
|
|---|
| 99 | example within image tags. QSimpleRichText always uses the default
|
|---|
| 100 | mime source factory (see <a href="qmimesourcefactory.html#defaultFactory">QMimeSourceFactory::defaultFactory</a>())
|
|---|
| 101 | to resolve those references. The context will then be used to
|
|---|
| 102 | calculate the absolute path. See
|
|---|
| 103 | <a href="qmimesourcefactory.html#makeAbsolute">QMimeSourceFactory::makeAbsolute</a>() for details.
|
|---|
| 104 | <p> The <em>sheet</em> is an optional style sheet. If it is 0, the default
|
|---|
| 105 | style sheet will be used (see <a href="qstylesheet.html#defaultSheet">QStyleSheet::defaultSheet</a>()).
|
|---|
| 106 |
|
|---|
| 107 | <h3 class=fn><a name="QSimpleRichText-2"></a>QSimpleRichText::QSimpleRichText ( const <a href="qstring.html">QString</a> & text, const <a href="qfont.html">QFont</a> & fnt, const <a href="qstring.html">QString</a> & context, const <a href="qstylesheet.html">QStyleSheet</a> * sheet, const <a href="qmimesourcefactory.html">QMimeSourceFactory</a> * factory, int pageBreak = -1, const <a href="qcolor.html">QColor</a> & linkColor = Qt::blue, bool linkUnderline = TRUE )
|
|---|
| 108 | </h3>
|
|---|
| 109 | Constructs a QSimpleRichText from the rich text string <em>text</em> and
|
|---|
| 110 | the font <em>fnt</em>.
|
|---|
| 111 | <p> This is a slightly more complex constructor for QSimpleRichText
|
|---|
| 112 | that takes an additional mime source factory <em>factory</em>, a page
|
|---|
| 113 | break parameter <em>pageBreak</em> and a bool <em>linkUnderline</em>. <em>linkColor</em> is only provided for compatibility, but has no effect,
|
|---|
| 114 | as <a href="qcolorgroup.html">QColorGroup</a>'s <a href="qcolorgroup.html#link">QColorGroup::link</a>() color is used now.
|
|---|
| 115 | <p> <em>context</em> is the optional context of the rich text object. This
|
|---|
| 116 | becomes important if <em>text</em> contains relative references, for
|
|---|
| 117 | example within image tags. QSimpleRichText always uses the default
|
|---|
| 118 | mime source factory (see <a href="qmimesourcefactory.html#defaultFactory">QMimeSourceFactory::defaultFactory</a>())
|
|---|
| 119 | to resolve those references. The context will then be used to
|
|---|
| 120 | calculate the absolute path. See
|
|---|
| 121 | <a href="qmimesourcefactory.html#makeAbsolute">QMimeSourceFactory::makeAbsolute</a>() for details.
|
|---|
| 122 | <p> The <em>sheet</em> is an optional style sheet. If it is 0, the default
|
|---|
| 123 | style sheet will be used (see <a href="qstylesheet.html#defaultSheet">QStyleSheet::defaultSheet</a>()).
|
|---|
| 124 | <p> This constructor is useful for creating a QSimpleRichText object
|
|---|
| 125 | suitable for printing. Set <em>pageBreak</em> to be the height of the
|
|---|
| 126 | contents area of the pages.
|
|---|
| 127 |
|
|---|
| 128 | <h3 class=fn><a name="~QSimpleRichText"></a>QSimpleRichText::~QSimpleRichText ()
|
|---|
| 129 | </h3>
|
|---|
| 130 | Destroys the rich text object, freeing memory.
|
|---|
| 131 |
|
|---|
| 132 | <h3 class=fn>void <a name="adjustSize"></a>QSimpleRichText::adjustSize ()
|
|---|
| 133 | </h3>
|
|---|
| 134 | Adjusts the richt text object to a reasonable size.
|
|---|
| 135 | <p> <p>See also <a href="#setWidth">setWidth</a>().
|
|---|
| 136 |
|
|---|
| 137 | <h3 class=fn><a href="qstring.html">QString</a> <a name="anchorAt"></a>QSimpleRichText::anchorAt ( const <a href="qpoint.html">QPoint</a> & pos ) const
|
|---|
| 138 | </h3>
|
|---|
| 139 | Returns the anchor at the requested position, <em>pos</em>. An empty
|
|---|
| 140 | string is returned if no anchor is specified for this position.
|
|---|
| 141 |
|
|---|
| 142 | <h3 class=fn><a href="qstring.html">QString</a> <a name="context"></a>QSimpleRichText::context () const
|
|---|
| 143 | </h3>
|
|---|
| 144 | Returns the context of the rich text object. If no context has
|
|---|
| 145 | been specified in the constructor, a null string is returned. The
|
|---|
| 146 | context is the path to use to look up relative links, such as
|
|---|
| 147 | image tags and anchor references.
|
|---|
| 148 |
|
|---|
| 149 | <h3 class=fn>void <a name="draw"></a>QSimpleRichText::draw ( <a href="qpainter.html">QPainter</a> * p, int x, int y, const <a href="qrect.html">QRect</a> & clipRect, const <a href="qcolorgroup.html">QColorGroup</a> & cg, const <a href="qbrush.html">QBrush</a> * paper = 0 ) const
|
|---|
| 150 | </h3>
|
|---|
| 151 | 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
|
|---|
| 152 | rich text object's coordinates translated by (<em>x</em>, <em>y</em>). Passing
|
|---|
| 153 | an null rectangle results in no clipping. Colors from the color
|
|---|
| 154 | group <em>cg</em> are used as needed, and if not 0, <em>*paper</em> is used as
|
|---|
| 155 | the background brush.
|
|---|
| 156 | <p> Note that the display code is highly optimized to reduce flicker,
|
|---|
| 157 | so passing a brush for <em>paper</em> is preferable to simply clearing
|
|---|
| 158 | the area to be painted and then calling this without a brush.
|
|---|
| 159 |
|
|---|
| 160 | <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>.
|
|---|
| 161 | <h3 class=fn>void <a name="draw-2"></a>QSimpleRichText::draw ( <a href="qpainter.html">QPainter</a> * p, int x, int y, const <a href="qregion.html">QRegion</a> & clipRegion, const <a href="qcolorgroup.html">QColorGroup</a> & cg, const <a href="qbrush.html">QBrush</a> * paper = 0 ) const
|
|---|
| 162 | </h3>
|
|---|
| 163 | <p> <b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code.
|
|---|
| 164 | <p> Use the version with clipRect instead. The region version has
|
|---|
| 165 | problems with larger documents on some platforms (on X11 regions
|
|---|
| 166 | internally are represented with 16bit coordinates).
|
|---|
| 167 |
|
|---|
| 168 | <h3 class=fn>int <a name="height"></a>QSimpleRichText::height () const
|
|---|
| 169 | </h3>
|
|---|
| 170 | Returns the height of the rich text object in pixels.
|
|---|
| 171 | <p> <p>See also <a href="#setWidth">setWidth</a>().
|
|---|
| 172 |
|
|---|
| 173 | <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>.
|
|---|
| 174 | <h3 class=fn>bool <a name="inText"></a>QSimpleRichText::inText ( const <a href="qpoint.html">QPoint</a> & pos ) const
|
|---|
| 175 | </h3>
|
|---|
| 176 | Returns TRUE if <em>pos</em> is within a text line of the rich text
|
|---|
| 177 | object; otherwise returns FALSE.
|
|---|
| 178 |
|
|---|
| 179 | <h3 class=fn>void <a name="setDefaultFont"></a>QSimpleRichText::setDefaultFont ( const <a href="qfont.html">QFont</a> & f )
|
|---|
| 180 | </h3>
|
|---|
| 181 | Sets the default font for the rich text object to <em>f</em>
|
|---|
| 182 |
|
|---|
| 183 | <h3 class=fn>void <a name="setWidth"></a>QSimpleRichText::setWidth ( <a href="qpainter.html">QPainter</a> * p, int w )
|
|---|
| 184 | </h3>
|
|---|
| 185 | Sets the width of the rich text object to <em>w</em> pixels,
|
|---|
| 186 | recalculating the layout as if it were to be drawn with painter <em>p</em>.
|
|---|
| 187 | <p> Passing a painter is useful when you intend drawing on devices
|
|---|
| 188 | other than the screen, for example a <a href="qprinter.html">QPrinter</a>.
|
|---|
| 189 | <p> <p>See also <a href="#height">height</a>() and <a href="#adjustSize">adjustSize</a>().
|
|---|
| 190 |
|
|---|
| 191 | <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>.
|
|---|
| 192 | <h3 class=fn>void <a name="setWidth-2"></a>QSimpleRichText::setWidth ( int w )
|
|---|
| 193 | </h3>
|
|---|
| 194 | This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
|
|---|
| 195 | <p> Sets the width of the rich text object to <em>w</em> pixels.
|
|---|
| 196 | <p> <p>See also <a href="#height">height</a>() and <a href="#adjustSize">adjustSize</a>().
|
|---|
| 197 |
|
|---|
| 198 | <h3 class=fn>int <a name="width"></a>QSimpleRichText::width () const
|
|---|
| 199 | </h3>
|
|---|
| 200 | Returns the set width of the rich text object in pixels.
|
|---|
| 201 | <p> <p>See also <a href="#widthUsed">widthUsed</a>().
|
|---|
| 202 |
|
|---|
| 203 | <h3 class=fn>int <a name="widthUsed"></a>QSimpleRichText::widthUsed () const
|
|---|
| 204 | </h3>
|
|---|
| 205 | Returns the width in pixels that is actually used by the rich text
|
|---|
| 206 | object. This can be smaller or wider than the set width.
|
|---|
| 207 | <p> It may be wider, for example, if the text contains images or
|
|---|
| 208 | non-breakable words that are already wider than the available
|
|---|
| 209 | space. It's smaller when the object only consists of lines that do
|
|---|
| 210 | not fill the width completely.
|
|---|
| 211 | <p> <p>See also <a href="#width">width</a>().
|
|---|
| 212 |
|
|---|
| 213 | <!-- eof -->
|
|---|
| 214 | <hr><p>
|
|---|
| 215 | This file is part of the <a href="index.html">Qt toolkit</a>.
|
|---|
| 216 | Copyright © 1995-2007
|
|---|
| 217 | <a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
|
|---|
| 218 | <table width=100% cellspacing=0 border=0><tr>
|
|---|
| 219 | <td>Copyright © 2007
|
|---|
| 220 | <a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
|
|---|
| 221 | <td align=right><div align=right>Qt 3.3.8</div>
|
|---|
| 222 | </table></div></address></body>
|
|---|
| 223 | </html>
|
|---|
