~ubuntu-branches/ubuntu/precise/exiv2/precise

« back to all changes in this revision

Viewing changes to doc/html/classExiv2_1_1IptcKey.html

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Mercatante
  • Date: 2006-12-07 18:40:10 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20061207184010-0ouu8v0dr8nznob9
Tags: 0.12-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
6
</head><body>
7
 
<!-- Generated by Doxygen 1.4.6 -->
 
7
<!-- Generated by Doxygen 1.5.1 -->
8
8
<div class="tabs">
9
9
  <ul>
10
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12
12
    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
13
13
    <li><a href="files.html"><span>Files</span></a></li>
14
14
    <li><a href="examples.html"><span>Examples</span></a></li>
 
15
    <li>
 
16
      <form action="search.php" method="get">
 
17
        <table cellspacing="0" cellpadding="0" border="0">
 
18
          <tr>
 
19
            <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
 
20
            <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
 
21
          </tr>
 
22
        </table>
 
23
      </form>
 
24
    </li>
15
25
  </ul></div>
16
26
<div class="tabs">
17
27
  <ul>
22
32
  </ul></div>
23
33
<div class="nav">
24
34
<a class="el" href="namespaceExiv2.html">Exiv2</a>::<a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a></div>
25
 
<h1>Exiv2::IptcKey Class Reference</h1><!-- doxytag: class="Exiv2::IptcKey" --><!-- doxytag: inherits="Exiv2::Key" -->Concrete keys for Iptc metadata.  
 
35
<h1>Exiv2::IptcKey Class Reference</h1><!-- doxytag: class="Exiv2::IptcKey" --><!-- doxytag: inherits="Exiv2::Key" -->Concrete keys for IPTC metadata.  
26
36
<a href="#_details">More...</a>
27
37
<p>
28
38
<code>#include &lt;datasets.hpp&gt;</code>
29
39
<p>
30
40
Inheritance diagram for Exiv2::IptcKey:<p><center><img src="classExiv2_1_1IptcKey__inherit__graph.png" border="0" usemap="#Exiv2_1_1IptcKey__inherit__map" alt="Inheritance graph"></center>
31
41
<map name="Exiv2_1_1IptcKey__inherit__map">
32
 
<area href="classExiv2_1_1Key.html" shape="rect" coords="16,7,101,31" alt="">
 
42
<area href="classExiv2_1_1Key.html" shape="rect" coords="17,7,111,31" alt="">
33
43
</map>
34
44
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Exiv2::IptcKey:<p><center><img src="classExiv2_1_1IptcKey__coll__graph.png" border="0" usemap="#Exiv2_1_1IptcKey__coll__map" alt="Collaboration graph"></center>
35
45
<map name="Exiv2_1_1IptcKey__coll__map">
36
 
<area href="classExiv2_1_1Key.html" shape="rect" coords="5,175,91,199" alt="">
 
46
<area href="classExiv2_1_1Key.html" shape="rect" coords="6,175,99,199" alt="">
37
47
</map>
38
48
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classExiv2_1_1IptcKey-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
39
49
<tr><td></td></tr>
43
53
 
44
54
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for an IptcKey auto pointer. <br></td></tr>
45
55
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
46
 
