<!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::XmpTextValue 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 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> <u>S</u>earch for </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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1XmpTextValue.html">XmpTextValue</a>
</div>
</div>
<div class="contents">
<h1>Exiv2::XmpTextValue Class Reference</h1><!-- doxytag: class="Exiv2::XmpTextValue" --><!-- doxytag: inherits="Exiv2::XmpValue" -->Value type suitable for simple XMP properties and XMP nodes of complex types which are not parsed into specific values.
<a href="#_details">More...</a>
<p>
<code>#include <value.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for Exiv2::XmpTextValue:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1XmpTextValue__inherit__graph.png" border="0" usemap="#Exiv2_1_1XmpTextValue__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1XmpTextValue__inherit__map">
<area shape="rect" id="node2" href="classExiv2_1_1XmpValue.html" title="Base class for all Exiv2 values used to store XMP property values." alt="" coords="25,80,196,107"><area shape="rect" id="node4" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata." alt="" coords="40,5,181,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for Exiv2::XmpTextValue:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1XmpTextValue__coll__graph.png" border="0" usemap="#Exiv2_1_1XmpTextValue__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1XmpTextValue__coll__map">
<area shape="rect" id="node2" href="classExiv2_1_1XmpValue.html" title="Base class for all Exiv2 values used to store XMP property values." alt="" coords="5,83,176,109"><area shape="rect" id="node4" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata." alt="" coords="8,5,149,32"><area shape="rect" id="node6" title="STL class." alt="" coords="223,83,353,109"><area shape="rect" id="node8" title="STL class." alt="" coords="173,5,424,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classExiv2_1_1XmpTextValue-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="cc84736acca75059f54d022d6a2df0b9"></a><!-- doxytag: member="Exiv2::XmpTextValue::AutoPtr" ref="cc84736acca75059f54d022d6a2df0b9" args="" -->
typedef std::auto_ptr<br class="typebreak">
< <a class="el" href="classExiv2_1_1XmpTextValue.html">XmpTextValue</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#cc84736acca75059f54d022d6a2df0b9">AutoPtr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for a XmpTextValue 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="52258246de480683ba8c26331729cb9a"></a><!-- doxytag: member="Exiv2::XmpTextValue::XmpTextValue" ref="52258246de480683ba8c26331729cb9a" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#52258246de480683ba8c26331729cb9a">XmpTextValue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b3fad8cf98fdf1f898d60f81be8419e1"></a><!-- doxytag: member="Exiv2::XmpTextValue::XmpTextValue" ref="b3fad8cf98fdf1f898d60f81be8419e1" args="(const std::string &buf)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#b3fad8cf98fdf1f898d60f81be8419e1">XmpTextValue</a> (const std::string &buf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor, reads the value from a string. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#03ba8322cd618df04eda0e2c6f7b6246">read</a> (const std::string &buf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a simple property value from <em>buf</em> to set the value. <a href="#03ba8322cd618df04eda0e2c6f7b6246"></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="561ad6cff040327b8e9964b332d2b85b"></a><!-- doxytag: member="Exiv2::XmpTextValue::clone" ref="561ad6cff040327b8e9964b332d2b85b" args="() const " -->
<a class="el" href="classExiv2_1_1Value.html#0f62e585b82c97738858b743e60dff21">AutoPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#561ad6cff040327b8e9964b332d2b85b">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </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="746a16b23d4c2980f3f31cb9def9a345"></a><!-- doxytag: member="Exiv2::XmpTextValue::size" ref="746a16b23d4c2980f3f31cb9def9a345" args="() const " -->
long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#746a16b23d4c2980f3f31cb9def9a345">size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the size of the value in bytes. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2c9433139060cafd14e526614ad14a29"></a><!-- doxytag: member="Exiv2::XmpTextValue::count" ref="2c9433139060cafd14e526614ad14a29" args="() const " -->
virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#2c9433139060cafd14e526614ad14a29">count</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of components of the value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#0220f4814b8d06e72ae6dec42e041cd9">toLong</a> (long n=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert the value to a long. The optional parameter <em>n</em> is not used and is ignored. <a href="#0220f4814b8d06e72ae6dec42e041cd9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#2a7411ff9d3a1d01ea115279e2fce2e5">toFloat</a> (long n=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert the value to a float. The optional parameter <em>n</em> is not used and is ignored. <a href="#2a7411ff9d3a1d01ea115279e2fce2e5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceExiv2.html#95756f3f7fa19103f83addf5fa088a30">Rational</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#b8da16bab92ec69ffef01384fd1ff4bb">toRational</a> (long n=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert the value to a Rational. The optional parameter <em>n</em> is not used and is ignored. <a href="#b8da16bab92ec69ffef01384fd1ff4bb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="872bdf2bce441a5a36483b6cd8b97a0d"></a><!-- doxytag: member="Exiv2::XmpTextValue::write" ref="872bdf2bce441a5a36483b6cd8b97a0d" args="(std::ostream &os) const " -->
virtual std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#872bdf2bce441a5a36483b6cd8b97a0d">write</a> (std::ostream &os) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write the value to an output stream. You do not usually have to use this function; it is used for the implementation of the output operator for Value, <a class="el" href="namespaceExiv2.html#be882054db13fc2f4f6f7e8e1261d982" title="Output operator for Value types.">operator<<(std::ostream &os, const Value &value)</a>. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="deadb1227704c657d32183af5da010a8"></a><!-- doxytag: member="Exiv2::XmpTextValue::value_" ref="deadb1227704c657d32183af5da010a8" args="" -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1XmpTextValue.html#deadb1227704c657d32183af5da010a8">value_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stores the string values. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Value type suitable for simple XMP properties and XMP nodes of complex types which are not parsed into specific values.
<p>
Uses a std::string to store the value. <dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="xmpsample_8cpp-example.html#_a2">xmpsample.cpp</a>.</dl><hr><h2>Member Function Documentation</h2>
<a class="anchor" name="03ba8322cd618df04eda0e2c6f7b6246"></a><!-- doxytag: member="Exiv2::XmpTextValue::read" ref="03ba8322cd618df04eda0e2c6f7b6246" args="(const std::string &buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Exiv2::XmpTextValue::read </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>buf</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read a simple property value from <em>buf</em> to set the value.
<p>
Sets the value to the contents of <em>buf</em>. A optional keyword, <em>type</em> is supported to set the XMP value type. This is useful for complex value types for which <a class="el" href="namespaceExiv2.html" title="Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2...">Exiv2</a> does not have direct support.<p>
The format of <em>buf</em> is: <br>
<code>[type=["]Alt|Bag|Seq|Struct["] ]text</code> <br>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful. </dd></dl>
<p>Implements <a class="el" href="classExiv2_1_1XmpValue.html#7c357e0bee86bd3c6eee197711472821">Exiv2::XmpValue</a>.</p>
</div>
</div><p>
<a class="anchor" name="2a7411ff9d3a1d01ea115279e2fce2e5"></a><!-- doxytag: member="Exiv2::XmpTextValue::toFloat" ref="2a7411ff9d3a1d01ea115279e2fce2e5" args="(long n=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float Exiv2::XmpTextValue::toFloat </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"> <em>n</em> = <code>0</code> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert the value to a float. The optional parameter <em>n</em> is not used and is ignored.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The converted value. </dd></dl>
<p>Implements <a class="el" href="classExiv2_1_1Value.html#22d257caa6c1ffe6416ce02de7bd8c1c">Exiv2::Value</a>.</p>
</div>
</div><p>
<a class="anchor" name="0220f4814b8d06e72ae6dec42e041cd9"></a><!-- doxytag: member="Exiv2::XmpTextValue::toLong" ref="0220f4814b8d06e72ae6dec42e041cd9" args="(long n=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual long Exiv2::XmpTextValue::toLong </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"> <em>n</em> = <code>0</code> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert the value to a long. The optional parameter <em>n</em> is not used and is ignored.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The converted value. </dd></dl>
<p>Implements <a class="el" href="classExiv2_1_1Value.html#4530a3fc3e2305cf994de5476f46f953">Exiv2::Value</a>.</p>
</div>
</div><p>
<a class="anchor" name="b8da16bab92ec69ffef01384fd1ff4bb"></a><!-- doxytag: member="Exiv2::XmpTextValue::toRational" ref="b8da16bab92ec69ffef01384fd1ff4bb" args="(long n=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceExiv2.html#95756f3f7fa19103f83addf5fa088a30">Rational</a> Exiv2::XmpTextValue::toRational </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"> <em>n</em> = <code>0</code> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert the value to a Rational. The optional parameter <em>n</em> is not used and is ignored.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The converted value. </dd></dl>
<p>Implements <a class="el" href="classExiv2_1_1Value.html#595a4cb549bec8c19d290ca3e95a2678">Exiv2::Value</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="value_8hpp.html">value.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 25 15:18:09 2009 for Exiv2 by
<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>
