File: classExiv2_1_1Thumbnail.html

package info (click to toggle)
exiv2 0.10-1.4
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 13,124 kB
  • ctags: 5,665
  • sloc: cpp: 20,697; xml: 15,118; sh: 10,526; ansic: 1,887; makefile: 367; awk: 64; python: 36
file content (145 lines) | stat: -rw-r--r-- 11,399 bytes parent folder | download | duplicates (2)
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
137
138
139
140
141
142
143
144
145
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Exiv2: Exiv2::Thumbnail Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.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>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</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="nav">
<a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1Thumbnail.html">Thumbnail</a></div>
<h1>Exiv2::Thumbnail Class Reference</h1><!-- doxytag: class="Exiv2::Thumbnail" -->Exif Thumbnail image. This abstract base class provides the interface for the thumbnail image that is optionally embedded in the Exif data. This class is used internally by <a class="el" href="classExiv2_1_1ExifData.html">ExifData</a>, it is probably not useful for a client as a standalone class. Instead, use an instance of <a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> to access the Exif thumbnail image.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;exif.hpp&gt;</code>
<p>
Inheritance diagram for Exiv2::Thumbnail:<p><center><img src="classExiv2_1_1Thumbnail__inherit__graph.png" border="0" usemap="#Exiv2_1_1Thumbnail__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1Thumbnail__inherit__map">
<area href="classExiv2_1_1JpegThumbnail.html" shape="rect" coords="5,81,157,105" alt="">
<area href="classExiv2_1_1TiffThumbnail.html" shape="rect" coords="181,81,323,105" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classExiv2_1_1Thumbnail-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf289890ffef7268ca3d7bfdb8123676"></a><!-- doxytag: member="Exiv2::Thumbnail::AutoPtr" ref="cf289890ffef7268ca3d7bfdb8123676" args="" -->
typedef std::auto_ptr&lt; <a class="el" href="classExiv2_1_1Thumbnail.html">Thumbnail</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Thumbnail.html#cf289890ffef7268ca3d7bfdb8123676">AutoPtr</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for a Thumbnail auto pointer. <br></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="dfd99617058e36f1aa9693771b63df86"></a><!-- doxytag: member="Exiv2::Thumbnail::~Thumbnail" ref="dfd99617058e36f1aa9693771b63df86" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Thumbnail.html#dfd99617058e36f1aa9693771b63df86">~Thumbnail</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual destructor. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Thumbnail.html#32376c5de38c9426e0637d3e8b681c4d">setDataArea</a> (<a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> &amp;exifData, <a class="el" href="classExiv2_1_1Ifd.html">Ifd</a> *pIfd1, const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *buf, long len) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the image data as data area of the appropriate Exif metadatum. Read the thumbnail image data from data buffer <em>buf</em>. Return 0 if successful.  <a href="#32376c5de38c9426e0637d3e8b681c4d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7608ba2e95e7e46859df9cd84f79ddc3"></a><!-- doxytag: member="Exiv2::Thumbnail::copy" ref="7608ba2e95e7e46859df9cd84f79ddc3" args="(const ExifData &amp;exifData) const =0" -->
virtual <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Thumbnail.html#7608ba2e95e7e46859df9cd84f79ddc3">copy</a> (const <a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> &amp;exifData) const =0</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"><a class="anchor" name="e069028a96300509c73142e0b8266eaf"></a><!-- doxytag: member="Exiv2::Thumbnail::format" ref="e069028a96300509c73142e0b8266eaf" args="() const =0" -->
virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Thumbnail.html#e069028a96300509c73142e0b8266eaf">format</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a short string for the format of the thumbnail ("TIFF", "JPEG"). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99a06f75360dbb240d58af97c4c39f35"></a><!-- doxytag: member="Exiv2::Thumbnail::extension" ref="99a06f75360dbb240d58af97c4c39f35" args="() const =0" -->
virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Thumbnail.html#99a06f75360dbb240d58af97c4c39f35">extension</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the file extension for the format of the thumbnail (".tif", ".jpg"). <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0934137b3f1caf9eed39dde5854f6e76"></a><!-- doxytag: member="Exiv2::Thumbnail::operator=" ref="0934137b3f1caf9eed39dde5854f6e76" args="(const Thumbnail &amp;rhs)" -->
<a class="el" href="classExiv2_1_1Thumbnail.html">Thumbnail</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Thumbnail.html#0934137b3f1caf9eed39dde5854f6e76">operator=</a> (const <a class="el" href="classExiv2_1_1Thumbnail.html">Thumbnail</a> &amp;rhs)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator. Protected so that it can only be used by subclasses but not directly. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Exif Thumbnail image. This abstract base class provides the interface for the thumbnail image that is optionally embedded in the Exif data. This class is used internally by <a class="el" href="classExiv2_1_1ExifData.html">ExifData</a>, it is probably not useful for a client as a standalone class. Instead, use an instance of <a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> to access the Exif thumbnail image. 
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="32376c5de38c9426e0637d3e8b681c4d"></a><!-- doxytag: member="Exiv2::Thumbnail::setDataArea" ref="32376c5de38c9426e0637d3e8b681c4d" args="(ExifData &amp;exifData, Ifd *pIfd1, const byte *buf, long len) const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual int Exiv2::Thumbnail::setDataArea           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>exifData</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classExiv2_1_1Ifd.html">Ifd</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>pIfd1</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>buf</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>long&nbsp;</td>
          <td class="mdname" nowrap> <em>len</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set the image data as data area of the appropriate Exif metadatum. Read the thumbnail image data from data buffer <em>buf</em>. Return 0 if successful. 
<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>exifData</em>&nbsp;</td><td>Exif data corresponding to the data buffer. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pIfd1</em>&nbsp;</td><td>Corresponding raw IFD1. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>buf</em>&nbsp;</td><td>Data buffer containing the thumbnail data. The buffer must start with the TIFF header. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>Number of bytes in the data buffer. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>0 if successful;<br>
 1 in case of inconsistent thumbnail Exif data; or<br>
 2 if the data area is outside of the data buffer </dd></dl>

<p>
Implemented in <a class="el" href="classExiv2_1_1TiffThumbnail.html#8b61502c88dee78609c6845d7d239b4b">Exiv2::TiffThumbnail</a>, and <a class="el" href="classExiv2_1_1JpegThumbnail.html#55e40a0898fefecc69e130019707b07c">Exiv2::JpegThumbnail</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="exif_8hpp.html">exif.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:54:55 2006 for Exiv2 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>