~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QTextObject Class Reference</h1>

<p>The QTextObject 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>

<pre>#include <QTextObject></pre><p>Part of the <a href="qtgui.html">QtGui</a> module.</p>

<p>Inherits <a href="qobject.html">QObject</a>.</p>

<p>Inherited by <a href="qtextblockgroup.html">QTextBlockGroup</a> and <a href="qtextframe.html">QTextFrame</a>.</p>

<ul>

<li><a href="qtextobject-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/>QTextDocument * <b><a href="qtextobject.html#document">document</a></b> () const</li>

<li><div class="fn"/>QTextFormat <b><a href="qtextobject.html#format">format</a></b> () const</li>

<li><div class="fn"/>int <b><a href="qtextobject.html#formatIndex">formatIndex</a></b> () const</li>

<li><div class="fn"/>int <b><a href="qtextobject.html#objectIndex">objectIndex</a></b> () const</li>

</ul>

<ul>

<li><div class="fn"/>28 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>

</ul>

<h3>Protected Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qtextobject.html#QTextObject">QTextObject</a></b> ( QTextDocument * <i>document</i> )</li>

<li><div class="fn"/><b><a href="qtextobject.html#dtor.QTextObject">~QTextObject</a></b> ()</li>

<li><div class="fn"/>void <b><a href="qtextobject.html#setFormat">setFormat</a></b> ( const QTextFormat & <i>format</i> )</li>

</ul>

<ul>

<li><div class="fn"/>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>

</ul>

<h3>Additional Inherited Members</h3>

<ul>

<li><div class="fn"/>1 property inherited from <a href="qobject.html#properties">QObject</a></li>

<li><div class="fn"/>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>

<li><div class="fn"/>4 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QTextObject 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>

<p>See also <a href="qtextdocument.html">QTextDocument</a>.</p>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="QTextObject"></a>QTextObject::QTextObject ( <a href="qtextdocument.html">QTextDocument</a> * <i>document</i> )  <tt> [protected]</tt></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>

<h3 class="fn"><a name="dtor.QTextObject"></a>QTextObject::~QTextObject ()  <tt> [protected]</tt></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>

<h3 class="fn"><a name="document"></a><a href="qtextdocument.html">QTextDocument</a> * QTextObject::document () const</h3>

<p>Returns the document this object belongs to.</p>

<p>See also <a href="qtextobject.html#format">format</a>().</p>

<h3 class="fn"><a name="format"></a><a href="qtextformat.html">QTextFormat</a> QTextObject::format () const</h3>

<p>Returns the text object's format.</p>

<p>See also <a href="qtextobject.html#setFormat">setFormat</a>() and <a href="qtextobject.html#document">document</a>().</p>

<h3 class="fn"><a name="formatIndex"></a>int QTextObject::formatIndex () const</h3>

<p>Returns the index of the object's format in the document's internal list of formats.</p>

<p>See also <a href="qtextdocument.html#object">QTextDocument::object</a>().</p>

<h3 class="fn"><a name="objectIndex"></a>int QTextObject::objectIndex () 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>

<h3 class="fn"><a name="setFormat"></a>void QTextObject::setFormat ( const <a href="qtextformat.html">QTextFormat</a> & <i>format</i> )  <tt> [protected]</tt></h3>

<p>Sets the text object's <i>format</i>.</p>

<p>See also <a href="qtextobject.html#format">format</a>().</p>

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

</tr></table></div></address></body>

</html>

Older »