Sophie

Sophie

distrib > * > 2010.0 > * > by-pkgid > b36c97ff723e66f0f38bce83645c99dc > files > 224

exiv2-doc-0.18.2-1mdv2010.0.x86_64.rpm

<!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::ExifThumbC 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&nbsp;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>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1ExifThumbC.html">ExifThumbC</a>
  </div>
</div>
<div class="contents">
<h1>Exiv2::ExifThumbC Class Reference</h1><!-- doxytag: class="Exiv2::ExifThumbC" -->Access to a Exif thumbnail image. This class provides higher level accessors to the thumbnail image that is optionally embedded in IFD1 of the Exif data. These methods do not write to the Exif metadata. Manipulators are provided in subclass <a class="el" href="classExiv2_1_1ExifThumb.html" title="Access and modify an Exif thumbnail image. This class implements manipulators to...">ExifThumb</a>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;exif.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Exiv2::ExifThumbC:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1ExifThumbC__inherit__graph.png" border="0" usemap="#Exiv2_1_1ExifThumbC__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1ExifThumbC__inherit__map">
<area shape="rect" id="node3" href="classExiv2_1_1ExifThumb.html" title="Access and modify an Exif thumbnail image. This class implements manipulators to..." alt="" coords="11,80,192,107"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for Exiv2::ExifThumbC:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1ExifThumbC__coll__graph.png" border="0" usemap="#Exiv2_1_1ExifThumbC__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1ExifThumbC__coll__map">
<area shape="rect" id="node2" href="classExiv2_1_1ExifData.html" title="A container for Exif data. This is a top&#45;level class of the Exiv2 library. The container..." alt="" coords="623,560,793,587"><area shape="rect" id="node6" 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="node8" 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="node12" href="classExiv2_1_1ExifKey.html" title="Concrete keys for Exif metadata." alt="" coords="56,187,216,213"><area shape="rect" id="node14" 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="node16" title="STL class." alt="" coords="203,83,333,109"><area shape="rect" id="node18" title="STL class." alt="" coords="143,5,393,32"><area shape="rect" id="node20" title="STL class." alt="" coords="257,187,457,213"><area shape="rect" id="node29" title="STL class." alt="" coords="644,237,825,264"><area shape="rect" id="node26" 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_1ExifThumbC-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="47c5170242743d1dfd32a6d03527f7b7"></a><!-- doxytag: member="Exiv2::ExifThumbC::ExifThumbC" ref="47c5170242743d1dfd32a6d03527f7b7" args="(const ExifData &amp;exifData)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumbC.html#47c5170242743d1dfd32a6d03527f7b7">ExifThumbC</a> (const <a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> &amp;exifData)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="525866c326d9a6ef37e70a2bb644b207"></a><!-- doxytag: member="Exiv2::ExifThumbC::copy" ref="525866c326d9a6ef37e70a2bb644b207" args="() const " -->
<a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumbC.html#525866c326d9a6ef37e70a2bb644b207">copy</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the thumbnail image in a DataBuf. The caller owns the data buffer and DataBuf ensures that it will be deleted. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumbC.html#28a632e5ca0be46d1348aec33d77d1ae">writeFile</a> (const std::string &amp;path) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write the thumbnail image to a file.  <a href="#28a632e5ca0be46d1348aec33d77d1ae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f28b40a8187381efdae3134e32b0c69"></a><!-- doxytag: member="Exiv2::ExifThumbC::mimeType" ref="1f28b40a8187381efdae3134e32b0c69" args="() const " -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumbC.html#1f28b40a8187381efdae3134e32b0c69">mimeType</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the MIME type of the thumbnail, either <code>"image/tiff"</code> or <code>"image/jpeg"</code>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b3f2980afb5524095ec39e6506119140"></a><!-- doxytag: member="Exiv2::ExifThumbC::extension" ref="b3f2980afb5524095ec39e6506119140" args="() const " -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1ExifThumbC.html#b3f2980afb5524095ec39e6506119140">extension</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the file extension for the format of the thumbnail (".tif" or ".jpg"). <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Access to a Exif thumbnail image. This class provides higher level accessors to the thumbnail image that is optionally embedded in IFD1 of the Exif data. These methods do not write to the Exif metadata. Manipulators are provided in subclass <a class="el" href="classExiv2_1_1ExifThumb.html" title="Access and modify an Exif thumbnail image. This class implements manipulators to...">ExifThumb</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="28a632e5ca0be46d1348aec33d77d1ae"></a><!-- doxytag: member="Exiv2::ExifThumbC::writeFile" ref="28a632e5ca0be46d1348aec33d77d1ae" args="(const std::string &amp;path) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">long Exiv2::ExifThumbC::writeFile           </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>path</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Write the thumbnail image to a file. 
<p>
A filename extension is appended to <em>path</em> according to the image type of the thumbnail, so <em>path</em> should not include an extension. The function will overwrite an existing file of the same name.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>File name of the thumbnail without extension. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of bytes written. </dd></dl>

<p>References <a class="el" href="types_8hpp_source.html#l00122">Exiv2::string</a>.</p>

<p>Referenced by <a class="el" href="actions_8cpp_source.html#l00934">Action::Extract::writeThumbnail()</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:55 2009 for Exiv2 by&nbsp;
<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>