← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/structExiv2_1_1Photoshop.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:
doc/html/structExiv2_1_1Photoshop.html
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>
30
40
<a href="structExiv2_1_1Photoshop-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
31
41
<tr><td></td></tr>
32
42
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
33
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#cae5ddd34c41bf50fb3aac4275fc219e">locateIrb</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *pPsData, long sizePsData, uint16_t psTag, const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> **record, uint16_t *const sizeHdr, uint16_t *const sizeData)</td></tr>
34
 
 
35
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Locates the data for a Photoshop tag in a Photoshop formated memory buffer. Operates on raw data to simplify reuse.  <a href="#cae5ddd34c41bf50fb3aac4275fc219e"></a><br></td></tr>
36
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10f3117d823b4047d9c83036efc1bf14"></a><!-- doxytag: member="Exiv2::Photoshop::locateIptcIrb" ref="10f3117d823b4047d9c83036efc1bf14" args="(const byte *pPsData, long sizePsData, const byte **record, uint16_t *const sizeHdr, uint16_t *const sizeData)" -->
37
 
static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#10f3117d823b4047d9c83036efc1bf14">locateIptcIrb</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *pPsData, long sizePsData, const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> **record, uint16_t *const sizeHdr, uint16_t *const sizeData)</td></tr>
38
 
 
39
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forwards to <a class="el" href="structExiv2_1_1Photoshop.html#cae5ddd34c41bf50fb3aac4275fc219e">locateIrb()</a> with <em>psTag</em> = <em>iptc_</em>. <br></td></tr>
40
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#21b12dcbcd05f3c32b49c2121b77068e">setIptcIrb</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *pPsData, long sizePsData, const <a class="el" href="classExiv2_1_1IptcData.html">IptcData</a> &amp;iptcData)</td></tr>
41
 
 
42
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the new IPTC IRB, keeps existing IRBs but removes the IPTC block if there is no new IPTC data to write.  <a href="#21b12dcbcd05f3c32b49c2121b77068e"></a><br></td></tr>
 
43
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#e4f7ba385f695ca7f3534ab4643ad5a6">locateIrb</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *pPsData, long sizePsData, uint16_t psTag, const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> **record, uint32_t *const sizeHdr, uint32_t *const sizeData)</td></tr>
 
44
 
 
45
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Locates the data for a Photoshop tag in a Photoshop formated memory buffer. Operates on raw data to simplify reuse.  <a href="#e4f7ba385f695ca7f3534ab4643ad5a6"></a><br></td></tr>
 
46
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63788220e2a8f18ae546cd84fa01908c"></a><!-- doxytag: member="Exiv2::Photoshop::locateIptcIrb" ref="63788220e2a8f18ae546cd84fa01908c" args="(const byte *pPsData, long sizePsData, const byte **record, uint32_t *const sizeHdr, uint32_t *const sizeData)" -->
 
47
static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#63788220e2a8f18ae546cd84fa01908c">locateIptcIrb</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *pPsData, long sizePsData, const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> **record, uint32_t *const sizeHdr, uint32_t *const sizeData)</td></tr>
 
48
 
 
49
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forwards to <a class="el" href="structExiv2_1_1Photoshop.html#e4f7ba385f695ca7f3534ab4643ad5a6">locateIrb()</a> with <em>psTag</em> = <em>iptc_</em>. <br></td></tr>
 
50
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#1e0c68308b334a3adb2db245abe0e187">setIptcIrb</a> (const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *pPsData, long sizePsData, const <a class="el" href="classExiv2_1_1IptcData.html">IptcData</a> &amp;iptcData)</td></tr>
 
51
 
 
52
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the new IPTC IRB, keeps existing IRBs but removes the IPTC block if there is no new IPTC data to write.  <a href="#1e0c68308b334a3adb2db245abe0e187"></a><br></td></tr>
43
53
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
44
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e593bf6546da454526229645e3114cbc"></a><!-- doxytag: member="Exiv2::Photoshop::ps3Id_" ref="e593bf6546da454526229645e3114cbc" args="[]" -->
45
 
static const char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#e593bf6546da454526229645e3114cbc">ps3Id_</a> [] = &quot;Photoshop 3.0\0&quot;</td></tr>
 
54
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7cfeaf38d59872d02be313454a45fcff"></a><!-- doxytag: member="Exiv2::Photoshop::ps3Id_" ref="7cfeaf38d59872d02be313454a45fcff" args="[]" -->
 
