<!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::IptcKey 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_1IptcKey.html">IptcKey</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="classExiv2_1_1IptcKey-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Exiv2::IptcKey Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Concrete keys for IPTC metadata.
<a href="classExiv2_1_1IptcKey.html#details">More...</a></p>
<p><code>#include <datasets.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::IptcKey:</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_1IptcKey__inherit__graph.png" border="0" usemap="#Exiv2_1_1IptcKey_inherit__map" alt="Inheritance graph"/></div>
<map name="Exiv2_1_1IptcKey_inherit__map" id="Exiv2_1_1IptcKey_inherit__map">
<area shape="rect" id="node2" href="classExiv2_1_1Key.html" title="Abstract base class defining the Key of a metadatum. Keys are used to identify and group metadata..." alt="" coords="25,5,148,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for Exiv2::IptcKey:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classExiv2_1_1IptcKey__coll__graph.png" border="0" usemap="#Exiv2_1_1IptcKey_coll__map" alt="Collaboration graph"/></div>
<map name="Exiv2_1_1IptcKey_coll__map" id="Exiv2_1_1IptcKey_coll__map">
<area shape="rect" id="node2" href="classExiv2_1_1Key.html" title="Abstract base class defining the Key of a metadatum. Keys are used to identify and group metadata..." alt="" coords="25,5,148,32"/></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:a66ec551c992d622b05ce5831c5a17adc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66ec551c992d622b05ce5831c5a17adc"></a>
typedef std::auto_ptr< <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a66ec551c992d622b05ce5831c5a17adc">AutoPtr</a></td></tr>
<tr class="memdesc:a66ec551c992d622b05ce5831c5a17adc"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for an IptcKey auto pointer. <br /></td></tr>
<tr class="separator:a66ec551c992d622b05ce5831c5a17adc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_types_classExiv2_1_1Key"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classExiv2_1_1Key')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classExiv2_1_1Key.html">Exiv2::Key</a></td></tr>
<tr class="memitem:a9bf9953294ceb8d272908a0680aeade8 inherit pub_types_classExiv2_1_1Key"><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 inherit pub_types_classExiv2_1_1Key"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut for a Key auto pointer. <br /></td></tr>
<tr class="separator:a9bf9953294ceb8d272908a0680aeade8 inherit pub_types_classExiv2_1_1Key"><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:a988e8e6f9ce6686fd15cd1cc2e1156e5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a988e8e6f9ce6686fd15cd1cc2e1156e5">IptcKey</a> (const std::string &<a class="el" href="classExiv2_1_1IptcKey.html#ad686bbb7f5bc4d6e4d3f4f4002bd5d27">key</a>)</td></tr>
<tr class="memdesc:a988e8e6f9ce6686fd15cd1cc2e1156e5"><td class="mdescLeft"> </td><td class="mdescRight">Constructor to create an IPTC key from a key string. <a href="#a988e8e6f9ce6686fd15cd1cc2e1156e5">More...</a><br /></td></tr>
<tr class="separator:a988e8e6f9ce6686fd15cd1cc2e1156e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97fe8f71498b1e412894ed2475657101"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a97fe8f71498b1e412894ed2475657101">IptcKey</a> (uint16_t <a class="el" href="classExiv2_1_1IptcKey.html#a8750e2ce7d30c6d4d5b99766d08fec39">tag</a>, uint16_t <a class="el" href="classExiv2_1_1IptcKey.html#a9aa405be7c02ac674eabc0ed6ae2dde7">record</a>)</td></tr>
<tr class="memdesc:a97fe8f71498b1e412894ed2475657101"><td class="mdescLeft"> </td><td class="mdescRight">Constructor to create an IPTC key from dataset and record ids. <a href="#a97fe8f71498b1e412894ed2475657101">More...</a><br /></td></tr>
<tr class="separator:a97fe8f71498b1e412894ed2475657101"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea7dcce2b8a20888e3dfa518d79f1b14"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea7dcce2b8a20888e3dfa518d79f1b14"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#aea7dcce2b8a20888e3dfa518d79f1b14">IptcKey</a> (const <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> &rhs)</td></tr>
<tr class="memdesc:aea7dcce2b8a20888e3dfa518d79f1b14"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:aea7dcce2b8a20888e3dfa518d79f1b14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac273dbcd7ff32549b0d1e52c868586f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac273dbcd7ff32549b0d1e52c868586f0"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#ac273dbcd7ff32549b0d1e52c868586f0">~IptcKey</a> ()</td></tr>
<tr class="memdesc:ac273dbcd7ff32549b0d1e52c868586f0"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ac273dbcd7ff32549b0d1e52c868586f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<tr class="memitem:ad686bbb7f5bc4d6e4d3f4f4002bd5d27"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad686bbb7f5bc4d6e4d3f4f4002bd5d27"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#ad686bbb7f5bc4d6e4d3f4f4002bd5d27">key</a> () const </td></tr>
<tr class="memdesc:ad686bbb7f5bc4d6e4d3f4f4002bd5d27"><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:ad686bbb7f5bc4d6e4d3f4f4002bd5d27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03fe9cd33e8c0f56dc33ef8962be97dd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03fe9cd33e8c0f56dc33ef8962be97dd"></a>
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a03fe9cd33e8c0f56dc33ef8962be97dd">familyName</a> () const </td></tr>
<tr class="memdesc:a03fe9cd33e8c0f56dc33ef8962be97dd"><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:a03fe9cd33e8c0f56dc33ef8962be97dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ef503c67b2f7239b0e68a322eb8cf55"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ef503c67b2f7239b0e68a322eb8cf55"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a9ef503c67b2f7239b0e68a322eb8cf55">groupName</a> () const </td></tr>
<tr class="memdesc:a9ef503c67b2f7239b0e68a322eb8cf55"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the group (the second part of the key). For IPTC keys, the group name is the record name. <br /></td></tr>
<tr class="separator:a9ef503c67b2f7239b0e68a322eb8cf55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a581c712f48d62199e33831337290f0ea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a581c712f48d62199e33831337290f0ea"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a581c712f48d62199e33831337290f0ea">tagName</a> () const </td></tr>
<tr class="memdesc:a581c712f48d62199e33831337290f0ea"><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:a581c712f48d62199e33831337290f0ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2d8575942460cb27bf7fbfc8d30830a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2d8575942460cb27bf7fbfc8d30830a"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#ad2d8575942460cb27bf7fbfc8d30830a">tagLabel</a> () const </td></tr>
<tr class="memdesc:ad2d8575942460cb27bf7fbfc8d30830a"><td class="mdescLeft"> </td><td class="mdescRight">Return a label for the tag. <br /></td></tr>
<tr class="separator:ad2d8575942460cb27bf7fbfc8d30830a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8750e2ce7d30c6d4d5b99766d08fec39"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8750e2ce7d30c6d4d5b99766d08fec39"></a>
virtual uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a8750e2ce7d30c6d4d5b99766d08fec39">tag</a> () const </td></tr>
<tr class="memdesc:a8750e2ce7d30c6d4d5b99766d08fec39"><td class="mdescLeft"> </td><td class="mdescRight">Return the tag number. <br /></td></tr>
<tr class="separator:a8750e2ce7d30c6d4d5b99766d08fec39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af16a553a530c848e284a59e69308bcc6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af16a553a530c848e284a59e69308bcc6"></a>
<a class="el" href="classExiv2_1_1IptcKey.html#a66ec551c992d622b05ce5831c5a17adc">AutoPtr</a> </td><td class="memItemRight" valign="bottom"><b>clone</b> () const </td></tr>
<tr class="separator:af16a553a530c848e284a59e69308bcc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10c0f0c028a88cde3d38449f0c512f8f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10c0f0c028a88cde3d38449f0c512f8f"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a10c0f0c028a88cde3d38449f0c512f8f">recordName</a> () const </td></tr>
<tr class="memdesc:a10c0f0c028a88cde3d38449f0c512f8f"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the record. <br /></td></tr>
<tr class="separator:a10c0f0c028a88cde3d38449f0c512f8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9aa405be7c02ac674eabc0ed6ae2dde7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9aa405be7c02ac674eabc0ed6ae2dde7"></a>
uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a9aa405be7c02ac674eabc0ed6ae2dde7">record</a> () const </td></tr>
<tr class="memdesc:a9aa405be7c02ac674eabc0ed6ae2dde7"><td class="mdescLeft"> </td><td class="mdescRight">Return the record id. <br /></td></tr>
<tr class="separator:a9aa405be7c02ac674eabc0ed6ae2dde7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classExiv2_1_1Key"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classExiv2_1_1Key')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classExiv2_1_1Key.html">Exiv2::Key</a></td></tr>
<tr class="memitem:a574f73b95eb37cfa7ad509b0b1c26b61 inherit pub_methods_classExiv2_1_1Key"><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 inherit pub_methods_classExiv2_1_1Key"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a574f73b95eb37cfa7ad509b0b1c26b61 inherit pub_methods_classExiv2_1_1Key"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f7e6d66e806bb9e80f35ca77d12062c inherit pub_methods_classExiv2_1_1Key"><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 inherit pub_methods_classExiv2_1_1Key"><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 inherit pub_methods_classExiv2_1_1Key"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc70aa4f962abd267e2d4f98f89538b5 inherit pub_methods_classExiv2_1_1Key"><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 inherit pub_methods_classExiv2_1_1Key"><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 inherit pub_methods_classExiv2_1_1Key"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Manipulators</h2></td></tr>
<tr class="memitem:a5fa127b91597f4ac6b5ccd74315a98c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5fa127b91597f4ac6b5ccd74315a98c4"></a>
<a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a5fa127b91597f4ac6b5ccd74315a98c4">operator=</a> (const <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> &rhs)</td></tr>
<tr class="memdesc:a5fa127b91597f4ac6b5ccd74315a98c4"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br /></td></tr>
<tr class="separator:a5fa127b91597f4ac6b5ccd74315a98c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af90cd2fd735f773145046bce37240a05"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af90cd2fd735f773145046bce37240a05"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#af90cd2fd735f773145046bce37240a05">makeKey</a> ()</td></tr>
<tr class="memdesc:af90cd2fd735f773145046bce37240a05"><td class="mdescLeft"> </td><td class="mdescRight">Set the key corresponding to the dataset and record id. The key is of the form '<b>Iptc</b>.recordName.dataSetName'. <br /></td></tr>
<tr class="separator:af90cd2fd735f773145046bce37240a05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90c5328803dc9aaf89cc91ff6f0fc92c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a90c5328803dc9aaf89cc91ff6f0fc92c">decomposeKey</a> ()</td></tr>
<tr class="memdesc:a90c5328803dc9aaf89cc91ff6f0fc92c"><td class="mdescLeft"> </td><td class="mdescRight">Parse and convert the key string into dataset and record id. Updates data members if the string can be decomposed, or throws <em>Error</em>. <a href="#a90c5328803dc9aaf89cc91ff6f0fc92c">More...</a><br /></td></tr>
<tr class="separator:a90c5328803dc9aaf89cc91ff6f0fc92c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classExiv2_1_1Key"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classExiv2_1_1Key')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classExiv2_1_1Key.html">Exiv2::Key</a></td></tr>
<tr class="memitem:a25d4c3b768148728e8b03fa47d4206cc inherit pro_methods_classExiv2_1_1Key"><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 inherit pro_methods_classExiv2_1_1Key"><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 inherit pro_methods_classExiv2_1_1Key"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Concrete keys for IPTC metadata. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a988e8e6f9ce6686fd15cd1cc2e1156e5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Exiv2::IptcKey::IptcKey </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor to create an IPTC key from a key string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>The key string. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>if the first part of the key is not '<b>Iptc</b>' or the remaining parts of the key cannot be parsed and converted to a record name and a dataset name. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="classExiv2_1_1IptcKey.html#a90c5328803dc9aaf89cc91ff6f0fc92c">decomposeKey()</a>.</p>
</div>
</div>
<a class="anchor" id="a97fe8f71498b1e412894ed2475657101"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Exiv2::IptcKey::IptcKey </td>
<td>(</td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>record</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor to create an IPTC key from dataset and record ids. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tag</td><td>Dataset id </td></tr>
<tr><td class="paramname">record</td><td>Record id </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="classExiv2_1_1IptcKey.html#af90cd2fd735f773145046bce37240a05">makeKey()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a90c5328803dc9aaf89cc91ff6f0fc92c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Exiv2::IptcKey::decomposeKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse and convert the key string into dataset and record id. Updates data members if the string can be decomposed, or throws <em>Error</em>. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">Error</td><td>if the key cannot be decomposed. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="classExiv2_1_1IptcDataSets.html#ae870d879dd1480ea7df3deb00d046b96">Exiv2::IptcDataSets::dataSet()</a>, <a class="el" href="classExiv2_1_1IptcDataSets.html#acf9da9675f32e0aa7ed1ba7477b5fa0f">Exiv2::IptcDataSets::dataSetName()</a>, <a class="el" href="classExiv2_1_1IptcKey.html#a03fe9cd33e8c0f56dc33ef8962be97dd">familyName()</a>, <a class="el" href="classExiv2_1_1IptcDataSets.html#a36ca205824a1b8f8c251e4150de1a9a9">Exiv2::IptcDataSets::recordId()</a>, <a class="el" href="classExiv2_1_1IptcDataSets.html#a3b8106845031d532466282d26f1dd9fb">Exiv2::IptcDataSets::recordName()</a>, <a class="el" href="classExiv2_1_1IptcKey.html#a10c0f0c028a88cde3d38449f0c512f8f">recordName()</a>, and <a class="el" href="namespaceExiv2.html#a5153319711f35fe81cbc13f4b852450ca2d79fb07c9ec891f281968dad43c1e25">Exiv2::string</a>.</p>
<p>Referenced by <a class="el" href="classExiv2_1_1IptcKey.html#a988e8e6f9ce6686fd15cd1cc2e1156e5">IptcKey()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="datasets_8hpp.html">datasets.hpp</a></li>
<li>datasets.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 26 2017 16:50:14 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
>
i586
>
media
>
core-updates
>
by-pkgid
>
8b93c7974abbd359ec3a5ea81eee3220
>
files
>
654