<tr><td colspan="2"><div class="groupHeader">Creators</div></td></tr>
47
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#988e8e6f9ce6686fd15cd1cc2e1156e5">IptcKey</a> (const std::string &amp;key)</td></tr>
48
 
 
49
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor to create an Iptc key from a key string.  <a href="#988e8e6f9ce6686fd15cd1cc2e1156e5"></a><br></td></tr>
50
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#97fe8f71498b1e412894ed2475657101">IptcKey</a> (uint16_t tag, uint16_t record)</td></tr>
51
 
 
52
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor to create an Iptc key from dataset and record ids.  <a href="#97fe8f71498b1e412894ed2475657101"></a><br></td></tr>
53
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ea7dcce2b8a20888e3dfa518d79f1b14"></a><!-- doxytag: member="Exiv2::IptcKey::IptcKey" ref="ea7dcce2b8a20888e3dfa518d79f1b14" args="(const IptcKey &amp;rhs)" -->
54
 
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#ea7dcce2b8a20888e3dfa518d79f1b14">IptcKey</a> (const <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> &amp;rhs)</td></tr>
55
 
 
56
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br></td></tr>
57
56
<tr><td colspan="2"><div class="groupHeader">Manipulators</div></td></tr>
58
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5fa127b91597f4ac6b5ccd74315a98c4"></a><!-- doxytag: member="Exiv2::IptcKey::operator=" ref="5fa127b91597f4ac6b5ccd74315a98c4" args="(const IptcKey &amp;rhs)" -->
59
 
<a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#5fa127b91597f4ac6b5ccd74315a98c4">operator=</a> (const <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> &amp;rhs)</td></tr>
 
57
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ee6c74469ab915b2265f57ffa84a20b"></a><!-- doxytag: member="Exiv2::IptcKey::operator=" ref="9ee6c74469ab915b2265f57ffa84a20b" args="(const IptcKey &amp;rhs)" -->
 
58
<a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#9ee6c74469ab915b2265f57ffa84a20b">operator=</a> (const <a class="el" href="classExiv2_1_1IptcKey.html">IptcKey</a> &amp;rhs)</td></tr>
60
59
 
61
60
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator. <br></td></tr>
62
61
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
63
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0261b60a9495c476ecf64f89784e5a39"></a><!-- doxytag: member="Exiv2::IptcKey::key" ref="0261b60a9495c476ecf64f89784e5a39" args="() const " -->
64
 
virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#0261b60a9495c476ecf64f89784e5a39">key</a> () const </td></tr>
 
62
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6942373602af2a7b98fe184709534b3"></a><!-- doxytag: member="Exiv2::IptcKey::key" ref="a6942373602af2a7b98fe184709534b3" args="() const" -->
 
63
virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#a6942373602af2a7b98fe184709534b3">key</a> () const</td></tr>
65
64
 
66
65
<tr><td class="mdescLeft">&nbsp;</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">ExifData</a> may contain multiple metadata with the same key. <br></td></tr>
67
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1b82a74ea2b761ff354f2184d2aefb7"></a><!-- doxytag: member="Exiv2::IptcKey::familyName" ref="c1b82a74ea2b761ff354f2184d2aefb7" args="() const " -->
68
 
virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#c1b82a74ea2b761ff354f2184d2aefb7">familyName</a> () const </td></tr>
 
66
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="17fed4794480d43c262ddb3adc929c06"></a><!-- doxytag: member="Exiv2::IptcKey::familyName" ref="17fed4794480d43c262ddb3adc929c06" args="() const" -->
 
67
virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#17fed4794480d43c262ddb3adc929c06">familyName</a> () const</td></tr>
69
68
 
70
69
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return an identifier for the type of metadata (the first part of the key). <br></td></tr>
71
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="597d7afea6d79f0eb3a7ce7ed2d012d7"></a><!-- doxytag: member="Exiv2::IptcKey::groupName" ref="597d7afea6d79f0eb3a7ce7ed2d012d7" args="() const " -->
72
 
virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#597d7afea6d79f0eb3a7ce7ed2d012d7">groupName</a> () const </td></tr>
 
70
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1ab2c4120d2cdb30afcc6e61acc49028"></a><!-- doxytag: member="Exiv2::IptcKey::groupName" ref="1ab2c4120d2cdb30afcc6e61acc49028" args="() const" -->
 
71
virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#1ab2c4120d2cdb30afcc6e61acc49028">groupName</a> () const</td></tr>
73
72
 
74
 
