<?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" />
<!-- q3canvas.cpp -->
<title>Qt 4.8: Q3CanvasPixmap 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="qt3support.html">Qt3Support</a></li>
<li>Q3CanvasPixmap</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">Q3CanvasPixmap Class Reference</h1>
<!-- $$$Q3CanvasPixmap-brief -->
<p>The Q3CanvasPixmap class provides pixmaps for Q3CanvasSprites. <a href="#details">More...</a></p>
<!-- @@@Q3CanvasPixmap -->
<pre class="cpp"> <span class="preprocessor">#include <Q3CanvasPixmap></span></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html">Porting to Qt 4</a> for more information.</p>
<p><b>Inherits: </b><a href="qpixmap.html">QPixmap</a>.</p>
<ul>
<li><a href="q3canvaspixmap-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="q3canvaspixmap.html#Q3CanvasPixmap">Q3CanvasPixmap</a></b> ( const QString & <i>datafilename</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmap.html#Q3CanvasPixmap-2">Q3CanvasPixmap</a></b> ( const QImage & <i>image</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmap.html#Q3CanvasPixmap-3">Q3CanvasPixmap</a></b> ( const QPixmap & <i>pm</i>, const QPoint & <i>offset</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmap.html#dtor.Q3CanvasPixmap">~Q3CanvasPixmap</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmap.html#offsetX">offsetX</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmap.html#offsetY">offsetY</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3canvaspixmap.html#setOffset">setOffset</a></b> ( int <i>x</i>, int <i>y</i> )</td></tr>
</table>
<ul>
<li class="fn">48 public functions inherited from <a href="qpixmap.html#public-functions">QPixmap</a></li>
<li class="fn">13 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">14 static public members inherited from <a href="qpixmap.html#static-public-members">QPixmap</a></li>
<li class="fn">1 protected function inherited from <a href="qpaintdevice.html#protected-functions">QPaintDevice</a></li>
</ul>
<a name="details"></a>
<!-- $$$Q3CanvasPixmap-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3CanvasPixmap class provides pixmaps for Q3CanvasSprites.</p>
<p>If you want to show a single pixmap on a <a href="q3canvas.html">Q3Canvas</a> use a <a href="q3canvassprite.html">Q3CanvasSprite</a> with just one pixmap.</p>
<p>When pixmaps are inserted into a <a href="q3canvaspixmaparray.html">Q3CanvasPixmapArray</a> they are held as Q3CanvasPixmaps. <a href="q3canvassprite.html">Q3CanvasSprite</a>s are used to show pixmaps on <a href="q3canvas.html">Q3Canvas</a>es and hold their pixmaps in a <a href="q3canvaspixmaparray.html">Q3CanvasPixmapArray</a>. If you retrieve a frame (pixmap) from a <a href="q3canvassprite.html">Q3CanvasSprite</a> it will be returned as a Q3CanvasPixmap.</p>
<p>The pixmap is a <a href="qpixmap.html">QPixmap</a> and can only be set in the constructor. There are three different constructors, one taking a <a href="qpixmap.html">QPixmap</a>, one a <a href="qimage.html">QImage</a> and one a file name that refers to a file in any supported file format (see <a href="qimagereader.html">QImageReader</a>).</p>
<p>Q3CanvasPixmap can have a hotspot which is defined in terms of an (x, y) offset. When you create a Q3CanvasPixmap from a PNG file or from a <a href="qimage.html">QImage</a> that has a <a href="qimage.html#offset">QImage::offset</a>(), the offset() is initialized appropriately, otherwise the constructor leaves it at (0, 0). You can set it later using <a href="q3canvaspixmap.html#setOffset">setOffset</a>(). When the Q3CanvasPixmap is used in a <a href="q3canvassprite.html">Q3CanvasSprite</a>, the offset position is the point at <a href="q3canvasitem.html#x">Q3CanvasItem::x</a>() and <a href="q3canvasitem.html#y">Q3CanvasItem::y</a>(), not the top-left corner of the pixmap.</p>
<p>Note that for Q3CanvasPixmap objects created by a <a href="q3canvassprite.html">Q3CanvasSprite</a>, the position of each Q3CanvasPixmap object is set so that the hotspot stays in the same position.</p>
</div>
<p><b>See also </b><a href="q3canvaspixmaparray.html">Q3CanvasPixmapArray</a>, <a href="q3canvasitem.html">Q3CanvasItem</a>, <a href="q3canvassprite.html">Q3CanvasSprite</a>, <a href="http://www.qt.io/product/">QtCanvas</a>, and <a href="graphicsview-porting.html">Porting to Graphics View</a>.</p>
<!-- @@@Q3CanvasPixmap -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3CanvasPixmap[overload1]$$$Q3CanvasPixmapconstQString& -->
<h3 class="fn"><a name="Q3CanvasPixmap"></a>Q3CanvasPixmap::<span class="name">Q3CanvasPixmap</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>datafilename</i> )</h3>
<p>Constructs a <a href="q3canvaspixmap.html" class="compat">Q3CanvasPixmap</a> that uses the image stored in <i>datafilename</i>.</p>
<!-- @@@Q3CanvasPixmap -->
<!-- $$$Q3CanvasPixmap$$$Q3CanvasPixmapconstQImage& -->
<h3 class="fn"><a name="Q3CanvasPixmap-2"></a>Q3CanvasPixmap::<span class="name">Q3CanvasPixmap</span> ( const <span class="type"><a href="qimage.html">QImage</a></span> & <i>image</i> )</h3>
<p>Constructs a <a href="q3canvaspixmap.html" class="compat">Q3CanvasPixmap</a> from the image <i>image</i>.</p>
<!-- @@@Q3CanvasPixmap -->
<!-- $$$Q3CanvasPixmap$$$Q3CanvasPixmapconstQPixmap&constQPoint& -->
<h3 class="fn"><a name="Q3CanvasPixmap-3"></a>Q3CanvasPixmap::<span class="name">Q3CanvasPixmap</span> ( const <span class="type"><a href="qpixmap.html">QPixmap</a></span> & <i>pm</i>, const <span class="type"><a href="qpoint.html">QPoint</a></span> & <i>offset</i> )</h3>
<p>Constructs a <a href="q3canvaspixmap.html" class="compat">Q3CanvasPixmap</a> from the pixmap <i>pm</i> using the offset <i>offset</i>.</p>
<!-- @@@Q3CanvasPixmap -->
<!-- $$$~Q3CanvasPixmap[overload1]$$$~Q3CanvasPixmap -->
<h3 class="fn"><a name="dtor.Q3CanvasPixmap"></a>Q3CanvasPixmap::<span class="name">~Q3CanvasPixmap</span> ()</h3>
<p>Destroys the pixmap.</p>
<!-- @@@~Q3CanvasPixmap -->
<!-- $$$offsetX[overload1]$$$offsetX -->
<h3 class="fn"><a name="offsetX"></a><span class="type">int</span> Q3CanvasPixmap::<span class="name">offsetX</span> () const</h3>
<p>Returns the x-offset of the pixmap's hotspot.</p>
<p><b>See also </b><a href="q3canvaspixmap.html#setOffset">setOffset</a>().</p>
<!-- @@@offsetX -->
<!-- $$$offsetY[overload1]$$$offsetY -->
<h3 class="fn"><a name="offsetY"></a><span class="type">int</span> Q3CanvasPixmap::<span class="name">offsetY</span> () const</h3>
<p>Returns the y-offset of the pixmap's hotspot.</p>
<p><b>See also </b><a href="q3canvaspixmap.html#setOffset">setOffset</a>().</p>
<!-- @@@offsetY -->
<!-- $$$setOffset[overload1]$$$setOffsetintint -->
<h3 class="fn"><a name="setOffset"></a><span class="type">void</span> Q3CanvasPixmap::<span class="name">setOffset</span> ( <span class="type">int</span> <i>x</i>, <span class="type">int</span> <i>y</i> )</h3>
<p>Sets the offset of the pixmap's hotspot to (<i>x</i>, <i>y</i>).</p>
<p><b>Warning:</b> Do not call this function if any Q3CanvasSprites are currently showing this pixmap.</p>
<!-- @@@setOffset -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
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>
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. <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>
