<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qplaintextedit.cpp --> <title>QPlainTextDocumentLayout Class | Qt Widgets 5.12.2</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.12</td><td ><a href="qtwidgets-index.html">Qt Widgets</a></td><td ><a href="qtwidgets-module.html">C++ Classes</a></td><td >QPlainTextDocumentLayout</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtwidgets-index.html">Qt 5.12.2 Reference Documentation</a></td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#properties">Properties</a></li> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li> <li class="level1"><a href="#static-public-members">Static Public Members</a></li> <li class="level1"><a href="#reimplemented-protected-functions">Reimplemented Protected Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QPlainTextDocumentLayout Class</h1> <!-- $$$QPlainTextDocumentLayout-brief --> <p>The <a href="qplaintextdocumentlayout.html">QPlainTextDocumentLayout</a> class implements a plain text layout for <a href="../qtgui/qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p> <!-- @@@QPlainTextDocumentLayout --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QPlainTextDocumentLayout></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += widgets</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.4</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtgui/qabstracttextdocumentlayout.html">QAbstractTextDocumentLayout</a></td></tr></table></div><ul> <li><a href="qplaintextdocumentlayout-members.html">List of all members, including inherited members</a></li> <li><a href="qplaintextdocumentlayout-obsolete.html">Obsolete members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><a href="qplaintextdocumentlayout.html#cursorWidth-prop">cursorWidth</a></b> : int</li> </ul> <ul> <li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li> </ul> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#QPlainTextDocumentLayout">QPlainTextDocumentLayout</a></b>(QTextDocument *<i>document</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#dtor.QPlainTextDocumentLayout">~QPlainTextDocumentLayout</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#cursorWidth-prop">cursorWidth</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#ensureBlockLayout">ensureBlockLayout</a></b>(const QTextBlock &<i>block</i>) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#requestUpdate">requestUpdate</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#cursorWidth-prop">setCursorWidth</a></b>(int <i>width</i>)</td></tr> </table></div> <a name="reimplemented-public-functions"></a> <h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual QRectF </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#blockBoundingRect">blockBoundingRect</a></b>(const QTextBlock &<i>block</i>) const override</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QSizeF </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#documentSize">documentSize</a></b>() const override</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#draw">draw</a></b>(<i>QPainter *</i>, <i>const QAbstractTextDocumentLayout::PaintContext &</i>) override</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QRectF </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#frameBoundingRect">frameBoundingRect</a></b>(<i>QTextFrame *</i>) const override</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#hitTest">hitTest</a></b>(<i>const QPointF &</i>, <i>Qt::HitTestAccuracy</i>) const override</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#pageCount">pageCount</a></b>() const override</td></tr> </table></div> <ul> <li class="fn">15 public functions inherited from <a href="../qtgui/qabstracttextdocumentlayout.html#public-functions">QAbstractTextDocumentLayout</a></li> <li class="fn">31 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li> </ul> <a name="static-public-members"></a> <h2 id="static-public-members">Static Public Members</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <ul> <li class="fn">9 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li> </ul> <a name="reimplemented-protected-functions"></a> <h2 id="reimplemented-protected-functions">Reimplemented Protected Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#documentChanged">documentChanged</a></b>(int <i>from</i>, int <i>charsRemoved</i>, int <i>charsAdded</i>) override</td></tr> </table></div> <ul> <li class="fn">5 protected functions inherited from <a href="../qtgui/qabstracttextdocumentlayout.html#protected-functions">QAbstractTextDocumentLayout</a></li> <li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li> <li class="fn">4 signals inherited from <a href="../qtgui/qabstracttextdocumentlayout.html#signals">QAbstractTextDocumentLayout</a></li> <li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li> <li class="fn">5 protected functions inherited from <a href="../qtgui/qabstracttextdocumentlayout.html#protected-functions">QAbstractTextDocumentLayout</a></li> <li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li> </ul> <a name="details"></a> <!-- $$$QPlainTextDocumentLayout-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qplaintextdocumentlayout.html">QPlainTextDocumentLayout</a> class implements a plain text layout for <a href="../qtgui/qtextdocument.html">QTextDocument</a>.</p> <p>A <a href="qplaintextdocumentlayout.html">QPlainTextDocumentLayout</a> is required for text documents that can be display or edited in a <a href="qplaintextedit.html">QPlainTextEdit</a>. See <a href="../qtgui/qtextdocument.html#setDocumentLayout">QTextDocument::setDocumentLayout</a>().</p> <p><a href="qplaintextdocumentlayout.html">QPlainTextDocumentLayout</a> uses the <a href="../qtgui/qabstracttextdocumentlayout.html">QAbstractTextDocumentLayout</a> API that <a href="../qtgui/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> </div> <!-- @@@QPlainTextDocumentLayout --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$cursorWidth-prop$$$cursorWidth$$$setCursorWidthint --> <h3 class="fn" id="cursorWidth-prop"><a name="cursorWidth-prop"></a><span class="name">cursorWidth</span> : <span class="type">int</span></h3> <p>This property specifies the width of the cursor in pixels. The default value is 1.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>cursorWidth</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setCursorWidth</b></span>(int <i>width</i>)</td></tr> </table></div> <!-- @@@cursorWidth --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QPlainTextDocumentLayout[overload1]$$$QPlainTextDocumentLayoutQTextDocument* --> <h3 class="fn" id="QPlainTextDocumentLayout"><a name="QPlainTextDocumentLayout"></a>QPlainTextDocumentLayout::<span class="name">QPlainTextDocumentLayout</span>(<span class="type"><a href="../qtgui/qtextdocument.html">QTextDocument</a></span> *<i>document</i>)</h3> <p>Constructs a plain text document layout for the text <i>document</i>.</p> <!-- @@@QPlainTextDocumentLayout --> <!-- $$$~QPlainTextDocumentLayout[overload1]$$$~QPlainTextDocumentLayout --> <h3 class="fn" id="dtor.QPlainTextDocumentLayout"><a name="dtor.QPlainTextDocumentLayout"></a><code>[virtual] </code>QPlainTextDocumentLayout::<span class="name">~QPlainTextDocumentLayout</span>()</h3> <p>Destructs a plain text document layout.</p> <!-- @@@~QPlainTextDocumentLayout --> <!-- $$$blockBoundingRect[overload1]$$$blockBoundingRectconstQTextBlock& --> <h3 class="fn" id="blockBoundingRect"><a name="blockBoundingRect"></a><code>[override virtual] </code><span class="type"><a href="../qtcore/qrectf.html">QRectF</a></span> QPlainTextDocumentLayout::<span class="name">blockBoundingRect</span>(const <span class="type"><a href="../qtgui/qtextblock.html">QTextBlock</a></span> &<i>block</i>) const</h3> <p>Reimplemented from <a href="../qtgui/qabstracttextdocumentlayout.html#blockBoundingRect">QAbstractTextDocumentLayout::blockBoundingRect</a>().</p> <!-- @@@blockBoundingRect --> <!-- $$$documentChanged[overload1]$$$documentChangedintintint --> <h3 class="fn" id="documentChanged"><a name="documentChanged"></a><code>[override virtual protected] </code><span class="type">void</span> QPlainTextDocumentLayout::<span class="name">documentChanged</span>(<span class="type">int</span> <i>from</i>, <span class="type">int</span> <i>charsRemoved</i>, <span class="type">int</span> <i>charsAdded</i>)</h3> <p>Reimplemented from <a href="../qtgui/qabstracttextdocumentlayout.html#documentChanged">QAbstractTextDocumentLayout::documentChanged</a>().</p> <!-- @@@documentChanged --> <!-- $$$documentSize[overload1]$$$documentSize --> <h3 class="fn" id="documentSize"><a name="documentSize"></a><code>[override virtual] </code><span class="type"><a href="../qtcore/qsizef.html">QSizeF</a></span> QPlainTextDocumentLayout::<span class="name">documentSize</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qabstracttextdocumentlayout.html#documentSize">QAbstractTextDocumentLayout::documentSize</a>().</p> <!-- @@@documentSize --> <!-- $$$draw[overload1]$$$drawQPainter*constQAbstractTextDocumentLayout::PaintContext& --> <h3 class="fn" id="draw"><a name="draw"></a><code>[override virtual] </code><span class="type">void</span> QPlainTextDocumentLayout::<span class="name">draw</span>(<i>QPainter *</i>, <i>const QAbstractTextDocumentLayout::PaintContext &</i>)</h3> <p>Reimplemented from <a href="../qtgui/qabstracttextdocumentlayout.html#draw">QAbstractTextDocumentLayout::draw</a>().</p> <!-- @@@draw --> <!-- $$$ensureBlockLayout[overload1]$$$ensureBlockLayoutconstQTextBlock& --> <h3 class="fn" id="ensureBlockLayout"><a name="ensureBlockLayout"></a><span class="type">void</span> QPlainTextDocumentLayout::<span class="name">ensureBlockLayout</span>(const <span class="type"><a href="../qtgui/qtextblock.html">QTextBlock</a></span> &<i>block</i>) const</h3> <p>Ensures that <i>block</i> has a valid layout</p> <!-- @@@ensureBlockLayout --> <!-- $$$frameBoundingRect[overload1]$$$frameBoundingRectQTextFrame* --> <h3 class="fn" id="frameBoundingRect"><a name="frameBoundingRect"></a><code>[override virtual] </code><span class="type"><a href="../qtcore/qrectf.html">QRectF</a></span> QPlainTextDocumentLayout::<span class="name">frameBoundingRect</span>(<i>QTextFrame *</i>) const</h3> <p>Reimplemented from <a href="../qtgui/qabstracttextdocumentlayout.html#frameBoundingRect">QAbstractTextDocumentLayout::frameBoundingRect</a>().</p> <!-- @@@frameBoundingRect --> <!-- $$$hitTest[overload1]$$$hitTestconstQPointF&Qt::HitTestAccuracy --> <h3 class="fn" id="hitTest"><a name="hitTest"></a><code>[override virtual] </code><span class="type">int</span> QPlainTextDocumentLayout::<span class="name">hitTest</span>(<i>const QPointF &</i>, <i>Qt::HitTestAccuracy</i>) const</h3> <p>Reimplemented from <a href="../qtgui/qabstracttextdocumentlayout.html#hitTest">QAbstractTextDocumentLayout::hitTest</a>().</p> <!-- @@@hitTest --> <!-- $$$pageCount[overload1]$$$pageCount --> <h3 class="fn" id="pageCount"><a name="pageCount"></a><code>[override virtual] </code><span class="type">int</span> QPlainTextDocumentLayout::<span class="name">pageCount</span>() const</h3> <p>Reimplemented from <a href="../qtgui/qabstracttextdocumentlayout.html#pageCount">QAbstractTextDocumentLayout::pageCount</a>().</p> <!-- @@@pageCount --> <!-- $$$requestUpdate[overload1]$$$requestUpdate --> <h3 class="fn" id="requestUpdate"><a name="requestUpdate"></a><span class="type">void</span> QPlainTextDocumentLayout::<span class="name">requestUpdate</span>()</h3> <p>Requests a complete update on all views.</p> <!-- @@@requestUpdate --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. </p> </div> </body> </html>