qtextimageformat.html 9.6 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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtextformat.cpp -->
  <title>QTextImageFormat 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 >QTextImageFormat</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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QTextImageFormat Class</h1>
<!-- $$$QTextImageFormat-brief -->
<p>The <a href="qtextimageformat.html">QTextImageFormat</a> class provides formatting information for images in a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<!-- @@@QTextImageFormat -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QTextImageFormat&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="qtextcharformat.html">QTextCharFormat</a></td></tr></table></div><ul>
<li><a href="qtextimageformat-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"> </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 &amp;<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></div>
<ul>
<li class="fn">54 public functions inherited from <a href="qtextcharformat.html#public-functions">QTextCharFormat</a></li>
<li class="fn">51 public functions inherited from <a href="qtextformat.html#public-functions">QTextFormat</a></li>
</ul>
<a name="details"></a>
<!-- $$$QTextImageFormat-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qtextimageformat.html">QTextImageFormat</a> class provides formatting information for images in a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>Inline images are represented by a Unicode value U+FFFC (OBJECT REPLACEMENT CHARACTER) which has an associated <a href="qtextimageformat.html">QTextImageFormat</a>. 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" id="QTextImageFormat"><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" id="height"><a name="height"></a><span class="type"><a href="../qtcore/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" id="isValid"><a name="isValid"></a><span class="type">bool</span> QTextImageFormat::<span class="name">isValid</span>() const</h3>
<p>Returns <code>true</code> if this image format is valid; otherwise returns <code>false</code>.</p>
<!-- @@@isValid -->
<!-- $$$name[overload1]$$$name -->
<h3 class="fn" id="name"><a name="name"></a><span class="type"><a href="../qtcore/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" id="setHeight"><a name="setHeight"></a><span class="type">void</span> QTextImageFormat::<span class="name">setHeight</span>(<span class="type"><a href="../qtcore/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" id="setName"><a name="setName"></a><span class="type">void</span> QTextImageFormat::<span class="name">setName</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &amp;<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" id="setWidth"><a name="setWidth"></a><span class="type">void</span> QTextImageFormat::<span class="name">setWidth</span>(<span class="type"><a href="../qtcore/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" id="width"><a name="width"></a><span class="type"><a href="../qtcore/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>
       </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>