<tr><td class="mdescLeft">&nbsp;</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>
75
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4811193d88b4dc1e24333905e21ab04"></a><!-- doxytag: member="Exiv2::IptcKey::tagName" ref="d4811193d88b4dc1e24333905e21ab04" args="() const " -->
76
 
virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#d4811193d88b4dc1e24333905e21ab04">tagName</a> () const </td></tr>
 
73
<tr><td class="mdescLeft">&nbsp;</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>
 
74
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd1494fb5aabd2f40ccb8d71c3532727"></a><!-- doxytag: member="Exiv2::IptcKey::tagName" ref="cd1494fb5aabd2f40ccb8d71c3532727" args="() const" -->
 
75
virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#cd1494fb5aabd2f40ccb8d71c3532727">tagName</a> () const</td></tr>
77
76
 
78
77
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the name of the tag (which is also the third part of the key). <br></td></tr>
79
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9865753e8cf245b894351cc5eb0be24"></a><!-- doxytag: member="Exiv2::IptcKey::tagLabel" ref="c9865753e8cf245b894351cc5eb0be24" args="() const " -->
80
 
virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#c9865753e8cf245b894351cc5eb0be24">tagLabel</a> () const </td></tr>
 
78
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52001df5abfd5c4d4354af42ee3486a3"></a><!-- doxytag: member="Exiv2::IptcKey::tagLabel" ref="52001df5abfd5c4d4354af42ee3486a3" args="() const" -->
 
79
virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#52001df5abfd5c4d4354af42ee3486a3">tagLabel</a> () const</td></tr>
81
80
 
82
81
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a label for the tag. <br></td></tr>
83
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="342f2588ae6d02e4bf827be11db9f56b"></a><!-- doxytag: member="Exiv2::IptcKey::tag" ref="342f2588ae6d02e4bf827be11db9f56b" args="() const " -->
84
 
virtual uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#342f2588ae6d02e4bf827be11db9f56b">tag</a> () const </td></tr>
 
82
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e04b1f7ef5f081f632807de85ac61221"></a><!-- doxytag: member="Exiv2::IptcKey::tag" ref="e04b1f7ef5f081f632807de85ac61221" args="() const" -->
 
83
virtual uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#e04b1f7ef5f081f632807de85ac61221">tag</a> () const</td></tr>
85
84
 
86
85
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the tag number. <br></td></tr>
87
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f16a553a530c848e284a59e69308bcc6"></a><!-- doxytag: member="Exiv2::IptcKey::clone" ref="f16a553a530c848e284a59e69308bcc6" args="() const " -->
88
 
<a class="el" href="classExiv2_1_1IptcKey.html#66ec551c992d622b05ce5831c5a17adc">AutoPtr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#f16a553a530c848e284a59e69308bcc6">clone</a> () const </td></tr>
 
86
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5bc2be1e67c0be6fdf0f02097c88f629"></a><!-- doxytag: member="Exiv2::IptcKey::clone" ref="5bc2be1e67c0be6fdf0f02097c88f629" args="() const" -->
 
87
<a class="el" href="classExiv2_1_1IptcKey.html#66ec551c992d622b05ce5831c5a17adc">AutoPtr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#5bc2be1e67c0be6fdf0f02097c88f629">clone</a> () const</td></tr>
89
88
 
90
89
<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>
91
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10c0f0c028a88cde3d38449f0c512f8f"></a><!-- doxytag: member="Exiv2::IptcKey::recordName" ref="10c0f0c028a88cde3d38449f0c512f8f" args="() const " -->
92
 
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#10c0f0c028a88cde3d38449f0c512f8f">recordName</a> () const </td></tr>
 
90
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0d8dd2d874bde8d562ee3d87f047cc8c"></a><!-- doxytag: member="Exiv2::IptcKey::recordName" ref="0d8dd2d874bde8d562ee3d87f047cc8c" args="() const" -->
 
91
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#0d8dd2d874bde8d562ee3d87f047cc8c">recordName</a> () const</td></tr>
93
92
 