55
static const char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#7cfeaf38d59872d02be313454a45fcff">ps3Id_</a> []</td></tr>
46
56
 
47
57
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Photoshop marker <br></td></tr>
48
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78d00352aa18ac7bf6144e830856ea6b"></a><!-- doxytag: member="Exiv2::Photoshop::bimId_" ref="78d00352aa18ac7bf6144e830856ea6b" args="[]" -->
49
 
static const char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#78d00352aa18ac7bf6144e830856ea6b">bimId_</a> [] = &quot;8BIM&quot;</td></tr>
 
58
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26c4018dcd65619cf55408b08a426f07"></a><!-- doxytag: member="Exiv2::Photoshop::bimId_" ref="26c4018dcd65619cf55408b08a426f07" args="[]" -->
 
59
static const char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#26c4018dcd65619cf55408b08a426f07">bimId_</a> []</td></tr>
50
60
 
51
61
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Photoshop marker <br></td></tr>
52
62
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f901d93824440438f7a015cb2738bd5"></a><!-- doxytag: member="Exiv2::Photoshop::iptc_" ref="1f901d93824440438f7a015cb2738bd5" args="" -->
53
 
static const uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#1f901d93824440438f7a015cb2738bd5">iptc_</a> = 0x0404</td></tr>
 
63
static const uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structExiv2_1_1Photoshop.html#1f901d93824440438f7a015cb2738bd5">iptc_</a></td></tr>
54
64
 
55
65
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Photoshop IPTC marker <br></td></tr>
56
66
</table>
58
68
Helper class, has methods to deal with Photoshop "Information Resource Blocks" (IRBs). 
59
69
<p>
60
70
<hr><h2>Member Function Documentation</h2>
61
 
<a class="anchor" name="cae5ddd34c41bf50fb3aac4275fc219e"></a><!-- doxytag: member="Exiv2::Photoshop::locateIrb" ref="cae5ddd34c41bf50fb3aac4275fc219e" args="(const byte *pPsData, long sizePsData, uint16_t psTag, const byte **record, uint16_t *const sizeHdr, uint16_t *const sizeData)" --><p>
62
 
<table class="mdTable" cellpadding="2" cellspacing="0">
63
 
  <tr>
64
 
    <td class="mdRow">
65
 
      <table cellpadding="0" cellspacing="0" border="0">
66
 
        <tr>
67
 
          <td class="md" nowrap valign="top">int Exiv2::Photoshop::locateIrb           </td>
68
 
          <td class="md" valign="top">(&nbsp;</td>
69
 
          <td class="md" nowrap valign="top">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *&nbsp;</td>
70
 
          <td class="mdname" nowrap> <em>pPsData</em>, </td>
71
 
        </tr>
72
 
        <tr>
73
 
          <td class="md" nowrap align="right"></td>
74
 
          <td class="md"></td>
75
 
          <td class="md" nowrap>long&nbsp;</td>
76
 
          <td class="mdname" nowrap> <em>sizePsData</em>, </td>
77
 
        </tr>
78
 
        <tr>
79
 
          <td class="md" nowrap align="right"></td>
80
 
          <td class="md"></td>
81
 
          <td class="md" nowrap>uint16_t&nbsp;</td>
82
 
          <td class="mdname" nowrap> <em>psTag</em>, </td>
83
 
        </tr>
84
 
        <tr>
85
 
          <td class="md" nowrap align="right"></td>
86
 
          <td class="md"></td>
87
 
          <td class="md" nowrap>const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> **&nbsp;</td>
88
 
          <td class="mdname" nowrap> <em>record</em>, </td>
89
 
        </tr>
90
 
        <tr>
91
 
          <td class="md" nowrap align="right"></td>
92
 
          <td class="md"></td>
93
 
          <td class="md" nowrap>uint16_t *const &nbsp;</td>
94
 
          <td class="mdname" nowrap> <em>sizeHdr</em>, </td>
95
 
        </tr>
96
 
        <tr>
97
 
          <td class="md" nowrap align="right"></td>
98
 
          <td class="md"></td>
99
 
          <td class="md" nowrap>uint16_t *const &nbsp;</td>
100
 
          <td class="mdname" nowrap> <em>sizeData</em></td>
101
 
        </tr>
102
 
        <tr>
103
 
          <td class="md"></td>
104
 
          <td class="md">)&nbsp;</td>
105
 
          <td class="md" colspan="2"><code> [static]</code></td>
 
