~ubuntu-branches/ubuntu/precise/exiv2/precise

« back to all changes in this revision

Viewing changes to doc/html/classExiv2_1_1Thumbnail.html

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Mercatante
  • Date: 2006-12-07 18:40:10 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20061207184010-0ouu8v0dr8nznob9
Tags: 0.12-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
6
</head><body>
7
 
<!-- Generated by Doxygen 1.4.6 -->
 
7
<!-- Generated by Doxygen 1.5.1 -->
8
8
<div class="tabs">
9
9
  <ul>
10
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12
12
    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
13
13
    <li><a href="files.html"><span>Files</span></a></li>
14
14
    <li><a href="examples.html"><span>Examples</span></a></li>
 
15
    <li>
 
16
      <form action="search.php" method="get">
 
17
        <table cellspacing="0" cellpadding="0" border="0">
 
18
          <tr>
 
19
            <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
 
20
            <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
 
21
          </tr>
 
22
        </table>
 
23
      </form>
 
24
    </li>
15
25
  </ul></div>
16
26
<div class="tabs">
17
27
  <ul>
29
39
<p>
30
40
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>
31
41
<map name="Exiv2_1_1Thumbnail__inherit__map">
32
 
<area href="classExiv2_1_1JpegThumbnail.html" shape="rect" coords="5,81,157,105" alt="">
33
 
<area href="classExiv2_1_1TiffThumbnail.html" shape="rect" coords="181,81,323,105" alt="">
 
42
<area href="classExiv2_1_1JpegThumbnail.html" shape="rect" coords="6,81,174,105" alt="">
 
43
<area href="classExiv2_1_1TiffThumbnail.html" shape="rect" coords="198,81,358,105" alt="">
34
44
</map>
35
45
<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">
36
46
<tr><td></td></tr>
40
50
 
41
51
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for a Thumbnail auto pointer. <br></td></tr>
42
52
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
43
 
<tr><td colspan="2"><div class="groupHeader">Creators</div></td></tr>
44
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dfd99617058e36f1aa9693771b63df86"></a><!-- doxytag: member="Exiv2::Thumbnail::~Thumbnail" ref="dfd99617058e36f1aa9693771b63df86" args="()" -->
45
 
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Thumbnail.html#dfd99617058e36f1aa9693771b63df86">~Thumbnail</a> ()</td></tr>
46
 
 
47
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual destructor. <br></td></tr>
48
53
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
49
54
<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>
50
55
 
51
56
<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>
52
 
<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" -->
53
 
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>
 
57
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e2bc38bc689c49b9e43da93aad01c67f"></a><!-- doxytag: member="Exiv2::Thumbnail::copy" ref="e2bc38bc689c49b9e43da93aad01c67f" args="(const ExifData &amp;exifData) const=0" -->
 
58
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#e2bc38bc689c49b9e43da93aad01c67f">copy</a> (const <a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> &amp;exifData) const=0</td></tr>
54
59
 
55
60
<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>
56
 
<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" -->
57
 
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>
 
61
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4ce2e13a8ab13150fb69e7a5044cec1e"></a><!-- doxytag: member="Exiv2::Thumbnail::format" ref="4ce2e13a8ab13150fb69e7a5044cec1e" args="() const=0" -->
 
62
virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Thumbnail.html#4ce2e13a8ab13150fb69e7a5044cec1e">format</a> () const=0</td></tr>
58
63
 
59
64
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a short string for the format of the thumbnail ("TIFF", "JPEG"). <br></td></tr>
60
 
<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" -->
61
 
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>
 
65
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="59802f32d1b9982c7dafebd1d29ed6dc"></a><!-- doxytag: member="Exiv2::Thumbnail::extension" ref="59802f32d1b9982c7dafebd1d29ed6dc" args="() const=0" -->
 
66
virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Thumbnail.html#59802f32d1b9982c7dafebd1d29ed6dc">extension</a> () const=0</td></tr>
62
67
 
63
68
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the file extension for the format of the thumbnail (".tif", ".jpg"). <br></td></tr>
64
69
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
72
77
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. 
73
78
<p>
74
79
<hr><h2>Member Function Documentation</h2>
75
 
<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>
76
 
<table class="mdTable" cellpadding="2" cellspacing="0">
77
 
  <tr>
78
 
    <td class="mdRow">
79
 
      <table cellpadding="0" cellspacing="0" border="0">
80
 
        <tr>
