Sophie

Sophie

distrib > * > 2010.0 > * > by-pkgid > b36c97ff723e66f0f38bce83645c99dc > files > 662

exiv2-doc-0.18.2-1mdv2010.0.x86_64.rpm

<!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::LangAltValue 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&nbsp;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>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</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="navpath"><a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1LangAltValue.html">LangAltValue</a>
  </div>
</div>
<div class="contents">
<h1>Exiv2::LangAltValue Class Reference</h1><!-- doxytag: class="Exiv2::LangAltValue" --><!-- doxytag: inherits="Exiv2::XmpValue" -->Value type for XMP language alternative properties.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;value.hpp&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Exiv2::LangAltValue:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1LangAltValue__inherit__graph.png" border="0" usemap="#Exiv2_1_1LangAltValue__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1LangAltValue__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::LangAltValue:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1LangAltValue__coll__graph.png" border="0" usemap="#Exiv2_1_1LangAltValue__coll__map" alt="Collaboration graph"></center>
<map name="Exiv2_1_1LangAltValue__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,200,176,227"><area shape="rect" id="node4" href="classExiv2_1_1Value.html" title="Common interface for all types of values used with metadata." alt="" coords="20,96,161,123"><area shape="rect" id="node8" title="STL class." alt="" coords="236,96,367,123"><area shape="rect" id="node10" title="STL class." alt="" coords="176,5,427,32"><area shape="rect" id="node12" title="STL class." alt="" coords="391,96,572,123"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classExiv2_1_1LangAltValue-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="18b73e897cc64099315ce0acb1dbc191"></a><!-- doxytag: member="Exiv2::LangAltValue::AutoPtr" ref="18b73e897cc64099315ce0acb1dbc191" args="" -->
typedef std::auto_ptr<br class="typebreak">
&lt; <a class="el" href="classExiv2_1_1LangAltValue.html">LangAltValue</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#18b73e897cc64099315ce0acb1dbc191">AutoPtr</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for a LangAltValue auto pointer. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="274c05cd21a217178a9901463f58539d"></a><!-- doxytag: member="Exiv2::LangAltValue::ValueType" ref="274c05cd21a217178a9901463f58539d" args="" -->
typedef std::map&lt; std::string, <br class="typebreak">
std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#274c05cd21a217178a9901463f58539d">ValueType</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type used to store language alternative arrays. <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="a6e57338d68ad7a79567e7d4271ce74c"></a><!-- doxytag: member="Exiv2::LangAltValue::LangAltValue" ref="a6e57338d68ad7a79567e7d4271ce74c" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#a6e57338d68ad7a79567e7d4271ce74c">LangAltValue</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf8c25b7c35adcd521ec83bacd0b09fd"></a><!-- doxytag: member="Exiv2::LangAltValue::LangAltValue" ref="bf8c25b7c35adcd521ec83bacd0b09fd" args="(const std::string &amp;buf)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#bf8c25b7c35adcd521ec83bacd0b09fd">LangAltValue</a> (const std::string &amp;buf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#aab6ae9d75120ba24a4ddec341e77c1e">read</a> (const std::string &amp;buf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a simple property value from <em>buf</em> and append it to the value.  <a href="#aab6ae9d75120ba24a4ddec341e77c1e"></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="e098ae0147e440357a080f0b380d8afe"></a><!-- doxytag: member="Exiv2::LangAltValue::clone" ref="e098ae0147e440357a080f0b380d8afe" args="() const " -->
<a class="el" href="classExiv2_1_1Value.html#0f62e585b82c97738858b743e60dff21">AutoPtr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#e098ae0147e440357a080f0b380d8afe">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="6886a0e3975489a835eade902ab4af27"></a><!-- doxytag: member="Exiv2::LangAltValue::count" ref="6886a0e3975489a835eade902ab4af27" args="() const " -->
virtual long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#6886a0e3975489a835eade902ab4af27">count</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of components of the value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0aa323aa580cb5bab6d58376df1540a8"></a><!-- doxytag: member="Exiv2::LangAltValue::toString" ref="0aa323aa580cb5bab6d58376df1540a8" args="(long n) const " -->
virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#0aa323aa580cb5bab6d58376df1540a8">toString</a> (long n) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the text value associated with the default language qualifier <code>x-default</code>. The parameter <em>n</em> is not used, but it is suggested that only 0 is passed in. Returns an empty string and sets the ok-flag to <code>false</code> if there is no default value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ffa315745ded92e9d3800badfa869e24"></a><!-- doxytag: member="Exiv2::LangAltValue::toString" ref="ffa315745ded92e9d3800badfa869e24" args="(const std::string &amp;qualifier) const " -->
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#ffa315745ded92e9d3800badfa869e24">toString</a> (const std::string &amp;qualifier) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the text value associated with the language qualifier <em>qualifier</em>. Returns an empty string and sets the ok-flag to <code>false</code> if there is no entry for the language qualifier. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#ae937ce812b87dc709c65f2d7da0c077">toLong</a> (long n=0) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert the <em>n</em>-th component of the value to a long. The behaviour of this method may be undefined if there is no <em>n</em>-th component.  <a href="#ae937ce812b87dc709c65f2d7da0c077"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#bb25ea5dd915aa7b972e790e5cc4e9ef">toFloat</a> (long n=0) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert the <em>n</em>-th component of the value to a float. The behaviour of this method may be undefined if there is no <em>n</em>-th component.  <a href="#bb25ea5dd915aa7b972e790e5cc4e9ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="namespaceExiv2.html#95756f3f7fa19103f83addf5fa088a30">Rational</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#b95c854a7e8496783815801959a38d23">toRational</a> (long n=0) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert the <em>n</em>-th component of the value to a Rational. The behaviour of this method may be undefined if there is no <em>n</em>-th component.  <a href="#b95c854a7e8496783815801959a38d23"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#5fcf596f0ed460bf66280ed5066ed7e9">write</a> (std::ostream &amp;os) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write all elements of the value to <em>os</em>, separated by commas.  <a href="#5fcf596f0ed460bf66280ed5066ed7e9"></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="e466310e854d707c1e5f5a44730a27c9"></a><!-- doxytag: member="Exiv2::LangAltValue::value_" ref="e466310e854d707c1e5f5a44730a27c9" args="" -->
<a class="el" href="classExiv2_1_1LangAltValue.html#274c05cd21a217178a9901463f58539d">ValueType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1LangAltValue.html#e466310e854d707c1e5f5a44730a27c9">value_</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Map to store the language alternative values. The language qualifier is used as the key for the map entries. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Value type for XMP language alternative properties. 
<p>
A language alternative is an array consisting of simple text values, each of which has a language qualifier. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="aab6ae9d75120ba24a4ddec341e77c1e"></a><!-- doxytag: member="Exiv2::LangAltValue::read" ref="aab6ae9d75120ba24a4ddec341e77c1e" args="(const std::string &amp;buf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int Exiv2::LangAltValue::read           </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>buf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read a simple property value from <em>buf</em> and append it to the value. 
<p>
Appends <em>buf</em> to the value after the last existing array element. Subsequent calls will therefore populate multiple array elements in the order they are read.<p>
The format of <em>buf</em> is: <br>
 <code>[lang=["]language code["] ]text</code> <br>
 The XMP default language code <code>x-default</code> is used if <em>buf</em> doesn't start with the keyword <code>lang</code>.<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="bb25ea5dd915aa7b972e790e5cc4e9ef"></a><!-- doxytag: member="Exiv2::LangAltValue::toFloat" ref="bb25ea5dd915aa7b972e790e5cc4e9ef" args="(long n=0) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual float Exiv2::LangAltValue::toFloat           </td>
          <td>(</td>
          <td class="paramtype">long&nbsp;</td>
          <td class="paramname"> <em>n</em> = <code>0</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convert the <em>n</em>-th component of the value to a float. The behaviour of this method may be undefined if there is no <em>n</em>-th component. 
<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="ae937ce812b87dc709c65f2d7da0c077"></a><!-- doxytag: member="Exiv2::LangAltValue::toLong" ref="ae937ce812b87dc709c65f2d7da0c077" args="(long n=0) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual long Exiv2::LangAltValue::toLong           </td>
          <td>(</td>
          <td class="paramtype">long&nbsp;</td>
          <td class="paramname"> <em>n</em> = <code>0</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convert the <em>n</em>-th component of the value to a long. The behaviour of this method may be undefined if there is no <em>n</em>-th component. 
<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="b95c854a7e8496783815801959a38d23"></a><!-- doxytag: member="Exiv2::LangAltValue::toRational" ref="b95c854a7e8496783815801959a38d23" 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::LangAltValue::toRational           </td>
          <td>(</td>
          <td class="paramtype">long&nbsp;</td>
          <td class="paramname"> <em>n</em> = <code>0</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convert the <em>n</em>-th component of the value to a Rational. The behaviour of this method may be undefined if there is no <em>n</em>-th component. 
<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>
<a class="anchor" name="5fcf596f0ed460bf66280ed5066ed7e9"></a><!-- doxytag: member="Exiv2::LangAltValue::write" ref="5fcf596f0ed460bf66280ed5066ed7e9" args="(std::ostream &amp;os) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::ostream&amp; Exiv2::LangAltValue::write           </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>os</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Write all elements of the value to <em>os</em>, separated by commas. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>The output of this method cannot directly be used as the parameter for <a class="el" href="classExiv2_1_1LangAltValue.html#aab6ae9d75120ba24a4ddec341e77c1e" title="Read a simple property value from buf and append it to the value.">read()</a>. </dd></dl>

<p>Implements <a class="el" href="classExiv2_1_1Value.html#2518f5ba09fc8c00785c57a119892c4c">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:10 2009 for Exiv2 by&nbsp;
<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>