File: classExiv2_1_1CommentValue.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 (159 lines) | stat: -rw-r--r-- 13,248 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
<!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::CommentValue 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_1CommentValue.html">CommentValue</a></div>
<h1>Exiv2::CommentValue Class Reference</h1><!-- doxytag: class="Exiv2::CommentValue" --><!-- doxytag: inherits="Exiv2::StringValueBase" -->Value for an Exif comment.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;value.hpp&gt;</code>
<p>
Inheritance diagram for Exiv2::CommentValue:<p><center><img src="classExiv2_1_1CommentValue__inherit__graph.png" border="0" usemap="#Exiv2_1_1CommentValue__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1CommentValue__inherit__map">
<area href="classExiv2_1_1StringValueBase.html" shape="rect" coords="6,82,166,106" alt="">
<area href="classExiv2_1_1Value.html" shape="rect" coords="38,7,134,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Exiv2::CommentValue:<p><center><img src="classExiv2_1_1CommentValue__coll__graph.png" border="0" usemap="#Exiv2_1_1CommentValue__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1CommentValue__coll__map">
<area href="classExiv2_1_1StringValueBase.html" shape="rect" coords="12,265,172,289" alt="">
<area href="classExiv2_1_1Value.html" shape="rect" coords="5,175,101,199" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classExiv2_1_1CommentValue-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="da887f6b7f7554599f672e6ebc06fd8d"></a><!-- doxytag: member="Exiv2::CommentValue::AutoPtr" ref="da887f6b7f7554599f672e6ebc06fd8d" args="" -->
typedef std::auto_ptr&lt; <a class="el" href="classExiv2_1_1CommentValue.html">CommentValue</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#da887f6b7f7554599f672e6ebc06fd8d">AutoPtr</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for a CommentValue auto pointer. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#e18c0bebdb51d4380c32b20f89f8fdc2">CharsetId</a> { <br>
&nbsp;&nbsp;<b>ascii</b>, 
<b>jis</b>, 
<b>unicode</b>, 
<b>undefined</b>, 
<br>
&nbsp;&nbsp;<b>invalidCharsetId</b>, 
<b>lastCharsetId</b>
<br>
 }</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Character set identifiers for the character sets defined by Exif. <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="78b03cf4b841577f41e10ae51962b710"></a><!-- doxytag: member="Exiv2::CommentValue::CommentValue" ref="78b03cf4b841577f41e10ae51962b710" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#78b03cf4b841577f41e10ae51962b710">CommentValue</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4305d98b7eef38ca055f4bc1a3ddb96e"></a><!-- doxytag: member="Exiv2::CommentValue::CommentValue" ref="4305d98b7eef38ca055f4bc1a3ddb96e" args="(const std::string &amp;comment)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#4305d98b7eef38ca055f4bc1a3ddb96e">CommentValue</a> (const std::string &amp;comment)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor, uses <a class="el" href="classExiv2_1_1CommentValue.html#0dc1a2489912d18b05ba25881ed172c3">read(const std::string&amp; comment)</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="959377c46d48a81569bbd707ae9b0e94"></a><!-- doxytag: member="Exiv2::CommentValue::CommentValue" ref="959377c46d48a81569bbd707ae9b0e94" args="(const CommentValue &amp;rhs)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#959377c46d48a81569bbd707ae9b0e94">CommentValue</a> (const <a class="el" href="classExiv2_1_1CommentValue.html">CommentValue</a> &amp;rhs)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d3b703bbc31f72ec2324d79b31bc291"></a><!-- doxytag: member="Exiv2::CommentValue::~CommentValue" ref="2d3b703bbc31f72ec2324d79b31bc291" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#2d3b703bbc31f72ec2324d79b31bc291">~CommentValue</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual destructor. <br></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="18264f7bd0511d7e59551aa0f4d2cc64"></a><!-- doxytag: member="Exiv2::CommentValue::operator=" ref="18264f7bd0511d7e59551aa0f4d2cc64" args="(const CommentValue &amp;rhs)" -->
