<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <!-- qplaintextedit.cpp --> <head> <title>Qt 4.6: QPlainTextDocumentLayout Class Reference</title> <link href="classic.css" rel="stylesheet" type="text/css" /> </head> <body> <a name="//apple_ref/cpp/cl//QPlainTextDocumentLayout"></a> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td> <td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="functions.html"><font color="#004faf">All Functions</font></a> · <a href="overviews.html"><font color="#004faf">Overviews</font></a></td></tr></table><h1 class="title">QPlainTextDocumentLayout Class Reference<br /><span class="small-subtitle">[<a href="qtgui.html">QtGui</a> module]</span> </h1> <p>The QPlainTextDocumentLayout class implements a plain text layout for <a href="qtextdocument.html">QTextDocument</a> <a href="#details">More...</a></p> <pre> #include <QPlainTextDocumentLayout></pre><p>Inherits <a href="qabstracttextdocumentlayout.html">QAbstractTextDocumentLayout</a>.</p> <p>This class was introduced in Qt 4.4.</p> <ul> <li><a href="qplaintextdocumentlayout-members.html">List of all members, including inherited members</a></li> </ul> <hr /> <a name="properties"></a> <h2>Properties</h2> <ul> <li><div class="fn"><b><a href="qplaintextdocumentlayout.html#cursorWidth-prop">cursorWidth</a></b> : int</div></li> </ul> <ul> <li><div bar="2" class="fn"></div>1 property inherited from <a href="qobject.html#properties">QObject</a></li> </ul> <hr /> <a name="public-functions"></a> <h2>Public Functions</h2> <table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#QPlainTextDocumentLayout">QPlainTextDocumentLayout</a></b> ( QTextDocument * <i>document</i> )</td></tr> <tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#dtor.QPlainTextDocumentLayout">~QPlainTextDocumentLayout</a></b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#cursorWidth-prop">cursorWidth</a></b> () const</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#ensureBlockLayout">ensureBlockLayout</a></b> ( const QTextBlock & <i>block</i> ) const</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#requestUpdate">requestUpdate</a></b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#cursorWidth-prop">setCursorWidth</a></b> ( int <i>width</i> )</td></tr> </table> <hr /> <a name="reimplemented-public-functions"></a> <h2>Reimplemented Public Functions</h2> <table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr><td class="memItemLeft" align="right" valign="top">virtual QRectF </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#blockBoundingRect">blockBoundingRect</a></b> ( const QTextBlock & <i>block</i> ) const</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual QSizeF </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#documentSize">documentSize</a></b> () const</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#draw">draw</a></b> ( QPainter *, const PaintContext & )</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual QRectF </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#frameBoundingRect">frameBoundingRect</a></b> ( QTextFrame * ) const</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#hitTest">hitTest</a></b> ( const QPointF &, Qt::HitTestAccuracy ) const</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#pageCount">pageCount</a></b> () const</td></tr> </table> <ul> <li><div bar="2" class="fn"></div>12 public functions inherited from <a href="qabstracttextdocumentlayout.html#public-functions">QAbstractTextDocumentLayout</a></li> <li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li> </ul> <hr /> <a name="reimplemented-protected-functions"></a> <h2>Reimplemented Protected Functions</h2> <table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qplaintextdocumentlayout.html#documentChanged">documentChanged</a></b> ( int <i>from</i>, int <i>charsRemoved</i>, int <i>charsAdded</i> )</td></tr> </table> <ul> <li><div bar="2" class="fn"></div>5 protected functions inherited from <a href="qabstracttextdocumentlayout.html#protected-functions">QAbstractTextDocumentLayout</a></li> <li><div bar="2" class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li><div class="fn"></div>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li> <li><div class="fn"></div>4 signals inherited from <a href="qabstracttextdocumentlayout.html#signals">QAbstractTextDocumentLayout</a></li> <li><div class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li> <li><div class="fn"></div>5 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li> <li><div class="fn"></div>5 protected functions inherited from <a href="qabstracttextdocumentlayout.html#protected-functions">QAbstractTextDocumentLayout</a></li> <li><div class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li> </ul> <a name="details"></a> <hr /> <h2>Detailed Description</h2> <p>The QPlainTextDocumentLayout class implements a plain text layout for <a href="qtextdocument.html">QTextDocument</a></p> <p>A QPlainTextDocumentLayout is required for text documents that can be display or edited in a <a href="qplaintextedit.html">QPlainTextEdit</a>. See <a href="qtextdocument.html#setDocumentLayout">QTextDocument::setDocumentLayout</a>().</p> <p>QPlainTextDocumentLayout uses the <a href="qabstracttextdocumentlayout.html">QAbstractTextDocumentLayout</a> API that <a href="qtextdocument.html">QTextDocument</a> requires, but redefines it partially in order to support plain text better. For instances, it does not operate on vertical pixels, but on paragraphs (called blocks) instead. The height of a document is identical to the number of paragraphs it contains. The layout also doesn't support tables or nested frames, or any sort of advanced text layout that goes beyond a list of paragraphs with syntax highlighting.</p> <hr /> <h2>Property Documentation</h2> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/cursorWidth"></a> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/setCursorWidth"></a> <h3 class="fn"><a name="cursorWidth-prop"></a>cursorWidth : int</h3> <p>This property specifies the width of the cursor in pixels. The default value is 1.</p> <p><b>Access functions:</b></p> <table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b>cursorWidth</b> () const</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b>setCursorWidth</b> ( int <i>width</i> )</td></tr> </table> <hr /> <h2>Member Function Documentation</h2> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/QPlainTextDocumentLayout"></a> <h3 class="fn"><a name="QPlainTextDocumentLayout"></a>QPlainTextDocumentLayout::QPlainTextDocumentLayout ( <a href="qtextdocument.html">QTextDocument</a> * <i>document</i> )</h3> <p>Constructs a plain text document layout for the text <i>document</i>.</p> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/~QPlainTextDocumentLayout"></a> <h3 class="fn"><a name="dtor.QPlainTextDocumentLayout"></a>QPlainTextDocumentLayout::~QPlainTextDocumentLayout ()</h3> <p>Destructs a plain text document layout.</p> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/blockBoundingRect"></a> <h3 class="fn"><a name="blockBoundingRect"></a><a href="qrectf.html">QRectF</a> QPlainTextDocumentLayout::blockBoundingRect ( const <a href="qtextblock.html">QTextBlock</a> & <i>block</i> ) const <tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#blockBoundingRect">QAbstractTextDocumentLayout::blockBoundingRect</a>().</p> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/documentChanged"></a> <h3 class="fn"><a name="documentChanged"></a>void QPlainTextDocumentLayout::documentChanged ( int <i>from</i>, int <i>charsRemoved</i>, int <i>charsAdded</i> ) <tt> [virtual protected]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#documentChanged">QAbstractTextDocumentLayout::documentChanged</a>().</p> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/documentSize"></a> <h3 class="fn"><a name="documentSize"></a><a href="qsizef.html">QSizeF</a> QPlainTextDocumentLayout::documentSize () const <tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#documentSize">QAbstractTextDocumentLayout::documentSize</a>().</p> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/draw"></a> <h3 class="fn"><a name="draw"></a>void QPlainTextDocumentLayout::draw ( <a href="qpainter.html">QPainter</a> *, const <a href="qabstracttextdocumentlayout-paintcontext.html">PaintContext</a> & ) <tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#draw">QAbstractTextDocumentLayout::draw</a>().</p> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/ensureBlockLayout"></a> <h3 class="fn"><a name="ensureBlockLayout"></a>void QPlainTextDocumentLayout::ensureBlockLayout ( const <a href="qtextblock.html">QTextBlock</a> & <i>block</i> ) const</h3> <p>Ensures that <i>block</i> has a valid layout</p> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/frameBoundingRect"></a> <h3 class="fn"><a name="frameBoundingRect"></a><a href="qrectf.html">QRectF</a> QPlainTextDocumentLayout::frameBoundingRect ( <a href="qtextframe.html">QTextFrame</a> * ) const <tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#frameBoundingRect">QAbstractTextDocumentLayout::frameBoundingRect</a>().</p> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/hitTest"></a> <h3 class="fn"><a name="hitTest"></a>int QPlainTextDocumentLayout::hitTest ( const <a href="qpointf.html">QPointF</a> &, <a href="qt.html#HitTestAccuracy-enum">Qt::HitTestAccuracy</a> ) const <tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#hitTest">QAbstractTextDocumentLayout::hitTest</a>().</p> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/pageCount"></a> <h3 class="fn"><a name="pageCount"></a>int QPlainTextDocumentLayout::pageCount () const <tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#pageCount">QAbstractTextDocumentLayout::pageCount</a>().</p> <a name="//apple_ref/cpp/instm/QPlainTextDocumentLayout/requestUpdate"></a> <h3 class="fn"><a name="requestUpdate"></a>void QPlainTextDocumentLayout::requestUpdate ()</h3> <p>Requests a complete update on all views.</p> <p /><address><hr /><div align="center"> <table width="100%" cellspacing="0" border="0"><tr class="address"> <td width="40%" align="left">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies)</td> <td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td> <td width="40%" align="right"><div align="right">Qt 4.6.3</div></td> </tr></table></div></address></body> </html>