71
<a class="anchor" name="e4f7ba385f695ca7f3534ab4643ad5a6"></a><!-- doxytag: member="Exiv2::Photoshop::locateIrb" ref="e4f7ba385f695ca7f3534ab4643ad5a6" args="(const byte *pPsData, long sizePsData, uint16_t psTag, const byte **record, uint32_t *const sizeHdr, uint32_t *const sizeData)" -->
 
72
<div class="memitem">
 
73
<div class="memproto">
 
74
      <table class="memname">
 
75
        <tr>
 
76
          <td class="memname">static int Exiv2::Photoshop::locateIrb           </td>
 
77
          <td>(</td>
 
78
          <td class="paramtype">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *&nbsp;</td>
 
79
          <td class="paramname"> <em>pPsData</em>, </td>
 
80
        </tr>
 
81
        <tr>
 
82
          <td class="paramkey"></td>
 
83
          <td></td>
 
84
          <td class="paramtype">long&nbsp;</td>
 
85
          <td class="paramname"> <em>sizePsData</em>, </td>
 
86
        </tr>
 
87
        <tr>
 
88
          <td class="paramkey"></td>
 
89
          <td></td>
 
90
          <td class="paramtype">uint16_t&nbsp;</td>
 
91
          <td class="paramname"> <em>psTag</em>, </td>
 
92
        </tr>
 
93
        <tr>
 
94
          <td class="paramkey"></td>
 
95
          <td></td>
 
96
          <td class="paramtype">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> **&nbsp;</td>
 
97
          <td class="paramname"> <em>record</em>, </td>
 
98
        </tr>
 
99
        <tr>
 
100
          <td class="paramkey"></td>
 
101
          <td></td>
 
102
          <td class="paramtype">uint32_t *const&nbsp;</td>
 
103
          <td class="paramname"> <em>sizeHdr</em>, </td>
 
104
        </tr>
 
105
        <tr>
 
106
          <td class="paramkey"></td>
 
107
          <td></td>
 
108
          <td class="paramtype">uint32_t *const&nbsp;</td>
 
109
          <td class="paramname"> <em>sizeData</em></td><td>&nbsp;</td>
 
110
        </tr>
 
111
        <tr>
 
112
          <td></td>
 
113
          <td>)</td>
 
114
          <td></td><td></td><td width="100%"><code> [static]</code></td>
106
115
        </tr>
107
116
      </table>
108
 
    </td>
109
 
  </tr>
110
 
</table>
111
 
<table cellspacing="5" cellpadding="0" border="0">
112
 
  <tr>
113
 
    <td>
114
 
      &nbsp;
115
 
    </td>
116
 
    <td>
 
117
</div>
 
118
<div class="memdoc">
117
119
 
118
120
<p>
119
121
Locates the data for a Photoshop tag in a Photoshop formated memory buffer. Operates on raw data to simplify reuse. 
128
130
    <tr><td valign="top"></td><td valign="top"><em>sizeData</em>&nbsp;</td><td>Output value that is set to the size of the actual data within the data block pointed to by record (may not be null). </td></tr>
129
131
  </table>
130
132
</dl>
131
 
<dl compact><dt><b>Returns:</b></dt><dd>0 if successful;<br>
 
133
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if successful;<br>
132
134
 3 if no data for psTag was found in pPsData;<br>
133
135
 -2 if the pPsData buffer does not contain valid data. </dd></dl>
134
 
    </td>
135
 
  </tr>
136
 
</table>
137
 
<a class="anchor" name="21b12dcbcd05f3c32b49c2121b77068e"></a><!-- doxytag: member="Exiv2::Photoshop::setIptcIrb" ref="21b12dcbcd05f3c32b49c2121b77068e" args="(const byte *pPsData, long sizePsData, const IptcData &amp;iptcData)" --><p>
138
 
<table class="mdTable" cellpadding="2" cellspacing="0">
139
 
  <tr>
140
 
    <td class="mdRow">
141
 
      <table cellpadding="0" cellspacing="0" border="0">
142
 
        <tr>
143
 
          <td class="md" nowrap valign="top"><a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> Exiv2::Photoshop::setIptcIrb           </td>
