<?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" />
<!-- qtextlayout.cpp -->
<title>Qt 4.8: QTextInlineObject 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>QTextInlineObject</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QTextInlineObject Class Reference</h1>
<!-- $$$QTextInlineObject-brief -->
<p>The QTextInlineObject class represents an inline object in a <a href="qtextlayout.html">QTextLayout</a>. <a href="#details">More...</a></p>
<!-- @@@QTextInlineObject -->
<pre class="cpp"> <span class="preprocessor">#include <QTextInlineObject></span></pre><p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qtextinlineobject-members.html">List of all members, including inherited members</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="qtextinlineobject.html#QTextInlineObject">QTextInlineObject</a></b> ( int <i>i</i>, QTextEngine * <i>e</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#ascent">ascent</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#descent">descent</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#format">format</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#formatIndex">formatIndex</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#height">height</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRectF </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#rect">rect</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#setAscent">setAscent</a></b> ( qreal <i>a</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#setDescent">setDescent</a></b> ( qreal <i>d</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#setWidth">setWidth</a></b> ( qreal <i>w</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::LayoutDirection </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#textDirection">textDirection</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#textPosition">textPosition</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextinlineobject.html#width">width</a></b> () const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QTextInlineObject-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QTextInlineObject class represents an inline object in a <a href="qtextlayout.html">QTextLayout</a>.</p>
<p>This class is only used if the text layout is used to lay out parts of a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>The inline object has various attributes that can be set, for example using, <a href="qtextinlineobject.html#setWidth">setWidth</a>(), <a href="qtextinlineobject.html#setAscent">setAscent</a>(), and <a href="qtextinlineobject.html#setDescent">setDescent</a>(). The rectangle it occupies is given by <a href="qtextinlineobject.html#rect">rect</a>(), and its direction by isRightToLeft(). Its position in the text layout is given by at(), and its format is given by <a href="qtextinlineobject.html#format">format</a>().</p>
</div>
<!-- @@@QTextInlineObject -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextInlineObject[overload1]$$$QTextInlineObjectintQTextEngine* -->
<h3 class="fn"><a name="QTextInlineObject"></a>QTextInlineObject::<span class="name">QTextInlineObject</span> ( <span class="type">int</span> <i>i</i>, <span class="type">QTextEngine</span> * <i>e</i> )</h3>
<p>Creates a new inline object for the item at position <i>i</i> in the text engine <i>e</i>.</p>
<!-- @@@QTextInlineObject -->
<!-- $$$ascent[overload1]$$$ascent -->
<h3 class="fn"><a name="ascent"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextInlineObject::<span class="name">ascent</span> () const</h3>
<p>Returns the inline object's ascent.</p>
<p><b>See also </b><a href="qtextinlineobject.html#setAscent">setAscent</a>(), <a href="qtextinlineobject.html#descent">descent</a>(), <a href="qtextinlineobject.html#width">width</a>(), and <a href="qtextinlineobject.html#rect">rect</a>().</p>
<!-- @@@ascent -->
<!-- $$$descent[overload1]$$$descent -->
<h3 class="fn"><a name="descent"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextInlineObject::<span class="name">descent</span> () const</h3>
<p>Returns the inline object's descent.</p>
<p><b>See also </b><a href="qtextinlineobject.html#setDescent">setDescent</a>(), <a href="qtextinlineobject.html#ascent">ascent</a>(), <a href="qtextinlineobject.html#width">width</a>(), and <a href="qtextinlineobject.html#rect">rect</a>().</p>
<!-- @@@descent -->
<!-- $$$format[overload1]$$$format -->
<h3 class="fn"><a name="format"></a><span class="type"><a href="qtextformat.html">QTextFormat</a></span> QTextInlineObject::<span class="name">format</span> () const</h3>
<p>Returns format of the inline object within the text layout.</p>
<!-- @@@format -->
<!-- $$$formatIndex[overload1]$$$formatIndex -->
<h3 class="fn"><a name="formatIndex"></a><span class="type">int</span> QTextInlineObject::<span class="name">formatIndex</span> () const</h3>
<p>Returns an integer describing the format of the inline object within the text layout.</p>
<!-- @@@formatIndex -->
<!-- $$$height[overload1]$$$height -->
<h3 class="fn"><a name="height"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextInlineObject::<span class="name">height</span> () const</h3>
<p>Returns the inline object's total height. This is equal to <a href="qtextinlineobject.html#ascent">ascent</a>() + <a href="qtextinlineobject.html#descent">descent</a>() + 1.</p>
<p><b>See also </b><a href="qtextinlineobject.html#ascent">ascent</a>(), <a href="qtextinlineobject.html#descent">descent</a>(), <a href="qtextinlineobject.html#width">width</a>(), and <a href="qtextinlineobject.html#rect">rect</a>().</p>
<!-- @@@height -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QTextInlineObject::<span class="name">isValid</span> () const</h3>
<p>Returns true if this inline object is valid; otherwise returns false.</p>
<!-- @@@isValid -->
<!-- $$$rect[overload1]$$$rect -->
<h3 class="fn"><a name="rect"></a><span class="type"><a href="qrectf.html">QRectF</a></span> QTextInlineObject::<span class="name">rect</span> () const</h3>
<p>Returns the inline object's rectangle.</p>
<p><b>See also </b><a href="qtextinlineobject.html#ascent">ascent</a>(), <a href="qtextinlineobject.html#descent">descent</a>(), and <a href="qtextinlineobject.html#width">width</a>().</p>
<!-- @@@rect -->
<!-- $$$setAscent[overload1]$$$setAscentqreal -->
<h3 class="fn"><a name="setAscent"></a><span class="type">void</span> QTextInlineObject::<span class="name">setAscent</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>a</i> )</h3>
<p>Sets the inline object's ascent to <i>a</i>.</p>
<p><b>See also </b><a href="qtextinlineobject.html#ascent">ascent</a>(), <a href="qtextinlineobject.html#setDescent">setDescent</a>(), <a href="qtextinlineobject.html#width">width</a>(), and <a href="qtextinlineobject.html#rect">rect</a>().</p>
<!-- @@@setAscent -->
<!-- $$$setDescent[overload1]$$$setDescentqreal -->
<h3 class="fn"><a name="setDescent"></a><span class="type">void</span> QTextInlineObject::<span class="name">setDescent</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>d</i> )</h3>
<p>Sets the inline object's decent to <i>d</i>.</p>
<p><b>See also </b><a href="qtextinlineobject.html#descent">descent</a>(), <a href="qtextinlineobject.html#setAscent">setAscent</a>(), <a href="qtextinlineobject.html#width">width</a>(), and <a href="qtextinlineobject.html#rect">rect</a>().</p>
<!-- @@@setDescent -->
<!-- $$$setWidth[overload1]$$$setWidthqreal -->
<h3 class="fn"><a name="setWidth"></a><span class="type">void</span> QTextInlineObject::<span class="name">setWidth</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>w</i> )</h3>
<p>Sets the inline object's width to <i>w</i>.</p>
<p><b>See also </b><a href="qtextinlineobject.html#width">width</a>(), <a href="qtextinlineobject.html#ascent">ascent</a>(), <a href="qtextinlineobject.html#descent">descent</a>(), and <a href="qtextinlineobject.html#rect">rect</a>().</p>
<!-- @@@setWidth -->
<!-- $$$textDirection[overload1]$$$textDirection -->
<h3 class="fn"><a name="textDirection"></a><span class="type"><a href="qt.html#LayoutDirection-enum">Qt::LayoutDirection</a></span> QTextInlineObject::<span class="name">textDirection</span> () const</h3>
<p>Returns if the object should be laid out right-to-left or left-to-right.</p>
<!-- @@@textDirection -->
<!-- $$$textPosition[overload1]$$$textPosition -->
<h3 class="fn"><a name="textPosition"></a><span class="type">int</span> QTextInlineObject::<span class="name">textPosition</span> () const</h3>
<p>The position of the inline object within the text layout.</p>
<!-- @@@textPosition -->
<!-- $$$width[overload1]$$$width -->
<h3 class="fn"><a name="width"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextInlineObject::<span class="name">width</span> () const</h3>
<p>Returns the inline object's width.</p>
<p><b>See also </b><a href="qtextinlineobject.html#setWidth">setWidth</a>(), <a href="qtextinlineobject.html#ascent">ascent</a>(), <a href="qtextinlineobject.html#descent">descent</a>(), and <a href="qtextinlineobject.html#rect">rect</a>().</p>
<!-- @@@width -->
</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>