94
93
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the name of the record. <br></td></tr>
95
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9aa405be7c02ac674eabc0ed6ae2dde7"></a><!-- doxytag: member="Exiv2::IptcKey::record" ref="9aa405be7c02ac674eabc0ed6ae2dde7" args="() const " -->
96
 
uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#9aa405be7c02ac674eabc0ed6ae2dde7">record</a> () const </td></tr>
 
94
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5540d1d2008013b0b3339863719582e6"></a><!-- doxytag: member="Exiv2::IptcKey::record" ref="5540d1d2008013b0b3339863719582e6" args="() const" -->
 
95
uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExiv2_1_1IptcKey.html#5540d1d2008013b0b3339863719582e6">record</a> () const</td></tr>
97
96
 
98
97
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the record id. <br></td></tr>
99
98
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
107
106
<tr><td class="mdescLeft">&nbsp;</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><a class="el" href="classExiv2_1_1Error.html">Error</a></em>.  <a href="#90c5328803dc9aaf89cc91ff6f0fc92c"></a><br></td></tr>
108
107
</table>
109
108
<hr><a name="_details"></a><h2>Detailed Description</h2>
110
 
Concrete keys for Iptc metadata. 
 
109
Concrete keys for IPTC metadata. 
111
110
<p>
112
111
<hr><h2>Constructor &amp; Destructor Documentation</h2>
113
 
<a class="anchor" name="988e8e6f9ce6686fd15cd1cc2e1156e5"></a><!-- doxytag: member="Exiv2::IptcKey::IptcKey" ref="988e8e6f9ce6686fd15cd1cc2e1156e5" args="(const std::string &amp;key)" --><p>
114
 
<table class="mdTable" cellpadding="2" cellspacing="0">
115
 
  <tr>
116
 
    <td class="mdRow">
117
 
      <table cellpadding="0" cellspacing="0" border="0">
118
 
        <tr>
119
 
          <td class="md" nowrap valign="top">Exiv2::IptcKey::IptcKey           </td>
