<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>Exiv2: Exiv2::Key Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Exiv2
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceExiv2.html">Exiv2</a></li><li class="navelem"><a class="el" href="classExiv2_1_1Key.html">Key</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="classExiv2_1_1Key-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Exiv2::Key Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Abstract base class defining the Key of a metadatum. Keys are used to identify and group metadata.
<a href="classExiv2_1_1Key.html#details">More...</a></p>
<p><code>#include <metadatum.hpp></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Exiv2::Key:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classExiv2_1_1Key__inherit__graph.png" border="0" usemap="#Exiv2_1_1Key_inherit__map" alt="Inheritance graph"/></div>
<map name="Exiv2_1_1Key_inherit__map" id="Exiv2_1_1Key_inherit__map">
<area shape="rect" id="node2" href="classExiv2_1_1ExifKey.html" title="Concrete keys for Exif metadata and access to Exif tag reference data. " alt="" coords="5,80,168,107"/><area shape="rect" id="node3" href="classExiv2_1_1IptcKey.html" title="Concrete keys for IPTC metadata. " alt="" coords="192,80,355,107"/><area shape="rect" id="node4" href="classExiv2_1_1XmpKey.html" title="Concrete keys for XMP metadata. " alt="" coords="379,80,531,107"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9bf9953294ceb8d272908a0680aeade8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bf9953294ceb8d272908a0680aeade8"></a>
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#a9bf9953294ceb8d272908a0680aeade8">AutoPtr</a></td></tr>
<tr class="memdesc:a9bf9953294ceb8d272908a0680aeade8"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for a Key auto pointer. <br /></td></tr>
<tr class="separator:a9bf9953294ceb8d272908a0680aeade8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Creators</div></td></tr>
<tr class="memitem:a574f73b95eb37cfa7ad509b0b1c26b61"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a574f73b95eb37cfa7ad509b0b1c26b61"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#a574f73b95eb37cfa7ad509b0b1c26b61">~Key</a> ()</td></tr>
<tr class="memdesc:a574f73b95eb37cfa7ad509b0b1c26b61"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a574f73b95eb37cfa7ad509b0b1c26b61"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr class="memitem:a272fe50e38e5af51bc3fa54e32cd7931"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a272fe50e38e5af51bc3fa54e32cd7931"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#a272fe50e38e5af51bc3fa54e32cd7931">key</a> () const =0</td></tr>
<tr class="memdesc:a272fe50e38e5af51bc3fa54e32cd7931"><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 holds Exifda...">ExifData</a> may contain multiple metadata with the same key. <br /></td></tr>
<tr class="separator:a272fe50e38e5af51bc3fa54e32cd7931"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebbef8a4d9e11459ecd30d1497911d90"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aebbef8a4d9e11459ecd30d1497911d90"></a>
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#aebbef8a4d9e11459ecd30d1497911d90">familyName</a> () const =0</td></tr>
<tr class="memdesc:aebbef8a4d9e11459ecd30d1497911d90"><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 class="separator:aebbef8a4d9e11459ecd30d1497911d90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23dab45ff9d7151b484b90e686e833fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23dab45ff9d7151b484b90e686e833fd"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#a23dab45ff9d7151b484b90e686e833fd">groupName</a> () const =0</td></tr>
<tr class="memdesc:a23dab45ff9d7151b484b90e686e833fd"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the group (the second part of the key) <br /></td></tr>
<tr class="separator:a23dab45ff9d7151b484b90e686e833fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6bccc6d5552d2c3324d28099554b5c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6bccc6d5552d2c3324d28099554b5c0"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#af6bccc6d5552d2c3324d28099554b5c0">tagName</a> () const =0</td></tr>
<tr class="memdesc:af6bccc6d5552d2c3324d28099554b5c0"><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 class="separator:af6bccc6d5552d2c3324d28099554b5c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3593df05b735beb63ec263ee00f37e37"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3593df05b735beb63ec263ee00f37e37"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#a3593df05b735beb63ec263ee00f37e37">tagLabel</a> () const =0</td></tr>
<tr class="memdesc:a3593df05b735beb63ec263ee00f37e37"><td class="mdescLeft"> </td><td class="mdescRight">Return a label for the tag. <br /></td></tr>
<tr class="separator:a3593df05b735beb63ec263ee00f37e37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a04f9c117d0373661b982ac63a9ce84"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a04f9c117d0373661b982ac63a9ce84"></a>
virtual uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#a7a04f9c117d0373661b982ac63a9ce84">tag</a> () const =0</td></tr>
<tr class="memdesc:a7a04f9c117d0373661b982ac63a9ce84"><td class="mdescLeft"> </td><td class="mdescRight">Return the tag number. <br /></td></tr>
<tr class="separator:a7a04f9c117d0373661b982ac63a9ce84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f7e6d66e806bb9e80f35ca77d12062c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f7e6d66e806bb9e80f35ca77d12062c"></a>
<a class="el" href="classExiv2_1_1Key.html#a9bf9953294ceb8d272908a0680aeade8">AutoPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#a9f7e6d66e806bb9e80f35ca77d12062c">clone</a> () const </td></tr>
<tr class="memdesc:a9f7e6d66e806bb9e80f35ca77d12062c"><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 class="separator:a9f7e6d66e806bb9e80f35ca77d12062c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc70aa4f962abd267e2d4f98f89538b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc70aa4f962abd267e2d4f98f89538b5"></a>
std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#adc70aa4f962abd267e2d4f98f89538b5">write</a> (std::ostream &os) const </td></tr>
<tr class="memdesc:adc70aa4f962abd267e2d4f98f89538b5"><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#aa225826fb028de2941da4230b51dfb95" title="Output operator for Key types. ">operator<<(std::ostream &os, const Key &key)</a>. <br /></td></tr>
<tr class="separator:adc70aa4f962abd267e2d4f98f89538b5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
<tr class="memitem:a25d4c3b768148728e8b03fa47d4206cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25d4c3b768148728e8b03fa47d4206cc"></a>
<a class="el" href="classExiv2_1_1Key.html">Key</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1Key.html#a25d4c3b768148728e8b03fa47d4206cc">operator=</a> (const <a class="el" href="classExiv2_1_1Key.html">Key</a> &rhs)</td></tr>
<tr class="memdesc:a25d4c3b768148728e8b03fa47d4206cc"><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>
<tr class="separator:a25d4c3b768148728e8b03fa47d4206cc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract base class defining the Key of a metadatum. Keys are used to identify and group metadata. </p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="metadatum_8hpp.html">metadatum.hpp</a></li>
<li>metadatum.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 4 2016 17:51:50 for Exiv2 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
12cd2b60e7ffa1b93f26cacdd7197eb9
>
files
>
696
