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
|
<?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" />
<!-- qtextobject.cpp -->
<title>Qt 4.8: QTextBlockGroup 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>QTextBlockGroup</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<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">QTextBlockGroup Class Reference</h1>
<!-- $$$QTextBlockGroup-brief -->
<p>The QTextBlockGroup class provides a container for text blocks within a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<!-- @@@QTextBlockGroup -->
<pre class="cpp"> <span class="preprocessor">#include <QTextBlockGroup></span></pre><p><b>Inherits: </b><a href="qtextobject.html">QTextObject</a>.</p>
<p><b>Inherited by: </b><a href="qtextlist.html">QTextList</a>.</p>
<p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qtextblockgroup-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextblockgroup.html#QTextBlockGroup">QTextBlockGroup</a></b> ( QTextDocument * <i>document</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextblockgroup.html#dtor.QTextBlockGroup">~QTextBlockGroup</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockgroup.html#blockFormatChanged">blockFormatChanged</a></b> ( const QTextBlock & <i>block</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockgroup.html#blockInserted">blockInserted</a></b> ( const QTextBlock & <i>block</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QTextBlock> </td><td class="memItemRight bottomAlign"><b><a href="qtextblockgroup.html#blockList">blockList</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockgroup.html#blockRemoved">blockRemoved</a></b> ( const QTextBlock & <i>block</i> )</td></tr>
</table>
<ul>
<li class="fn">1 protected function inherited from <a href="qtextobject.html#protected-functions">QTextObject</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 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">4 public functions inherited from <a href="qtextobject.html#public-functions">QTextObject</a></li>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</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>
</ul>
<a name="details"></a>
<!-- $$$QTextBlockGroup-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QTextBlockGroup class provides a container for text blocks within a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>Block groups can be used to organize blocks of text within a document. They maintain an up-to-date list of the text blocks that belong to them, even when text blocks are being edited.</p>
<p>Each group has a parent document which is specified when the group is constructed.</p>
<p>Text blocks can be inserted into a group with <a href="qtextblockgroup.html#blockInserted">blockInserted</a>(), and removed with <a href="qtextblockgroup.html#blockRemoved">blockRemoved</a>(). If a block's format is changed, <a href="qtextblockgroup.html#blockFormatChanged">blockFormatChanged</a>() is called.</p>
<p>The list of blocks in the group is returned by <a href="qtextblockgroup.html#blockList">blockList</a>(). Note that the blocks in the list are not necessarily adjacent elements in the document; for example, the top-level items in a multi-level list will be separated by the items in lower levels of the list.</p>
</div>
<p><b>See also </b><a href="qtextblock.html">QTextBlock</a> and <a href="qtextdocument.html">QTextDocument</a>.</p>
<!-- @@@QTextBlockGroup -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextBlockGroup[overload1]$$$QTextBlockGroupQTextDocument* -->
<h3 class="fn"><a name="QTextBlockGroup"></a>QTextBlockGroup::<span class="name">QTextBlockGroup</span> ( <span class="type"><a href="qtextdocument.html">QTextDocument</a></span> * <i>document</i> )<tt> [protected]</tt></h3>
<p>Creates a new new block group for the given <i>document</i>.</p>
<p><b>Warning:</b> This function should only be called from <a href="qtextdocument.html#createObject">QTextDocument::createObject</a>().</p>
<!-- @@@QTextBlockGroup -->
<!-- $$$~QTextBlockGroup[overload1]$$$~QTextBlockGroup -->
<h3 class="fn"><a name="dtor.QTextBlockGroup"></a>QTextBlockGroup::<span class="name">~QTextBlockGroup</span> ()<tt> [protected]</tt></h3>
<p>Destroys this block group; the blocks are not deleted, they simply don't belong to this block anymore.</p>
<!-- @@@~QTextBlockGroup -->
<!-- $$$blockFormatChanged[overload1]$$$blockFormatChangedconstQTextBlock& -->
<h3 class="fn"><a name="blockFormatChanged"></a><span class="type">void</span> QTextBlockGroup::<span class="name">blockFormatChanged</span> ( const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> & <i>block</i> )<tt> [virtual protected]</tt></h3>
<p>This function is called whenever the specified <i>block</i> of text is changed. The text block is a member of this group.</p>
<p>The base class implementation does nothing.</p>
<!-- @@@blockFormatChanged -->
<!-- $$$blockInserted[overload1]$$$blockInsertedconstQTextBlock& -->
<h3 class="fn"><a name="blockInserted"></a><span class="type">void</span> QTextBlockGroup::<span class="name">blockInserted</span> ( const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> & <i>block</i> )<tt> [virtual protected]</tt></h3>
<p>Appends the given <i>block</i> to the end of the group.</p>
<p><b>Warning:</b> If you reimplement this function you must call the base class implementation.</p>
<!-- @@@blockInserted -->
<!-- $$$blockList[overload1]$$$blockList -->
<h3 class="fn"><a name="blockList"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qtextblock.html">QTextBlock</a></span>> QTextBlockGroup::<span class="name">blockList</span> () const<tt> [protected]</tt></h3>
<p>Returns a (possibly empty) list of all the blocks that are part of the block group.</p>
<!-- @@@blockList -->
<!-- $$$blockRemoved[overload1]$$$blockRemovedconstQTextBlock& -->
<h3 class="fn"><a name="blockRemoved"></a><span class="type">void</span> QTextBlockGroup::<span class="name">blockRemoved</span> ( const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> & <i>block</i> )<tt> [virtual protected]</tt></h3>
<p>Removes the given <i>block</i> from the group; the block itself is not deleted, it simply isn't a member of this group anymore.</p>
<!-- @@@blockRemoved -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
|