81
 
          <td class="md" nowrap valign="top">virtual int Exiv2::Thumbnail::setDataArea           </td>
82
 
          <td class="md" valign="top">(&nbsp;</td>
83
 
          <td class="md" nowrap valign="top"><a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> &amp;&nbsp;</td>
84
 
          <td class="mdname" nowrap> <em>exifData</em>, </td>
85
 
        </tr>
86
 
        <tr>
87
 
          <td class="md" nowrap align="right"></td>
88
 
          <td class="md"></td>
89
 
          <td class="md" nowrap><a class="el" href="classExiv2_1_1Ifd.html">Ifd</a> *&nbsp;</td>
90
 
          <td class="mdname" nowrap> <em>pIfd1</em>, </td>
91
 
        </tr>
92
 
        <tr>
93
 
          <td class="md" nowrap align="right"></td>
94
 
          <td class="md"></td>
95
 
          <td class="md" nowrap>const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *&nbsp;</td>
96
 
          <td class="mdname" nowrap> <em>buf</em>, </td>
97
 
        </tr>
98
 
        <tr>
99
 
          <td class="md" nowrap align="right"></td>
100
 
          <td class="md"></td>
101
 
          <td class="md" nowrap>long&nbsp;</td>
102
 
          <td class="mdname" nowrap> <em>len</em></td>
103
 
        </tr>
104
 
        <tr>
105
 
          <td class="md"></td>
106
 
          <td class="md">)&nbsp;</td>
107
 
          <td class="md" colspan="2"> const<code> [pure virtual]</code></td>
 
80
<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" -->
 
81
<div class="memitem">
 
82
<div class="memproto">
 
83
      <table class="memname">
 
84
        <tr>
 
85
          <td class="memname">virtual int Exiv2::Thumbnail::setDataArea           </td>
 
86
          <td>(</td>
 
87
          <td class="paramtype"><a class="el" href="classExiv2_1_1ExifData.html">ExifData</a> &amp;&nbsp;</td>
 
88
          <td class="paramname"> <em>exifData</em>, </td>
 
89
        </tr>
 
90
        <tr>
 
91
          <td class="paramkey"></td>
 
92
          <td></td>
 
93
          <td class="paramtype"><a class="el" href="classExiv2_1_1Ifd.html">Ifd</a> *&nbsp;</td>
 
94
          <td class="paramname"> <em>pIfd1</em>, </td>
 
95
        </tr>
 
96
        <tr>
 
97
          <td class="paramkey"></td>
 
98
          <td></td>
 
99
          <td class="paramtype">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *&nbsp;</td>
 
100
          <td class="paramname"> <em>buf</em>, </td>
 
101
        </tr>
 
102
        <tr>
 
103
          <td class="paramkey"></td>
 
104
          <td></td>
 
105
          <td class="paramtype">long&nbsp;</td>
 
106
          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
 
107
        </tr>
 
108
        <tr>
 
109
          <td></td>
 
110
          <td>)</td>
 
111
          <td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
108
112
        </tr>
109
113
      </table>
110
 
    </td>
111
 
  </tr>
112
 
</table>
113
 
<table cellspacing="5" cellpadding="0" border="0">
114
 
  <tr>
115
 
    <td>
116
 
      &nbsp;
117
 
    </td>
118
 
    <td>
 
114
</div>
 
115
<div class="memdoc">
119
116
 
120
117
<p>
121
118
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. 
128
125
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>Number of bytes in the data buffer. </td></tr>
129
126
  </table>
130
127
</dl>
131
 
<dl compact><dt><b>Returns:</b></dt><dd>0 if successful;<br>
 
128
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful;<br>
132
129
 1 in case of inconsistent thumbnail Exif data; or<br>
133
130
 2 if the data area is outside of the data buffer </dd></dl>
134
131
 
135
132
<p>
136
 
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>
137
 
  </tr>
138
 
</table>
 
133
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>.
 
134
</div>
 
135
</div><p>
139
136
<hr>The documentation for this class was generated from the following file:<ul>
140
137
<li><a class="el" href="exif_8hpp.html">exif.hpp</a></ul>
141
 
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:54:55 2006 for Exiv2 by&nbsp;
 
138
<hr size="1"><address style="align: right;"><small>Generated on Mon Nov 27 20:16:27 2006 for Exiv2 by&nbsp;
142
139
<a href="http://www.doxygen.org/index.html">
143
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
 
140
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
144
141
</body>
145
142
</html>