<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qplaintextedit.cpp --> <title>Qt 4.8: QPlainTextDocumentLayout Class Reference</title> <link rel="stylesheet" type="text/css" href="style/style.css" /> <script src="scripts/jquery.js" type="text/javascript"></script> <script src="scripts/functions.js" type="text/javascript"></script> <link rel="stylesheet" type="text/css" href="style/superfish.css" /> <link rel="stylesheet" type="text/css" href="style/narrow.css" /> <!--[if IE]> <meta name="MSSmartTagsPreventParsing" content="true"> <meta http-equiv="imagetoolbar" content="no"> <![endif]--> <!--[if lt IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie6.css"> <![endif]--> <!--[if IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie7.css"> <![endif]--> <!--[if IE 8]> <link rel="stylesheet" type="text/css" href="style/style_ie8.css"> <![endif]--> <script src="scripts/superfish.js" type="text/javascript"></script> <script src="scripts/narrow.js" type="text/javascript"></script> </head> <body class="" onload="CheckEmptyAndLoadList();"> <div class="header" id="qtdocheader"> <div class="content"> <div id="nav-logo"> <a href="index.html">Home</a></div> <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a> <div id="narrowsearch"></div> <div id="nav-topright"> <ul> <li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li> <li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li> <li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/"> DOC</a></li> <li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li> </ul> </div> <div id="shortCut"> <ul> <li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li> <li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li> </ul> </div> <ul class="sf-menu" id="narrowmenu"> <li><a href="#">API Lookup</a> <ul> <li><a href="classes.html">Class index</a></li> <li><a href="functions.html">Function index</a></li> <li><a href="modules.html">Modules</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="qtglobal.html">Global Declarations</a></li> <li><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </li> <li><a href="#">Qt Topics</a> <ul> <li><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li><a href="supported-platforms.html">Supported Platforms</a></li> <li><a href="technology-apis.html">Qt and Key Technologies</a></li> <li><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </li> <li><a href="#">Examples</a> <ul> <li><a href="all-examples.html">Examples</a></li> <li><a href="tutorials.html">Tutorials</a></li> <li><a href="demos.html">Demos</a></li> <li><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </li> </ul> </div> </div> <div class="wrapper"> <div class="hd"> <span></span> </div> <div class="bd group"> <div class="sidebar"> <div class="searchlabel"> Search index:</div> <div class="search" id="sidebarsearch"> <form id="qtdocsearch" action="" onsubmit="return false;"> <fieldset> <input type="text" name="searchstring" id="pageType" value="" /> <div id="resultdialog"> <a href="#" id="resultclose">Close</a> <p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p> <p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p> <ul id="resultlist" class="all"> </ul> </div> </fieldset> </form> </div> <div class="box first bottombar" id="lookup"> <h2 title="API Lookup"><span></span> API Lookup</h2> <div id="list001" class="list"> <ul id="ul001" > <li class="defaultLink"><a href="classes.html">Class index</a></li> <li class="defaultLink"><a href="functions.html">Function index</a></li> <li class="defaultLink"><a href="modules.html">Modules</a></li> <li class="defaultLink"><a href="namespaces.html">Namespaces</a></li> <li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li> <li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </div> </div> <div class="box bottombar" id="topics"> <h2 title="Qt Topics"><span></span> Qt Topics</h2> <div id="list002" class="list"> <ul id="ul002" > <li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li> <li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li> <li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </div> </div> <div class="box" id="examples"> <h2 title="Examples"><span></span> Examples</h2> <div id="list003" class="list"> <ul id="ul003"> <li class="defaultLink"><a href="all-examples.html">Examples</a></li> <li class="defaultLink"><a href="tutorials.html">Tutorials</a></li> <li class="defaultLink"><a href="demos.html">Demos</a></li> <li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </div> </div> </div> <div class="wrap"> <div class="toolbar"> <div class="breadcrumb toolblock"> <ul> <li class="first"><a href="index.html">Home</a></li> <!-- Breadcrumbs go here --> <li><a href="modules.html">Modules</a></li> <li><a href="qtgui.html">QtGui</a></li> <li>QPlainTextDocumentLayout</li> </ul> </div> <div class="toolbuttons toolblock"> <ul> <li id="smallA" class="t_button">A</li> <li id="medA" class="t_button active">A</li> <li id="bigA" class="t_button">A</li> <li id="print" class="t_button"><a href="javascript:this.print();"> <span>Print</span></a></li> </ul> </div> </div> <div class="content mainContent"> <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="#protected-functions">Protected Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <h1 class="title">QPlainTextDocumentLayout Class Reference</h1> <!-- $$$QPlainTextDocumentLayout-brief --> <p>The QPlainTextDocumentLayout class implements a plain text layout for <a href="qtextdocument.html">QTextDocument</a> <a href="#details">More...</a></p> <!-- @@@QPlainTextDocumentLayout --> <pre class="cpp"> <span class="preprocessor">#include <QPlainTextDocumentLayout></span></pre><p><b>Inherits: </b><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> <a name="properties"></a> <h2>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="qobject.html#properties">QObject</a></li> </ul> <a name="public-functions"></a> <h2>Public Functions</h2> <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"> </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> <a name="reimplemented-public-functions"></a> <h2>Reimplemented Public Functions</h2> <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</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</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#draw">draw</a></b> ( QPainter *, const PaintContext & )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QRectF </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#frameBoundingRect">frameBoundingRect</a></b> ( QTextFrame * ) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qplaintextdocumentlayout.html#hitTest">hitTest</a></b> ( const QPointF &, Qt::HitTestAccuracy ) const</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</td></tr> </table> <ul> <li class="fn">12 public functions inherited from <a href="qabstracttextdocumentlayout.html#public-functions">QAbstractTextDocumentLayout</a></li> <li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li> </ul> <a name="reimplemented-protected-functions"></a> <h2>Reimplemented Protected Functions</h2> <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> )</td></tr> </table> <ul> <li class="fn">5 protected functions inherited from <a href="qabstracttextdocumentlayout.html#protected-functions">QAbstractTextDocumentLayout</a></li> <li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li> <li class="fn">4 signals inherited from <a href="qabstracttextdocumentlayout.html#signals">QAbstractTextDocumentLayout</a></li> <li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li> <li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li> <li class="fn">5 protected functions inherited from <a href="qabstracttextdocumentlayout.html#protected-functions">QAbstractTextDocumentLayout</a></li> <li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li> </ul> <a name="details"></a> <!-- $$$QPlainTextDocumentLayout-description --> <div class="descr"> <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> </div> <!-- @@@QPlainTextDocumentLayout --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$cursorWidth-prop$$$cursorWidth$$$setCursorWidthint --> <h3 class="fn"><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> <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> <!-- @@@cursorWidth --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QPlainTextDocumentLayout[overload1]$$$QPlainTextDocumentLayoutQTextDocument* --> <h3 class="fn"><a name="QPlainTextDocumentLayout"></a>QPlainTextDocumentLayout::<span class="name">QPlainTextDocumentLayout</span> ( <span class="type"><a href="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"><a name="dtor.QPlainTextDocumentLayout"></a>QPlainTextDocumentLayout::<span class="name">~QPlainTextDocumentLayout</span> ()</h3> <p>Destructs a plain text document layout.</p> <!-- @@@~QPlainTextDocumentLayout --> <!-- $$$blockBoundingRect[overload1]$$$blockBoundingRectconstQTextBlock& --> <h3 class="fn"><a name="blockBoundingRect"></a><span class="type"><a href="qrectf.html">QRectF</a></span> QPlainTextDocumentLayout::<span class="name">blockBoundingRect</span> ( const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> & <i>block</i> ) const<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#blockBoundingRect">QAbstractTextDocumentLayout::blockBoundingRect</a>().</p> <!-- @@@blockBoundingRect --> <!-- $$$documentChanged[overload1]$$$documentChangedintintint --> <h3 class="fn"><a name="documentChanged"></a><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> )<tt> [virtual protected]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#documentChanged">QAbstractTextDocumentLayout::documentChanged</a>().</p> <!-- @@@documentChanged --> <!-- $$$documentSize[overload1]$$$documentSize --> <h3 class="fn"><a name="documentSize"></a><span class="type"><a href="qsizef.html">QSizeF</a></span> QPlainTextDocumentLayout::<span class="name">documentSize</span> () const<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#documentSize">QAbstractTextDocumentLayout::documentSize</a>().</p> <!-- @@@documentSize --> <!-- $$$draw[overload1]$$$drawQPainter*constPaintContext& --> <h3 class="fn"><a name="draw"></a><span class="type">void</span> QPlainTextDocumentLayout::<span class="name">draw</span> ( <span class="type"><a href="qpainter.html">QPainter</a></span> *, const <span class="type"><a href="qabstracttextdocumentlayout-paintcontext.html">PaintContext</a></span> & )<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#draw">QAbstractTextDocumentLayout::draw</a>().</p> <!-- @@@draw --> <!-- $$$ensureBlockLayout[overload1]$$$ensureBlockLayoutconstQTextBlock& --> <h3 class="fn"><a name="ensureBlockLayout"></a><span class="type">void</span> QPlainTextDocumentLayout::<span class="name">ensureBlockLayout</span> ( const <span class="type"><a href="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"><a name="frameBoundingRect"></a><span class="type"><a href="qrectf.html">QRectF</a></span> QPlainTextDocumentLayout::<span class="name">frameBoundingRect</span> ( <span class="type"><a href="qtextframe.html">QTextFrame</a></span> * ) const<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#frameBoundingRect">QAbstractTextDocumentLayout::frameBoundingRect</a>().</p> <!-- @@@frameBoundingRect --> <!-- $$$hitTest[overload1]$$$hitTestconstQPointF&Qt::HitTestAccuracy --> <h3 class="fn"><a name="hitTest"></a><span class="type">int</span> QPlainTextDocumentLayout::<span class="name">hitTest</span> ( const <span class="type"><a href="qpointf.html">QPointF</a></span> &, <span class="type"><a href="qt.html#HitTestAccuracy-enum">Qt::HitTestAccuracy</a></span> ) const<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#hitTest">QAbstractTextDocumentLayout::hitTest</a>().</p> <!-- @@@hitTest --> <!-- $$$pageCount[overload1]$$$pageCount --> <h3 class="fn"><a name="pageCount"></a><span class="type">int</span> QPlainTextDocumentLayout::<span class="name">pageCount</span> () const<tt> [virtual]</tt></h3> <p>Reimplemented from <a href="qabstracttextdocumentlayout.html#pageCount">QAbstractTextDocumentLayout::pageCount</a>().</p> <!-- @@@pageCount --> <!-- $$$requestUpdate[overload1]$$$requestUpdate --> <h3 class="fn"><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 class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its subsidiaries. Documentation contributions included herein are the copyrights of their respective owners.</p> <br /> <p> 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.</p> <p> Documentation sources may be obtained from <a href="http://www.qt-project.org"> www.qt-project.org</a>.</p> <br /> <p> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. <a title="Privacy Policy" href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p> </div> <script src="scripts/functions.js" type="text/javascript"></script> </body> </html>