File: qplaintextdocumentlayout.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (187 lines) | stat: -rw-r--r-- 14,562 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
<?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/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <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>
<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 &lt;QPlainTextDocumentLayout&gt;</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 &amp; <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 &amp; <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 &amp; )</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 &amp;, 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> &amp; <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> &amp; )<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> &amp; <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> &amp;, <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 class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation 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>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      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>
</body>
</html>