<a class="el" href="classExiv2_1_1CommentValue.html">CommentValue</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#18264f7bd0511d7e59551aa0f4d2cc64">operator=</a> (const <a class="el" href="classExiv2_1_1CommentValue.html">CommentValue</a> &amp;rhs)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#0dc1a2489912d18b05ba25881ed172c3">read</a> (const std::string &amp;comment)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the value from a comment.  <a href="#0dc1a2489912d18b05ba25881ed172c3"></a><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="00d56cf25c0e981f4fed3aa30619c383"></a><!-- doxytag: member="Exiv2::CommentValue::clone" ref="00d56cf25c0e981f4fed3aa30619c383" args="() const " -->
<a class="el" href="classExiv2_1_1CommentValue.html#da887f6b7f7554599f672e6ebc06fd8d">AutoPtr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#00d56cf25c0e981f4fed3aa30619c383">clone</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return an auto-pointer to a copy of itself (deep copy). The caller owns this copy and the auto-pointer ensures that it will be deleted. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="313468dff47849581ae4f654aa314816"></a><!-- doxytag: member="Exiv2::CommentValue::write" ref="313468dff47849581ae4f654aa314816" args="(std::ostream &amp;os) const " -->
std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#313468dff47849581ae4f654aa314816">write</a> (std::ostream &amp;os) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write the comment in a format which can be read by <a class="el" href="classExiv2_1_1CommentValue.html#0dc1a2489912d18b05ba25881ed172c3">read(const std::string&amp; comment)</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f233b3986472bd654d00e1f895efc72b"></a><!-- doxytag: member="Exiv2::CommentValue::comment" ref="f233b3986472bd654d00e1f895efc72b" args="() const " -->
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#f233b3986472bd654d00e1f895efc72b">comment</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the comment (without a charset="..." prefix). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fe98d1bbc93dd695e39cd4f719b54d18"></a><!-- doxytag: member="Exiv2::CommentValue::charsetId" ref="fe98d1bbc93dd695e39cd4f719b54d18" args="() const " -->
<a class="el" href="classExiv2_1_1CommentValue.html#e18c0bebdb51d4380c32b20f89f8fdc2">CharsetId</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue.html#fe98d1bbc93dd695e39cd4f719b54d18">charsetId</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the charset id of the comment. <br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1CommentValue_1_1CharsetInfo.html">CharsetInfo</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Charset information lookup functions. Implemented as a static class.  <a href="classExiv2_1_1CommentValue_1_1CharsetInfo.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1CommentValue_1_1CharsetTable.html">CharsetTable</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Information pertaining to the defined character sets.  <a href="structExiv2_1_1CommentValue_1_1CharsetTable.html#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Value for an Exif comment. 
<p>
This can be a plain Ascii string or a multipe byte encoded string. The comment is expected to be encoded in the character set indicated (default undefined), but this is not checked. It is left to caller to decode and encode the string to and from readable text if that is required. 
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0dc1a2489912d18b05ba25881ed172c3"></a><!-- doxytag: member="Exiv2::CommentValue::read" ref="0dc1a2489912d18b05ba25881ed172c3" args="(const std::string &amp;comment)" --><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">int Exiv2::CommentValue::read           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>comment</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Read the value from a comment. 
<p>
The format of <em>comment</em> is: <br>
 <code>[charset=["]Ascii|Jis|Unicode|Undefined["] ]comment</code> <br>
 The default charset is Undefined.<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 if successful<br>
 1 if an invalid character set is encountered </dd></dl>

<p>
Reimplemented from <a class="el" href="classExiv2_1_1StringValueBase.html#7e1a2e4e99a63eb1ef815317f012c57b">Exiv2::StringValueBase</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="value_8hpp.html">value.hpp</a><li>value.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:55:42 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>