144
 
          <td class="md" valign="top">(&nbsp;</td>
145
 
          <td class="md" nowrap valign="top">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *&nbsp;</td>
146
 
          <td class="mdname" nowrap> <em>pPsData</em>, </td>
147
 
        </tr>
148
 
        <tr>
149
 
          <td class="md" nowrap align="right"></td>
150
 
          <td class="md"></td>
151
 
          <td class="md" nowrap>long&nbsp;</td>
152
 
          <td class="mdname" nowrap> <em>sizePsData</em>, </td>
153
 
        </tr>
154
 
        <tr>
155
 
          <td class="md" nowrap align="right"></td>
156
 
          <td class="md"></td>
157
 
          <td class="md" nowrap>const <a class="el" href="classExiv2_1_1IptcData.html">IptcData</a> &amp;&nbsp;</td>
158
 
          <td class="mdname" nowrap> <em>iptcData</em></td>
159
 
        </tr>
160
 
        <tr>
161
 
          <td class="md"></td>
162
 
          <td class="md">)&nbsp;</td>
163
 
          <td class="md" colspan="2"><code> [static]</code></td>
 
136
 
 
137
</div>
 
138
</div><p>
 
139
<a class="anchor" name="1e0c68308b334a3adb2db245abe0e187"></a><!-- doxytag: member="Exiv2::Photoshop::setIptcIrb" ref="1e0c68308b334a3adb2db245abe0e187" args="(const byte *pPsData, long sizePsData, const IptcData &amp;iptcData)" -->
 
140
<div class="memitem">
 
141
<div class="memproto">
 
142
      <table class="memname">
 
143
        <tr>
 
144
          <td class="memname">static <a class="el" href="classExiv2_1_1DataBuf.html">DataBuf</a> Exiv2::Photoshop::setIptcIrb           </td>
 
145
          <td>(</td>
 
146
          <td class="paramtype">const <a class="el" href="namespaceExiv2.html#16f60a5bd4207fe155f6cf93a15efa72">byte</a> *&nbsp;</td>
 
147
          <td class="paramname"> <em>pPsData</em>, </td>
 
148
        </tr>
 
149
        <tr>
 
150
          <td class="paramkey"></td>
 
151
          <td></td>
 
152
          <td class="paramtype">long&nbsp;</td>
 
153
          <td class="paramname"> <em>sizePsData</em>, </td>
 
154
        </tr>
 
155
        <tr>
 
156
          <td class="paramkey"></td>
 
157
          <td></td>
 
158
          <td class="paramtype">const <a class="el" href="classExiv2_1_1IptcData.html">IptcData</a> &amp;&nbsp;</td>
 
159
          <td class="paramname"> <em>iptcData</em></td><td>&nbsp;</td>
 
160
        </tr>
 
161
        <tr>
 
162
          <td></td>
 
163
          <td>)</td>
 
164
          <td></td><td></td><td width="100%"><code> [static]</code></td>
164
165
        </tr>
165
166
      </table>
166
 
    </td>
167
 
  </tr>
168
 
</table>
169
 
<table cellspacing="5" cellpadding="0" border="0">
170
 
  <tr>
171
 
    <td>
172
 
      &nbsp;
173
 
    </td>
174
 
    <td>
 
167
</div>
 
168
<div class="memdoc">
175
169
 
176
170
<p>
177
171
Set the new IPTC IRB, keeps existing IRBs but removes the IPTC block if there is no new IPTC data to write. 
183
177
    <tr><td valign="top"></td><td valign="top"><em>iptcData</em>&nbsp;</td><td>Iptc data to embed, may be empty </td></tr>
184
178
  </table>
185
179
</dl>
186
 
<dl compact><dt><b>Returns:</b></dt><dd>A data buffer containing the new IRB buffer, may have 0 size </dd></dl>
187
 
    </td>
188
 
  </tr>
189
 
</table>
190
 
<hr>The documentation for this struct was generated from the following files:<ul>
191
 
<li><a class="el" href="jpgimage_8hpp.html">jpgimage.hpp</a><li>jpgimage.cpp</ul>
192
 
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 2 23:55:00 2006 for Exiv2 by&nbsp;
 
180
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A data buffer containing the new IRB buffer, may have 0 size </dd></dl>
 
181
 
 
182
</div>
 
183
</div><p>
 
184
<hr>The documentation for this struct was generated from the following file:<ul>
 
185
<li><a class="el" href="jpgimage_8hpp.html">jpgimage.hpp</a></ul>
 
186
<hr size="1"><address style="align: right;"><small>Generated on Mon Nov 27 20:16:28 2006 for Exiv2 by&nbsp;
193
187
<a href="http://www.doxygen.org/index.html">
194
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
 
188
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
195
189
</body>
196
190
</html>