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
|
<?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" />
<!-- qtextformat.cpp -->
<title>Qt 4.8: QTextImageFormat 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>QTextImageFormat</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">QTextImageFormat Class Reference</h1>
<!-- $$$QTextImageFormat-brief -->
<p>The QTextImageFormat class provides formatting information for images in a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<!-- @@@QTextImageFormat -->
<pre class="cpp"> <span class="preprocessor">#include <QTextImageFormat></span></pre><p><b>Inherits: </b><a href="qtextcharformat.html">QTextCharFormat</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="qtextimageformat-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="qtextimageformat.html#QTextImageFormat">QTextImageFormat</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextimageformat.html#height">height</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextimageformat.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtextimageformat.html#name">name</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextimageformat.html#setHeight">setHeight</a></b> ( qreal <i>height</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextimageformat.html#setName">setName</a></b> ( const QString & <i>name</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextimageformat.html#setWidth">setWidth</a></b> ( qreal <i>width</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextimageformat.html#width">width</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">49 public functions inherited from <a href="qtextcharformat.html#public-functions">QTextCharFormat</a></li>
<li class="fn">49 public functions inherited from <a href="qtextformat.html#public-functions">QTextFormat</a></li>
</ul>
<a name="details"></a>
<!-- $$$QTextImageFormat-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QTextImageFormat class provides formatting information for images in a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>Inline images are represented by an object replacement character (0xFFFC in Unicode) which has an associated QTextImageFormat. The image format specifies a name with <a href="qtextimageformat.html#setName">setName</a>() that is used to locate the image. The size of the rectangle that the image will occupy is specified using <a href="qtextimageformat.html#setWidth">setWidth</a>() and <a href="qtextimageformat.html#setHeight">setHeight</a>().</p>
<p>Images can be supplied in any format for which Qt has an image reader, so SVG drawings can be included alongside PNG, TIFF and other bitmap formats.</p>
</div>
<p><b>See also </b><a href="qimage.html">QImage</a> and <a href="qimagereader.html">QImageReader</a>.</p>
<!-- @@@QTextImageFormat -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextImageFormat[overload1]$$$QTextImageFormat -->
<h3 class="fn"><a name="QTextImageFormat"></a>QTextImageFormat::<span class="name">QTextImageFormat</span> ()</h3>
<p>Creates a new image format object.</p>
<!-- @@@QTextImageFormat -->
<!-- $$$height[overload1]$$$height -->
<h3 class="fn"><a name="height"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextImageFormat::<span class="name">height</span> () const</h3>
<p>Returns the height of the rectangle occupied by the image.</p>
<p><b>See also </b><a href="qtextimageformat.html#width">width</a>() and <a href="qtextimageformat.html#setHeight">setHeight</a>().</p>
<!-- @@@height -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QTextImageFormat::<span class="name">isValid</span> () const</h3>
<p>Returns true if this image format is valid; otherwise returns false.</p>
<!-- @@@isValid -->
<!-- $$$name[overload1]$$$name -->
<h3 class="fn"><a name="name"></a><span class="type"><a href="qstring.html">QString</a></span> QTextImageFormat::<span class="name">name</span> () const</h3>
<p>Returns the name of the image. The name refers to an entry in the application's resources file.</p>
<p><b>See also </b><a href="qtextimageformat.html#setName">setName</a>().</p>
<!-- @@@name -->
<!-- $$$setHeight[overload1]$$$setHeightqreal -->
<h3 class="fn"><a name="setHeight"></a><span class="type">void</span> QTextImageFormat::<span class="name">setHeight</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>height</i> )</h3>
<p>Sets the <i>height</i> of the rectangle occupied by the image.</p>
<p><b>See also </b><a href="qtextimageformat.html#height">height</a>() and <a href="qtextimageformat.html#setWidth">setWidth</a>().</p>
<!-- @@@setHeight -->
<!-- $$$setName[overload1]$$$setNameconstQString& -->
<h3 class="fn"><a name="setName"></a><span class="type">void</span> QTextImageFormat::<span class="name">setName</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> )</h3>
<p>Sets the <i>name</i> of the image. The <i>name</i> is used to locate the image in the application's resources.</p>
<p><b>See also </b><a href="qtextimageformat.html#name">name</a>().</p>
<!-- @@@setName -->
<!-- $$$setWidth[overload1]$$$setWidthqreal -->
<h3 class="fn"><a name="setWidth"></a><span class="type">void</span> QTextImageFormat::<span class="name">setWidth</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>width</i> )</h3>
<p>Sets the <i>width</i> of the rectangle occupied by the image.</p>
<p><b>See also </b><a href="qtextimageformat.html#width">width</a>() and <a href="qtextimageformat.html#setHeight">setHeight</a>().</p>
<!-- @@@setWidth -->
<!-- $$$width[overload1]$$$width -->
<h3 class="fn"><a name="width"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextImageFormat::<span class="name">width</span> () const</h3>
<p>Returns the width of the rectangle occupied by the image.</p>
<p><b>See also </b><a href="qtextimageformat.html#height">height</a>() and <a href="qtextimageformat.html#setWidth">setWidth</a>().</p>
<!-- @@@width -->
</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>
|