120
 
          <td class="md" valign="top">(&nbsp;</td>
121
 
          <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
122
 
          <td class="mdname1" valign="top" nowrap> <em>key</em>          </td>
123
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
124
 
          <td class="md" nowrap><code> [explicit]</code></td>
125
 
        </tr>
126
 
      </table>
127
 
    </td>
128
 
  </tr>
129
 
</table>
130
 
<table cellspacing="5" cellpadding="0" border="0">
131
 
  <tr>
132
 
    <td>
133
 
      &nbsp;
134
 
    </td>
135
 
    <td>
136
 
 
137
 
<p>
138
 
Constructor to create an Iptc key from a key string. 
139
 
<p>
140
 
<dl compact><dt><b>Parameters:</b></dt><dd>
141
 
  <table border="0" cellspacing="2" cellpadding="0">
142
 
    <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>The key string. </td></tr>
143
 
  </table>
144
 
</dl>
145
 
<dl compact><dt><b>Exceptions:</b></dt><dd>
146
 
  <table border="0" cellspacing="2" cellpadding="0">
147
 
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html">Error</a></em>&nbsp;</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>
148
 
  </table>
149
 
</dl>
150
 
    </td>
151
 
  </tr>
152
 
</table>
153
 
<a class="anchor" name="97fe8f71498b1e412894ed2475657101"></a><!-- doxytag: member="Exiv2::IptcKey::IptcKey" ref="97fe8f71498b1e412894ed2475657101" args="(uint16_t tag, uint16_t record)" --><p>
154
 
<table class="mdTable" cellpadding="2" cellspacing="0">
155
 
  <tr>
156
 
    <td class="mdRow">
157
 
      <table cellpadding="0" cellspacing="0" border="0">
158
 
        <tr>
159
 
          <td class="md" nowrap valign="top">Exiv2::IptcKey::IptcKey           </td>
160
 
          <td class="md" valign="top">(&nbsp;</td>
161
 
          <td class="md" nowrap valign="top">uint16_t&nbsp;</td>
162
 
          <td class="mdname" nowrap> <em>tag</em>, </td>
163
 
        </tr>
164
 
        <tr>
165
 
          <td class="md" nowrap align="right"></td>
166
 
          <td class="md"></td>
167
 
          <td class="md" nowrap>uint16_t&nbsp;</td>
168
 
          <td class="mdname" nowrap> <em>record</em></td>
169
 
        </tr>
170
 
        <tr>
171
 
          <td class="md"></td>
172
 
          <td class="md">)&nbsp;</td>
173
 
          <td class="md" colspan="2"></td>
174
 
        </tr>
175
 
      </table>
176
 
    </td>
177
 
  </tr>
178
 
</table>
179
 
<table cellspacing="5" cellpadding="0" border="0">
180
 
  <tr>
181
 
    <td>
182
 
      &nbsp;
183
 
    </td>
184
 
    <td>
185
 
 
186
 
<p>
187
 
Constructor to create an Iptc key from dataset and record ids. 
188
 
<p>
189
 
<dl compact><dt><b>Parameters:</b></dt><dd>
190
 
  <table border="0" cellspacing="2" cellpadding="0">
191
 
    <tr><td valign="top"></td><td valign="top"><em>tag</em>&nbsp;</td><td>Dataset id </td></tr>
192
 
    <tr><td valign="top"></td><td valign="top"><em>record</em>&nbsp;</td><td>Record id </td></tr>
193
 
  </table>
194
 
</dl>
195
 
    </td>
196
 
  </tr>
197
 
</table>
 
112
<a class="anchor" name="988e8e6f9ce6686fd15cd1cc2e1156e5"></a><!-- doxytag: member="Exiv2::IptcKey::IptcKey" ref="988e8e6f9ce6686fd15cd1cc2e1156e5" args="(const std::string &amp;key)" -->
 
113
<div class="memitem">
 
114
<div class="memproto">
 
115
      <table class="memname">
 
116
        <tr>
 
117
          <td class="memname">Exiv2::IptcKey::IptcKey           </td>
 
118
          <td>(</td>
 
119
          <td class="paramtype">const std::string &amp;&nbsp;</td>
 
120
          <td class="paramname"> <em>key</em>          </td>
 
121
          <td>&nbsp;)&nbsp;</td>
 
122
          <td width="100%"><code> [explicit]</code></td>
 
123
        </tr>
 
124
      </table>
 
125
</div>
 
126
<div class="memdoc">
 
127
 
 
128
<p>
 
129
Constructor to create an IPTC key from a key string. 
 
130
<p>
 
131
<dl compact><dt><b>Parameters:</b></dt><dd>
 
132
  <table border="0" cellspacing="2" cellpadding="0">
 
133
    <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>The key string. </td></tr>
 
134
  </table>
 
135
</dl>
 
136
<dl compact><dt><b>Exceptions:</b></dt><dd>
 
137
  <table border="0" cellspacing="2" cellpadding="0">
 
138
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html">Error</a></em>&nbsp;</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>
 
139
  </table>
 
140
</dl>
 
141
 
 
142
</div>
 
143
</div><p>
 
144
<a class="anchor" name="97fe8f71498b1e412894ed2475657101"></a><!-- doxytag: member="Exiv2::IptcKey::IptcKey" ref="97fe8f71498b1e412894ed2475657101" args="(uint16_t tag, uint16_t record)" -->
 
145
<div class="memitem">
 
146
<div class="memproto">
 
147
      <table class="memname">
 
148
        <tr>
 
149
          <td class="memname">Exiv2::IptcKey::IptcKey           </td>
 
150
          <td>(</td>
 
151
          <td class="paramtype">uint16_t&nbsp;</td>
 
152
          <td class="paramname"> <em>tag</em>, </td>
 
153
        </tr>
 
154
        <tr>
 
155
          <td class="paramkey"></td>
 
156
          <td></td>
 
157
          <td class="paramtype">uint16_t&nbsp;</td>
 
158
          <td class="paramname"> <em>record</em></td><td>&nbsp;</td>
 
159
        </tr>
 
160
        <tr>
 
161
          <td></td>
 
162
          <td>)</td>
 
163
          <td></td><td></td><td width="100%"></td>
 
164
        </tr>
 
165
      </table>
 
166
</div>
 
167
<div class="memdoc">
 
168
 
 
169
<p>
 
170
Constructor to create an IPTC key from dataset and record ids. 
 
171
<p>
 
172
<dl compact><dt><b>Parameters:</b></dt><dd>
 
173
  <table border="0" cellspacing="2" cellpadding="0">
 
174
    <tr><td valign="top"></td><td valign="top"><em>tag</em>&nbsp;</td><td>Dataset id </td></tr>
 
175
    <tr><td valign="top"></td><td valign="top"><em>record</em>&nbsp;</td><td>Record id </td></tr>
 
176
  </table>
 
177
</dl>
 
178
 
 
179
</div>
 
180
</div><p>
 
181
<a class="anchor" name="988e8e6f9ce6686fd15cd1cc2e1156e5"></a><!-- doxytag: member="Exiv2::IptcKey::IptcKey" ref="988e8e6f9ce6686fd15cd1cc2e1156e5" args="(const std::string &amp;key)" -->
 
182
<div class="memitem">
 
183
<div class="memproto">
 
184
      <table class="memname">
 
185
        <tr>
 
186
          <td class="memname">Exiv2::IptcKey::IptcKey           </td>
 
187
          <td>(</td>
 
188
          <td class="paramtype">const std::string &amp;&nbsp;</td>
 
189
          <td class="paramname"> <em>key</em>          </td>
 
190
          <td>&nbsp;)&nbsp;</td>
 
191
          <td width="100%"><code> [explicit]</code></td>
 
192
        </tr>
 
193
      </table>
 
194
</div>
 
195
<div class="memdoc">
 
196
 
 
197
<p>
 
198
Constructor to create an IPTC key from a key string. 
 
199
<p>
 
200
<dl compact><dt><b>Parameters:</b></dt><dd>
 
201
  <table border="0" cellspacing="2" cellpadding="0">
 
202
    <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>The key string. </td></tr>
 
203
  </table>
 
204
</dl>
 
205
<dl compact><dt><b>Exceptions:</b></dt><dd>
 
206
  <table border="0" cellspacing="2" cellpadding="0">
 
207
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html">Error</a></em>&nbsp;</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>
 
208
  </table>
 
209
</dl>
 
210
 
 
211
</div>
 
212
</div><p>
 
213
<a class="anchor" name="97fe8f71498b1e412894ed2475657101"></a><!-- doxytag: member="Exiv2::IptcKey::IptcKey" ref="97fe8f71498b1e412894ed2475657101" args="(uint16_t tag, uint16_t record)" -->
 
214
<div class="memitem">
 
215
<div class="memproto">
 
216
      <table class="memname">
 
217
        <tr>
 
218
          <td class="memname">Exiv2::IptcKey::IptcKey           </td>
 
219
          <td>(</td>
 
220
          <td class="paramtype">uint16_t&nbsp;</td>
 
221
          <td class="paramname"> <em>tag</em>, </td>
 
222
        </tr>
 
223
        <tr>
 
224
          <td class="paramkey"></td>
 
225
          <td></td>
 
226
          <td class="paramtype">uint16_t&nbsp;</td>
 
227
          <td class="paramname"> <em>record</em></td><td>&nbsp;</td>
 
228
        </tr>
 
229
        <tr>
 
230
          <td></td>
 
231
          <td>)</td>
 
232
          <td></td><td></td><td width="100%"></td>
 
233
        </tr>
 
234
      </table>
 
235
</div>
 
236
<div class="memdoc">
 
237
 
 
238
<p>
 
239
Constructor to create an IPTC key from dataset and record ids. 
 
240
<p>
 
241
<dl compact><dt><b>Parameters:</b></dt><dd>
 
242
  <table border="0" cellspacing="2" cellpadding="0">
 
243
    <tr><td valign="top"></td><td valign="top"><em>tag</em>&nbsp;</td><td>Dataset id </td></tr>
 
244
    <tr><td valign="top"></td><td valign="top"><em>record</em>&nbsp;</td><td>Record id </td></tr>
 
245
  </table>
 
246
</dl>
 
247
 
 
248
</div>
 
249
</div><p>
198
250
<hr><h2>Member Function Documentation</h2>
199
 
<a class="anchor" name="90c5328803dc9aaf89cc91ff6f0fc92c"></a><!-- doxytag: member="Exiv2::IptcKey::decomposeKey" ref="90c5328803dc9aaf89cc91ff6f0fc92c" args="()" --><p>
200
 
<table class="mdTable" cellpadding="2" cellspacing="0">
201
 
  <tr>
202
 
    <td class="mdRow">
203
 
      <table cellpadding="0" cellspacing="0" border="0">
 
251
<a class="anchor" name="90c5328803dc9aaf89cc91ff6f0fc92c"></a><!-- doxytag: member="Exiv2::IptcKey::decomposeKey" ref="90c5328803dc9aaf89cc91ff6f0fc92c" args="()" -->
 
252
<div class="memitem">
 
253
<div class="memproto">
 
254
      <table class="memname">
204
255
        <tr>
205
 
          <td class="md" nowrap valign="top">void Exiv2::IptcKey::decomposeKey           </td>
206
 
          <td class="md" valign="top">(&nbsp;</td>
207
 
          <td class="mdname1" valign="top" nowrap>          </td>
208
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
209
 
          <td class="md" nowrap><code> [protected]</code></td>
 
256
          <td class="memname">void Exiv2::IptcKey::decomposeKey           </td>
 
257
          <td>(</td>
 
258
          <td class="paramname">          </td>
 
259
          <td>&nbsp;)&nbsp;</td>
 
260
          <td width="100%"><code> [protected]</code></td>
210
261
        </tr>
211
262
      </table>
212
 
    </td>
213
 
  </tr>
214
 
</table>
215
 
<table cellspacing="5" cellpadding="0" border="0">
216
 
  <tr>
217
 
    <td>
218
 
      &nbsp;
219
 
    </td>
220
 
    <td>
 
263
</div>
 
264
<div class="memdoc">
221
265
 
222
266
<p>
223
267
Parse and convert the key string into dataset and record id. Updates data members if the string can be decomposed, or throws <em><a class="el" href="classExiv2_1_1Error.html">Error</a></em>. 
227
271
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classExiv2_1_1Error.html">Error</a></em>&nbsp;</td><td>if the key cannot be decomposed. </td></tr>
228
272
  </table>
229
273
</dl>
230
 
    </td>
231
 
  </tr>
232
 
</table>
233
 
<hr>The documentation for this class was generated from the following files:<ul>
234
 
<li><a class="el" href="datasets_8hpp.html">datasets.hpp</a><li>datasets.cpp</ul>
235
 
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:54:53 2006 for Exiv2 by&nbsp;
 
274
 
 
275
</div>
 
276
</div><p>
 
277
<hr>The documentation for this class was generated from the following file:<ul>
 
278
<li><a class="el" href="datasets_8hpp.html">datasets.hpp</a></ul>
 
279
<hr size="1"><address style="align: right;"><small>Generated on Mon Nov 27 20:16:26 2006 for Exiv2 by&nbsp;
236
280
<a href="http://www.doxygen.org/index.html">
237
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
 
281
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
238
282
</body>
239
283
</html>