<!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::Key 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_1Key.html">Key</a>
</div>
</div>
<div class="contents">
<h1>Exiv2::Key Class Reference</h1><!-- doxytag: class="Exiv2::Key" -->Abstract base class defining the Key of a metadatum. Keys are used to identify and group metadata.
<a href="#_details">More...</a>
<p>
<code>#include <metadatum.hpp></code>
<p>
<div class="dynheader">
Inheritance diagram for Exiv2::Key:</div>
<div class="dynsection">
<p><center><img src="classExiv2_1_1Key__inherit__graph.png" border="0" usemap="#Exiv2_1_1Key__inherit__map" alt="Inheritance graph"></center>
<map name="Exiv2_1_1Key__inherit__map">
<area shape="rect" id="node3" href="classExiv2_1_1ExifKey.html" title="Concrete keys for Exif metadata." alt="" coords="5,80,165,107"><area shape="rect" id="node5" href="classExiv2_1_1IptcKey.html" title="Concrete keys for IPTC metadata." alt="" coords="189,80,349,107"><area shape="rect" id="node7" href="classExiv2_1_1XmpKey.html" title="Concrete keys for XMP metadata." alt="" coords="373,80,525,107"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classExiv2_1_1Key-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="9bf9953294ceb8d272908a0680aeade8"></a><!-- doxytag: member="Exiv2::Key::AutoPtr" ref="9bf9953294ceb8d272908a0680aeade8" args="" -->
typedef std::auto_ptr< <a class="el" href="classExiv2_1_1Key.html">Key</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#9bf9953294ceb8d272908a0680aeade8">AutoPtr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for a Key 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="85cc8a8e0770fef573df402f56f1049c"></a><!-- doxytag: member="Exiv2::Key::~Key" ref="85cc8a8e0770fef573df402f56f1049c" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#85cc8a8e0770fef573df402f56f1049c">~Key</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <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="272fe50e38e5af51bc3fa54e32cd7931"></a><!-- doxytag: member="Exiv2::Key::key" ref="272fe50e38e5af51bc3fa54e32cd7931" args="() const =0" -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#272fe50e38e5af51bc3fa54e32cd7931">key</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the key of the metadatum as a string. The key is of the form 'familyName.groupName.tagName'. Note however that the key is not necessarily unique, e.g., an <a class="el" href="classExiv2_1_1ExifData.html" title="A container for Exif data. This is a top-level class of the Exiv2 library. The container...">ExifData</a> may contain multiple metadata with the same key. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ebbef8a4d9e11459ecd30d1497911d90"></a><!-- doxytag: member="Exiv2::Key::familyName" ref="ebbef8a4d9e11459ecd30d1497911d90" args="() const =0" -->
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#ebbef8a4d9e11459ecd30d1497911d90">familyName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an identifier for the type of metadata (the first part of the key). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23dab45ff9d7151b484b90e686e833fd"></a><!-- doxytag: member="Exiv2::Key::groupName" ref="23dab45ff9d7151b484b90e686e833fd" args="() const =0" -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#23dab45ff9d7151b484b90e686e833fd">groupName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the group (the second part of the key). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6bccc6d5552d2c3324d28099554b5c0"></a><!-- doxytag: member="Exiv2::Key::tagName" ref="f6bccc6d5552d2c3324d28099554b5c0" args="() const =0" -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#f6bccc6d5552d2c3324d28099554b5c0">tagName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the tag (which is also the third part of the key). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3593df05b735beb63ec263ee00f37e37"></a><!-- doxytag: member="Exiv2::Key::tagLabel" ref="3593df05b735beb63ec263ee00f37e37" args="() const =0" -->
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#3593df05b735beb63ec263ee00f37e37">tagLabel</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a label for the tag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a04f9c117d0373661b982ac63a9ce84"></a><!-- doxytag: member="Exiv2::Key::tag" ref="7a04f9c117d0373661b982ac63a9ce84" args="() const =0" -->
virtual uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#7a04f9c117d0373661b982ac63a9ce84">tag</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the tag number. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b7739119f2b5fe8e14b4f4b29a04cb8"></a><!-- doxytag: member="Exiv2::Key::clone" ref="2b7739119f2b5fe8e14b4f4b29a04cb8" args="() const " -->
<a class="el" href="classExiv2_1_1Key.html#9bf9953294ceb8d272908a0680aeade8">AutoPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#2b7739119f2b5fe8e14b4f4b29a04cb8">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="dc70aa4f962abd267e2d4f98f89538b5"></a><!-- doxytag: member="Exiv2::Key::write" ref="dc70aa4f962abd267e2d4f98f89538b5" args="(std::ostream &os) const " -->
std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#dc70aa4f962abd267e2d4f98f89538b5">write</a> (std::ostream &os) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write the key to an output stream. You do not usually have to use this function; it is used for the implementation of the output operator for Key, <a class="el" href="namespaceExiv2.html#a225826fb028de2941da4230b51dfb95" title="Output operator for Key types.">operator<<(std::ostream &os, const Key &key)</a>. <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="4e33d283e9e6a8384d8aa79c1848a45f"></a><!-- doxytag: member="Exiv2::Key::operator=" ref="4e33d283e9e6a8384d8aa79c1848a45f" args="(const Key &rhs)" -->
<a class="el" href="classExiv2_1_1Key.html">Key</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#4e33d283e9e6a8384d8aa79c1848a45f">operator=</a> (const <a class="el" href="classExiv2_1_1Key.html">Key</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </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>
Abstract base class defining the Key of a metadatum. Keys are used to identify and group metadata. <hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="metadatum_8hpp.html">metadatum.hpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jun 25 15:18:00 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>
