qtextobject.html 10.5 KB
Newer Older
xuebingbing's avatar
xuebingbing committed
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtextobject.cpp -->
  <title>QTextObject Class | Qt GUI 5.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></td><td ><a href="qtgui-index.html">Qt GUI</a></td><td ><a href="qtgui-module.html">C++ Classes</a></td><td >QTextObject</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.11.2 Reference Documentation</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="#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>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QTextObject Class</h1>
<!-- $$$QTextObject-brief -->
<p>The <a href="qtextobject.html">QTextObject</a> class is a base class for different kinds of objects that can group parts of a <a href="qtextdocument.html">QTextDocument</a> together. <a href="#details">More...</a></p>
<!-- @@@QTextObject -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QTextObject&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += gui</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qobject.html">QObject</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qtextblockgroup.html">QTextBlockGroup</a> and <a href="qtextframe.html">QTextFrame</a></p>
</td></tr></table></div><ul>
<li><a href="qtextobject-members.html">List of all members, including inherited members</a></li>
</ul>
<p><b>Note:</b> All functions in this class are <a href="../qtdoc/threads-reentrancy.html">reentrant</a>.</p>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QTextDocument *</td><td class="memItemRight bottomAlign"><b><a href="qtextobject.html#document">document</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextobject.html#format">format</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextobject.html#formatIndex">formatIndex</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextobject.html#objectIndex">objectIndex</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">34 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextobject.html#QTextObject">QTextObject</a></b>(QTextDocument *<i>document</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qtextobject.html#dtor.QTextObject">~QTextObject</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextobject.html#setFormat">setFormat</a></b>(const QTextFormat &amp;<i>format</i>)</td></tr>
</table></div>
<ul>
<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 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QTextObject-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qtextobject.html">QTextObject</a> class is a base class for different kinds of objects that can group parts of a <a href="qtextdocument.html">QTextDocument</a> together.</p>
<p>The common grouping text objects are lists (<a href="qtextlist.html">QTextList</a>), frames (<a href="qtextframe.html">QTextFrame</a>), and tables (<a href="qtexttable.html">QTextTable</a>). A text object has an associated <a href="qtextobject.html#format">format</a>() and <a href="qtextobject.html#document">document</a>().</p>
<p>There are essentially two kinds of text objects: those that are used with blocks (block formats), and those that are used with characters (character formats). The first kind are derived from <a href="qtextblockgroup.html">QTextBlockGroup</a>, and the second kind from <a href="qtextframe.html">QTextFrame</a>.</p>
<p>You rarely need to use this class directly. When creating custom text objects, you will also need to reimplement <a href="qtextdocument.html#createObject">QTextDocument::createObject</a>() which acts as a factory method for creating text objects.</p>
</div>
<p><b>See also </b><a href="qtextdocument.html">QTextDocument</a> and <a href="../qtsvg/qtsvg-richtext-textobject-example.html">Text Object Example</a>.</p>
<!-- @@@QTextObject -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextObject[overload1]$$$QTextObjectQTextDocument* -->
<h3 class="fn" id="QTextObject"><a name="QTextObject"></a><code>[protected] </code>QTextObject::<span class="name">QTextObject</span>(<span class="type"><a href="qtextdocument.html">QTextDocument</a></span> *<i>document</i>)</h3>
<p>Creates a new <a href="qtextobject.html">QTextObject</a> for the given <i>document</i>.</p>
<p><b>Warning:</b> This function should never be called directly, but only from <a href="qtextdocument.html#createObject">QTextDocument::createObject</a>().</p>
<!-- @@@QTextObject -->
<!-- $$$~QTextObject[overload1]$$$~QTextObject -->
<h3 class="fn" id="dtor.QTextObject"><a name="dtor.QTextObject"></a><code>[virtual protected] </code>QTextObject::<span class="name">~QTextObject</span>()</h3>
<p>Destroys the text object.</p>
<p><b>Warning:</b> Text objects are owned by the document, so you should never destroy them yourself.</p>
<!-- @@@~QTextObject -->
<!-- $$$document[overload1]$$$document -->
<h3 class="fn" id="document"><a name="document"></a><span class="type"><a href="qtextdocument.html">QTextDocument</a></span> *QTextObject::<span class="name">document</span>() const</h3>
<p>Returns the document this object belongs to.</p>
<p><b>See also </b><a href="qtextobject.html#format">format</a>().</p>
<!-- @@@document -->
<!-- $$$format[overload1]$$$format -->
<h3 class="fn" id="format"><a name="format"></a><span class="type"><a href="qtextformat.html">QTextFormat</a></span> QTextObject::<span class="name">format</span>() const</h3>
<p>Returns the text object's format.</p>
<p><b>See also </b><a href="qtextobject.html#setFormat">setFormat</a>() and <a href="qtextobject.html#document">document</a>().</p>
<!-- @@@format -->
<!-- $$$formatIndex[overload1]$$$formatIndex -->
<h3 class="fn" id="formatIndex"><a name="formatIndex"></a><span class="type">int</span> QTextObject::<span class="name">formatIndex</span>() const</h3>
<p>Returns the index of the object's format in the document's internal list of formats.</p>
<p><b>See also </b><a href="qtextdocument.html#allFormats">QTextDocument::allFormats</a>().</p>
<!-- @@@formatIndex -->
<!-- $$$objectIndex[overload1]$$$objectIndex -->
<h3 class="fn" id="objectIndex"><a name="objectIndex"></a><span class="type">int</span> QTextObject::<span class="name">objectIndex</span>() const</h3>
<p>Returns the object index of this object. This can be used together with <a href="qtextformat.html#setObjectIndex">QTextFormat::setObjectIndex</a>().</p>
<!-- @@@objectIndex -->
<!-- $$$setFormat[overload1]$$$setFormatconstQTextFormat& -->
<h3 class="fn" id="setFormat"><a name="setFormat"></a><code>[protected] </code><span class="type">void</span> QTextObject::<span class="name">setFormat</span>(const <span class="type"><a href="qtextformat.html">QTextFormat</a></span> &amp;<i>format</i>)</h3>
<p>Sets the text object's <i>format</i>.</p>
<p><b>See also </b><a href="qtextobject.html#format">format</a>().</p>
<!-- @@@setFormat -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2018 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>