<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Exiv2: Exiv2::ExifThumb Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1ExifThumb.html">ExifThumb</a>
</div>
</div>
<div class="contents">
<h1>Exiv2::ExifThumb Class Reference</h1><!-- doxytag: class="Exiv2::ExifThumb" --><!-- doxytag: inherits="Exiv2::ExifThumbC" -->Access and modify an Exif thumbnail image. This class implements manipulators to set and erase the thumbnail image that is optionally embedded in IFD1 of the Exif data. Accessors are provided by the base class, <a class="el" href="classExiv2_1_1ExifThumbC.html" title="Access to a Exif thumbnail image. This class provides higher level accessors to the...">ExifThumbC</a>.
<a href="#_details">More...</a>
<p>
<code>#include <exif.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for Exiv2::ExifThumb:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1ExifThumb__inherit__graph.png" border="0" usemap="#Exiv2_1_1ExifThumb__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1ExifThumb__inherit__map">
<area shape="rect" id="node2" href="classExiv2_1_1ExifThumbC.html" title="Access to a Exif thumbnail image. This class provides higher level accessors to the..." alt="" coords="5,5,197,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for Exiv2::ExifThumb:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1ExifThumb__coll__graph.png" border="0" usemap="#Exiv2_1_1ExifThumb__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1ExifThumb__coll__map">
<area shape="rect" id="node2" href="classExiv2_1_1ExifThumbC.html" title="Access to a Exif thumbnail image. This class provides higher level accessors to the..." alt="" coords="801,651,993,677"><area shape="rect" id="node4" href="classExiv2_1_1ExifData.html" title="A container for Exif data. This is a top-level class of the Exiv2 library. The container..." alt="" coords="623,560,793,587"><area shape="rect" id="node8" href="classExiv2_1_1Exifdatum.html" title="An Exif metadatum, consisting of an ExifKey and a Value and methods to manipulate..." alt="" coords="461,379,643,405"><area shape="rect" id="node10" href="classExiv2_1_1Metadatum.html" title="Abstract base class defining the interface to access information related to one metadata..." alt="" coords="555,288,736,315"><area shape="rect" id="node14" href="classExiv2_1_1ExifKey.html" title="Concrete keys for Exif metadata." alt="" coords="56,187,216,213"><area shape="rect" id="node16" href="classExiv2_1_1Key.html" title="Abstract base class defining the Key of a metadatum. Keys are used to identify and..." alt="" coords="59,83,179,109"><area shape="rect" id="node18" title="STL class." alt="" coords="203,83,333,109"><area shape="rect" id="node20" title="STL class." alt="" coords="143,5,393,32"><area shape="rect" id="node22" title="STL class." alt="" coords="257,187,457,213"><area shape="rect" id="node31" title="STL class." alt="" coords="644,237,825,264"><area shape="rect" id="node28" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata." alt="" coords="481,187,623,213"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classExiv2_1_1ExifThumb-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Creators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2c81742f577443a41c1b184406093c68"></a><!-- doxytag: member="Exiv2::ExifThumb::ExifThumb" ref="2c81742f577443a41c1b184406093c68" args="(ExifData &exifData)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumb.html#2c81742f577443a41c1b184406093c68">ExifThumb</a> (<a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> &exifData)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumb.html#90e5155ba60dae3af4066f80464c788d">setJpegThumbnail</a> (const std::string &path, <a class="el" href="namespaceExiv2.html#edcaa9af0563cbd00a19b040d5aa7a70">URational</a> xres, <a class="el" href="namespaceExiv2.html#edcaa9af0563cbd00a19b040d5aa7a70">URational</a> yres, uint16_t unit)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Exif thumbnail to the JPEG image <em>path</em>. Set XResolution, YResolution and ResolutionUnit to <em>xres</em>, <em>yres</em> and <em>unit</em>, respectively. <a href="#90e5155ba60dae3af4066f80464c788d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumb.html#a29789f0a658d53066e0b55bb2b1acb2">setJpegThumbnail</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *buf, long size, <a class="el" href="namespaceExiv2.html#edcaa9af0563cbd00a19b040d5aa7a70">URational</a> xres, <a class="el" href="namespaceExiv2.html#edcaa9af0563cbd00a19b040d5aa7a70">URational</a> yres, uint16_t unit)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Exif thumbnail to the JPEG image pointed to by <em>buf</em>, and size <em>size</em>. Set XResolution, YResolution and ResolutionUnit to <em>xres</em>, <em>yres</em> and <em>unit</em>, respectively. <a href="#a29789f0a658d53066e0b55bb2b1acb2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumb.html#f5578e157a1e60b295d703aecec242b8">setJpegThumbnail</a> (const std::string &path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Exif thumbnail to the JPEG image <em>path</em>. <a href="#f5578e157a1e60b295d703aecec242b8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumb.html#f8cf3725b3d9d6fa08055ea4809bf77f">setJpegThumbnail</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *buf, long size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Exif thumbnail to the JPEG image pointed to by <em>buf</em>, and size <em>size</em>. <a href="#f8cf3725b3d9d6fa08055ea4809bf77f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5239338ade638043bf66337fd9d4e3f8"></a><!-- doxytag: member="Exiv2::ExifThumb::erase" ref="5239338ade638043bf66337fd9d4e3f8" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumb.html#5239338ade638043bf66337fd9d4e3f8">erase</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete the thumbnail from the Exif data. Removes all Exif.Thumbnail.*, i.e., Exif IFD1 tags. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Access and modify an Exif thumbnail image. This class implements manipulators to set and erase the thumbnail image that is optionally embedded in IFD1 of the Exif data. Accessors are provided by the base class, <a class="el" href="classExiv2_1_1ExifThumbC.html" title="Access to a Exif thumbnail image. This class provides higher level accessors to the...">ExifThumbC</a>.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Various other preview and thumbnail images may be contained in an image, depending on its format and the camera make and model. This class only provides access to the Exif thumbnail as specified in the Exif standard. </dd></dl>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f8cf3725b3d9d6fa08055ea4809bf77f"></a><!-- doxytag: member="Exiv2::ExifThumb::setJpegThumbnail" ref="f8cf3725b3d9d6fa08055ea4809bf77f" args="(const byte *buf, long size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Exiv2::ExifThumb::setJpegThumbnail </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the Exif thumbnail to the JPEG image pointed to by <em>buf</em>, and size <em>size</em>.
<p>
This sets only the Compression, JPEGInterchangeFormat and JPEGInterchangeFormatLength tags, which is not all the thumbnail Exif information mandatory according to the Exif standard. (But it's enough to work with the thumbnail.)<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>No checks on the image format or size are performed. <p>
Additional existing Exif thumbnail tags are not modified. </dd></dl>
<p>References <a class="el" href="exif_8hpp_source.html#l00152">Exiv2::Exifdatum::setDataArea()</a>.</p>
</div>
</div><p>
<a class="anchor" name="f5578e157a1e60b295d703aecec242b8"></a><!-- doxytag: member="Exiv2::ExifThumb::setJpegThumbnail" ref="f5578e157a1e60b295d703aecec242b8" args="(const std::string &path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Exiv2::ExifThumb::setJpegThumbnail </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>path</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the Exif thumbnail to the JPEG image <em>path</em>.
<p>
This sets only the Compression, JPEGInterchangeFormat and JPEGInterchangeFormatLength tags, which is not all the thumbnail Exif information mandatory according to the Exif standard. (But it's enough to work with the thumbnail.)<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html" title="Simple error class used for exceptions. An output operator is provided to print errors...">Error</a></em> </td><td>if reading the file fails.</td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>No checks on the file format or size are performed. <p>
Additional existing Exif thumbnail tags are not modified. </dd></dl>
<p>References <a class="el" href="types_8hpp_source.html#l00258">Exiv2::DataBuf::pData_</a>, <a class="el" href="namespaceExiv2.html#5c87ddedd63e9ab9aa6f295cda32aebd">Exiv2::readFile()</a>, <a class="el" href="exif_8cpp_source.html#l00319">setJpegThumbnail()</a>, and <a class="el" href="types_8hpp_source.html#l00260">Exiv2::DataBuf::size_</a>.</p>
</div>
</div><p>
<a class="anchor" name="a29789f0a658d53066e0b55bb2b1acb2"></a><!-- doxytag: member="Exiv2::ExifThumb::setJpegThumbnail" ref="a29789f0a658d53066e0b55bb2b1acb2" args="(const byte *buf, long size, URational xres, URational yres, uint16_t unit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Exiv2::ExifThumb::setJpegThumbnail </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceExiv2.html#edcaa9af0563cbd00a19b040d5aa7a70">URational</a> </td>
<td class="paramname"> <em>xres</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceExiv2.html#edcaa9af0563cbd00a19b040d5aa7a70">URational</a> </td>
<td class="paramname"> <em>yres</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"> <em>unit</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the Exif thumbnail to the JPEG image pointed to by <em>buf</em>, and size <em>size</em>. Set XResolution, YResolution and ResolutionUnit to <em>xres</em>, <em>yres</em> and <em>unit</em>, respectively.
<p>
This results in the minimal thumbnail tags being set for a JPEG thumbnail, as mandated by the Exif standard.<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html" title="Simple error class used for exceptions. An output operator is provided to print errors...">Error</a></em> </td><td>if reading the file fails.</td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>No checks on the image format or size are performed. <p>
Additional existing Exif thumbnail tags are not modified. <p>
The JPEG image inserted as thumbnail image should not itself contain Exif data (or other metadata), as existing applications may have problems with that. (The preview application that comes with OS X for one.) - David Harvey. </dd></dl>
<p>References <a class="el" href="exif_8cpp_source.html#l00319">setJpegThumbnail()</a>.</p>
</div>
</div><p>
<a class="anchor" name="90e5155ba60dae3af4066f80464c788d"></a><!-- doxytag: member="Exiv2::ExifThumb::setJpegThumbnail" ref="90e5155ba60dae3af4066f80464c788d" args="(const std::string &path, URational xres, URational yres, uint16_t unit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Exiv2::ExifThumb::setJpegThumbnail </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceExiv2.html#edcaa9af0563cbd00a19b040d5aa7a70">URational</a> </td>
<td class="paramname"> <em>xres</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceExiv2.html#edcaa9af0563cbd00a19b040d5aa7a70">URational</a> </td>
<td class="paramname"> <em>yres</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"> <em>unit</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the Exif thumbnail to the JPEG image <em>path</em>. Set XResolution, YResolution and ResolutionUnit to <em>xres</em>, <em>yres</em> and <em>unit</em>, respectively.
<p>
This results in the minimal thumbnail tags being set for a JPEG thumbnail, as mandated by the Exif standard.<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html" title="Simple error class used for exceptions. An output operator is provided to print errors...">Error</a></em> </td><td>if reading the file fails.</td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>No checks on the file format or size are performed. <p>
Additional existing Exif thumbnail tags are not modified. <p>
The JPEG image inserted as thumbnail image should not itself contain Exif data (or other metadata), as existing applications may have problems with that. (The preview application that comes with OS X for one.) - David Harvey. </dd></dl>
<p>References <a class="el" href="types_8hpp_source.html#l00258">Exiv2::DataBuf::pData_</a>, <a class="el" href="namespaceExiv2.html#5c87ddedd63e9ab9aa6f295cda32aebd">Exiv2::readFile()</a>, and <a class="el" href="types_8hpp_source.html#l00260">Exiv2::DataBuf::size_</a>.</p>
<p>Referenced by <a class="el" href="exif_8cpp_source.html#l00330">setJpegThumbnail()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="exif_8hpp.html">exif.hpp</a><li>exif.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 25 15:17:56 2009 for Exiv2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
