<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>Exiv2: Exiv2::PreviewImage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Exiv2
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceExiv2.html">Exiv2</a></li><li class="navelem"><a class="el" href="classExiv2_1_1PreviewImage.html">PreviewImage</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#friends">Friends</a> |
<a href="classExiv2_1_1PreviewImage-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Exiv2::PreviewImage Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class that holds preview image properties and data buffer.
<a href="classExiv2_1_1PreviewImage.html#details">More...</a></p>
<p><code>#include <preview.hpp></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr class="memitem:ae4f6c4e04848cd2c6c8c0a620f5d2e0a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4f6c4e04848cd2c6c8c0a620f5d2e0a"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#ae4f6c4e04848cd2c6c8c0a620f5d2e0a">PreviewImage</a> (const <a class="el" href="classExiv2_1_1PreviewImage.html">PreviewImage</a> &rhs)</td></tr>
<tr class="memdesc:ae4f6c4e04848cd2c6c8c0a620f5d2e0a"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:ae4f6c4e04848cd2c6c8c0a620f5d2e0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71460066a87c31bc58ab45d7dcc613f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71460066a87c31bc58ab45d7dcc613f0"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#a71460066a87c31bc58ab45d7dcc613f0">~PreviewImage</a> ()</td></tr>
<tr class="memdesc:a71460066a87c31bc58ab45d7dcc613f0"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a71460066a87c31bc58ab45d7dcc613f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
<tr class="memitem:a5703cae6a354bce921a015951876eed5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5703cae6a354bce921a015951876eed5"></a>
<a class="el" href="classExiv2_1_1PreviewImage.html">PreviewImage</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#a5703cae6a354bce921a015951876eed5">operator=</a> (const <a class="el" href="classExiv2_1_1PreviewImage.html">PreviewImage</a> &rhs)</td></tr>
<tr class="memdesc:a5703cae6a354bce921a015951876eed5"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br /></td></tr>
<tr class="separator:a5703cae6a354bce921a015951876eed5"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr class="memitem:aa8e2c771194f2166b7b0d9fa02fb11fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8e2c771194f2166b7b0d9fa02fb11fe"></a>
<a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#aa8e2c771194f2166b7b0d9fa02fb11fe">copy</a> () const </td></tr>
<tr class="memdesc:aa8e2c771194f2166b7b0d9fa02fb11fe"><td class="mdescLeft"> </td><td class="mdescRight">Return a copy of the preview image data. The caller owns this copy and DataBuf ensures that it will be deleted. <br /></td></tr>
<tr class="separator:aa8e2c771194f2166b7b0d9fa02fb11fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7645ca6beab18da69fdf3a4c4b752fd1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7645ca6beab18da69fdf3a4c4b752fd1"></a>
const <a class="el" href="namespaceExiv2.html#a16f60a5bd4207fe155f6cf93a15efa72">byte</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#a7645ca6beab18da69fdf3a4c4b752fd1">pData</a> () const </td></tr>
<tr class="memdesc:a7645ca6beab18da69fdf3a4c4b752fd1"><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the image data for read-only access. <br /></td></tr>
<tr class="separator:a7645ca6beab18da69fdf3a4c4b752fd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad80d769929c6da3acaad1b04805cac6b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad80d769929c6da3acaad1b04805cac6b"></a>
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#ad80d769929c6da3acaad1b04805cac6b">size</a> () const </td></tr>
<tr class="memdesc:ad80d769929c6da3acaad1b04805cac6b"><td class="mdescLeft"> </td><td class="mdescRight">Return the size of the preview image in bytes. <br /></td></tr>
<tr class="separator:ad80d769929c6da3acaad1b04805cac6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb74c09c1a6d44565bfeb8ef8a5134e0"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#acb74c09c1a6d44565bfeb8ef8a5134e0">writeFile</a> (const std::string &path) const </td></tr>
<tr class="memdesc:acb74c09c1a6d44565bfeb8ef8a5134e0"><td class="mdescLeft"> </td><td class="mdescRight">Write the thumbnail image to a file. <a href="#acb74c09c1a6d44565bfeb8ef8a5134e0">More...</a><br /></td></tr>
<tr class="separator:acb74c09c1a6d44565bfeb8ef8a5134e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d77a6d848d4fa0ee7ba04f43c93b93c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d77a6d848d4fa0ee7ba04f43c93b93c"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#a8d77a6d848d4fa0ee7ba04f43c93b93c">mimeType</a> () const </td></tr>
<tr class="memdesc:a8d77a6d848d4fa0ee7ba04f43c93b93c"><td class="mdescLeft"> </td><td class="mdescRight">Return the MIME type of the preview image, usually either <code>"image/tiff"</code> or <code>"image/jpeg"</code>. <br /></td></tr>
<tr class="separator:a8d77a6d848d4fa0ee7ba04f43c93b93c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b9f40d486bb709ddfb1971937124d5a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b9f40d486bb709ddfb1971937124d5a"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#a5b9f40d486bb709ddfb1971937124d5a">extension</a> () const </td></tr>
<tr class="memdesc:a5b9f40d486bb709ddfb1971937124d5a"><td class="mdescLeft"> </td><td class="mdescRight">Return the file extension for the format of the preview image (".tif" or ".jpg"). <br /></td></tr>
<tr class="separator:a5b9f40d486bb709ddfb1971937124d5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af203bb45d60b5dcca43e8bf945e55708"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af203bb45d60b5dcca43e8bf945e55708"></a>
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#af203bb45d60b5dcca43e8bf945e55708">width</a> () const </td></tr>
<tr class="memdesc:af203bb45d60b5dcca43e8bf945e55708"><td class="mdescLeft"> </td><td class="mdescRight">Return the width of the preview image in pixels. <br /></td></tr>
<tr class="separator:af203bb45d60b5dcca43e8bf945e55708"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6dd4231eea7ea1166b5605dafceba23"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6dd4231eea7ea1166b5605dafceba23"></a>
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#ac6dd4231eea7ea1166b5605dafceba23">height</a> () const </td></tr>
<tr class="memdesc:ac6dd4231eea7ea1166b5605dafceba23"><td class="mdescLeft"> </td><td class="mdescRight">Return the height of the preview image in pixels. <br /></td></tr>
<tr class="separator:ac6dd4231eea7ea1166b5605dafceba23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c7e62a0c27413ec9dfcbe00d3ee2e9d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c7e62a0c27413ec9dfcbe00d3ee2e9d"></a>
<a class="el" href="namespaceExiv2.html#a7cf3033d88acbcf7a808946868f0b239">PreviewId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1PreviewImage.html#a1c7e62a0c27413ec9dfcbe00d3ee2e9d">id</a> () const </td></tr>
<tr class="memdesc:a1c7e62a0c27413ec9dfcbe00d3ee2e9d"><td class="mdescLeft"> </td><td class="mdescRight">Return the preview image type identifier. <br /></td></tr>
<tr class="separator:a1c7e62a0c27413ec9dfcbe00d3ee2e9d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a3f32ef8ab6bf43b859dfc06539fdeb25"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f32ef8ab6bf43b859dfc06539fdeb25"></a>
class </td><td class="memItemRight" valign="bottom"><b>PreviewManager</b></td></tr>
<tr class="separator:a3f32ef8ab6bf43b859dfc06539fdeb25"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class that holds preview image properties and data buffer. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acb74c09c1a6d44565bfeb8ef8a5134e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Exiv2::PreviewImage::writeFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Write the thumbnail image to a file. </p>
<p>A filename extension is appended to <em>path</em> according to the image type of the preview image, so <em>path</em> should not include an extension. The function will overwrite an existing file of the same name.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>File name of the preview image without extension. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes written. </dd></dl>
<p>References <a class="el" href="classExiv2_1_1PreviewImage.html#a5b9f40d486bb709ddfb1971937124d5a">extension()</a>, <a class="el" href="namespaceExiv2.html#a5153319711f35fe81cbc13f4b852450ca2d79fb07c9ec891f281968dad43c1e25">Exiv2::string</a>, and <a class="el" href="namespaceExiv2.html#a65c0189894e7563da9a932e9c826e761">Exiv2::writeFile()</a>.</p>
<p>Referenced by <a class="el" href="classAction_1_1Extract.html#a8d2822debb35ba23dacdd6c2835c2ce9">Action::Extract::writePreviewFile()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="preview_8hpp.html">preview.hpp</a></li>
<li>preview.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 4 2016 17:51:50 for Exiv2 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
12cd2b60e7ffa1b93f26cacdd7197eb9
>
files
>
768
