diff options
Diffstat (limited to 'docs/API/classAdobeXMPCore_1_1IClientDOMSerializer__v1.html')
| -rwxr-xr-x | docs/API/classAdobeXMPCore_1_1IClientDOMSerializer__v1.html | 331 |
1 files changed, 331 insertions, 0 deletions
diff --git a/docs/API/classAdobeXMPCore_1_1IClientDOMSerializer__v1.html b/docs/API/classAdobeXMPCore_1_1IClientDOMSerializer__v1.html new file mode 100755 index 0000000..ccc4fd2 --- /dev/null +++ b/docs/API/classAdobeXMPCore_1_1IClientDOMSerializer__v1.html @@ -0,0 +1,331 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>AdobeXMPCore::IClientDOMSerializer_v1 Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<img src="xmp_tagline_small.jpg" width="125" height="50" border="0"><p> +<!-- Generated by Doxygen 1.8.11 --> + <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> + </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="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('classAdobeXMPCore_1_1IClientDOMSerializer__v1.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="classAdobeXMPCore_1_1IClientDOMSerializer__v1-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">AdobeXMPCore::IClientDOMSerializer_v1 Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>Version 1 of the interface that supports serializing by the client supplied serializer of the XMP Data Model. + <a href="classAdobeXMPCore_1_1IClientDOMSerializer__v1.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="IClientDOMSerializer_8h_source.html">IClientDOMSerializer.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a604822b9cacd9b1ebaba08e49513f778"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCore_1_1IClientDOMSerializer__v1.html#a604822b9cacd9b1ebaba08e49513f778">Serialize</a> (const <a class="el" href="namespaceAdobeXMPCore.html#aeec2c711a611cbc3c77ef1a0bb026e33">spINode</a> &node, const <a class="el" href="namespaceAdobeXMPCore.html#a22f9e572045a61aa3cfc629a0d877d72">spcINameSpacePrefixMap</a> &nameSpacePrefixMap, <a class="el" href="namespaceAdobeXMPCommon.html#a394d772cfe78f1dbeba6059e7a3c65d6">pcIConfigurable</a> configurationParameters, <a class="el" href="classAdobeXMPCommon_1_1ReportErrorAndContinueFunctor.html">ReportErrorAndContinueFunctor</a> functor, const <a class="el" href="namespaceAdobeXMPCommon.html#ac9d7760a1805b1e28828511a2c8c5588">spIUTF8String</a> &string)=0</td></tr> +<tr class="memdesc:a604822b9cacd9b1ebaba08e49513f778"><td class="mdescLeft"> </td><td class="mdescRight">Serialize the XMP Data Model taking into account the configuration parameters. <a href="#a604822b9cacd9b1ebaba08e49513f778">More...</a><br /></td></tr> +<tr class="separator:a604822b9cacd9b1ebaba08e49513f778"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa6090a60c51266963005c2fce33ea760"><td class="memItemLeft" align="right" valign="top">virtual bool APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCore_1_1IClientDOMSerializer__v1.html#aa6090a60c51266963005c2fce33ea760">AreKeysCaseSensitive</a> () const </td></tr> +<tr class="memdesc:aa6090a60c51266963005c2fce33ea760"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether object supports case sensitive keys or not. <a href="#aa6090a60c51266963005c2fce33ea760">More...</a><br /></td></tr> +<tr class="separator:aa6090a60c51266963005c2fce33ea760"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a370646890f776a587f0faff20d590059"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCore_1_1IClientDOMSerializer__v1.html#a370646890f776a587f0faff20d590059">Initialize</a> (<a class="el" href="namespaceAdobeXMPCommon.html#a9befc7ddfe5977c8176eed763d9ce69e">pIConfigurable</a> configurationParameters)</td></tr> +<tr class="memdesc:a370646890f776a587f0faff20d590059"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the default configuration parameters. The object needs to fill the default configuration parameters supported by it. <a href="#a370646890f776a587f0faff20d590059">More...</a><br /></td></tr> +<tr class="separator:a370646890f776a587f0faff20d590059"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5bcaa25de727ee1e8e9399dd963aa5c3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceAdobeXMPCommon.html#a87fa911f1ea5a79801b7fe3530637c42">eConfigurableErrorCode</a> APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCore_1_1IClientDOMSerializer__v1.html#a5bcaa25de727ee1e8e9399dd963aa5c3">Validate</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, <a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1">IConfigurable::eDataType</a> dataType, const <a class="el" href="unionAdobeXMPCommon_1_1IConfigurable_1_1CombinedDataValue.html">IConfigurable::CombinedDataValue</a> &dataValue)</td></tr> +<tr class="memdesc:a5bcaa25de727ee1e8e9399dd963aa5c3"><td class="mdescLeft"> </td><td class="mdescRight">Validate the data type and value for a parameter. <a href="#a5bcaa25de727ee1e8e9399dd963aa5c3">More...</a><br /></td></tr> +<tr class="separator:a5bcaa25de727ee1e8e9399dd963aa5c3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a513bdaeb37f453787f46a5e855ac08ef"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCore_1_1IClientDOMSerializer__v1.html#a513bdaeb37f453787f46a5e855ac08ef">Release</a> () const <a class="el" href="XMPCommonDefines_8h.html#a5a929113d3d50bda3fb7135a5c8b24a2">__NOTHROW__</a>=0</td></tr> +<tr class="memdesc:a513bdaeb37f453787f46a5e855ac08ef"><td class="mdescLeft"> </td><td class="mdescRight">Called by the library when the object is no longer required by it and client can free up the resources or memory associated with the object. <a href="#a513bdaeb37f453787f46a5e855ac08ef">More...</a><br /></td></tr> +<tr class="separator:a513bdaeb37f453787f46a5e855ac08ef"><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 class="memitem:a58ff533c49dcfcf3374097aea70c1107"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCore_1_1IClientDOMSerializer__v1.html#a58ff533c49dcfcf3374097aea70c1107">~IClientDOMSerializer_v1</a> ()</td></tr> +<tr class="separator:a58ff533c49dcfcf3374097aea70c1107"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Version 1 of the interface that supports serializing by the client supplied serializer of the XMP Data Model. </p> +<p>Provides functions to serialize the XMP Data Model. Thread safety is controllable by the client. </p> + +<p>Definition at line <a class="el" href="IClientDOMSerializer_8h_source.html#l00025">25</a> of file <a class="el" href="IClientDOMSerializer_8h_source.html">IClientDOMSerializer.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a58ff533c49dcfcf3374097aea70c1107"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual AdobeXMPCore::IClientDOMSerializer_v1::~IClientDOMSerializer_v1 </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Destructor </p> + +<p>Definition at line <a class="el" href="IClientDOMSerializer_8h_source.html#l00077">77</a> of file <a class="el" href="IClientDOMSerializer_8h_source.html">IClientDOMSerializer.h</a>.</p> + +<p>References <a class="el" href="XMPCommonDefines_8h_source.html#l00117">__NOTHROW__</a>, and <a class="el" href="XMPCommonDefines_8h_source.html#l00107">REQ_FRIEND_CLASS_DECLARATION</a>.</p> +<div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> {}</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="aa6090a60c51266963005c2fce33ea760"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual bool APICALL AdobeXMPCore::IClientDOMSerializer_v1::AreKeysCaseSensitive </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Indicates whether object supports case sensitive keys or not. </p> +<dl class="section return"><dt>Returns</dt><dd>True in case object supports case sensitive keys, false otherwise. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Default implementation makes keys case insensitive. </dd></dl> + +<p>Definition at line <a class="el" href="IClientDOMSerializer_8h_source.html#l00046">46</a> of file <a class="el" href="IClientDOMSerializer_8h_source.html">IClientDOMSerializer.h</a>.</p> +<div class="fragment"><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div></div><!-- fragment --> +</div> +</div> +<a class="anchor" id="a370646890f776a587f0faff20d590059"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void APICALL AdobeXMPCore::IClientDOMSerializer_v1::Initialize </td> + <td>(</td> + <td class="paramtype"><a class="el" href="namespaceAdobeXMPCommon.html#a9befc7ddfe5977c8176eed763d9ce69e">pIConfigurable</a> </td> + <td class="paramname"><em>configurationParameters</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Initializes the default configuration parameters. The object needs to fill the default configuration parameters supported by it. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">configurationParameters</td><td>An empty object of type <a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html" title="Interface that allows to attach various key-value parameters to the underlying object. ">AdobeXMPCommon::IConfigurable</a>. </td></tr> + </table> + </dd> +</dl> +<dl class="section note"><dt>Note</dt><dd>Default implementation does not fill anything in the configuration parameters. </dd></dl> + +<p>Definition at line <a class="el" href="IClientDOMSerializer_8h_source.html#l00054">54</a> of file <a class="el" href="IClientDOMSerializer_8h_source.html">IClientDOMSerializer.h</a>.</p> +<div class="fragment"><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> {};</div></div><!-- fragment --> +</div> +</div> +<a class="anchor" id="a513bdaeb37f453787f46a5e855ac08ef"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void APICALL AdobeXMPCore::IClientDOMSerializer_v1::Release </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Called by the library when the object is no longer required by it and client can free up the resources or memory associated with the object. </p> + +</div> +</div> +<a class="anchor" id="a604822b9cacd9b1ebaba08e49513f778"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void APICALL AdobeXMPCore::IClientDOMSerializer_v1::Serialize </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceAdobeXMPCore.html#aeec2c711a611cbc3c77ef1a0bb026e33">spINode</a> & </td> + <td class="paramname"><em>node</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceAdobeXMPCore.html#a22f9e572045a61aa3cfc629a0d877d72">spcINameSpacePrefixMap</a> & </td> + <td class="paramname"><em>nameSpacePrefixMap</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespaceAdobeXMPCommon.html#a394d772cfe78f1dbeba6059e7a3c65d6">pcIConfigurable</a> </td> + <td class="paramname"><em>configurationParameters</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classAdobeXMPCommon_1_1ReportErrorAndContinueFunctor.html">ReportErrorAndContinueFunctor</a> </td> + <td class="paramname"><em>functor</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceAdobeXMPCommon.html#ac9d7760a1805b1e28828511a2c8c5588">spIUTF8String</a> & </td> + <td class="paramname"><em>string</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Serialize the XMP Data Model taking into account the configuration parameters. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">node</td><td>The node to be serialized. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">nameSpacePrefixMap</td><td>An object of type #INameSpacePrefixMap which contains preferred prefixes for namespaces. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">configurationParameters</td><td>An object of type <a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html" title="Interface that allows to attach various key-value parameters to the underlying object. ">AdobeXMPCommon::IConfigurable</a> containing all the configuration parameters requested by client to be taken care of while serializing. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">functor</td><td>A function object to be used by the serializing operation to report back any encountered errors/warnings. </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">string</td><td>A shared pointer to an IUTF8String object which should be filled with the serialized form of XMP Data Model. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a5bcaa25de727ee1e8e9399dd963aa5c3"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespaceAdobeXMPCommon.html#a87fa911f1ea5a79801b7fe3530637c42">eConfigurableErrorCode</a> APICALL AdobeXMPCore::IClientDOMSerializer_v1::Validate </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> & </td> + <td class="paramname"><em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1">IConfigurable::eDataType</a> </td> + <td class="paramname"><em>dataType</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="unionAdobeXMPCommon_1_1IConfigurable_1_1CombinedDataValue.html">IConfigurable::CombinedDataValue</a> & </td> + <td class="paramname"><em>dataValue</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Validate the data type and value for a parameter. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>An unsigned 64 bit integer value indicating the key. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">dataType</td><td>A value of type <a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1" title="Indicates various types of parameter values. ">AdobeXMPCommon::IConfigurable::eDataType</a> indicating the type of value the parameter holds. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">dataValue</td><td>A value of #<a class="el" href="unionAdobeXMPCommon_1_1IConfigurable_1_1CombinedDataValue.html" title="A union data type to store all kind of values. ">AdobeXMPCommon::IConfigurable::CombinedDataValue</a> indicating the value the parameter holds. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>An error code in case there is something wrong with the combination, otherwise returns #AdobeXMPCommon::eCECNone. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Default implementation validates all the keys + dataTypes + dataValue combinations. </dd></dl> + +<p>Definition at line <a class="el" href="IClientDOMSerializer_8h_source.html#l00064">64</a> of file <a class="el" href="IClientDOMSerializer_8h_source.html">IClientDOMSerializer.h</a>.</p> + +<p>References <a class="el" href="XMPCommonDefines_8h_source.html#l00117">__NOTHROW__</a>, and <a class="el" href="XMPCommonErrorCodes_8h_source.html#l00092">AdobeXMPCommon::kCECNone</a>.</p> +<div class="fragment"><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceAdobeXMPCommon.html#a87fa911f1ea5a79801b7fe3530637c42a48a521a6e08fd24bef691efb926189f4">kCECNone</a>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div><div class="ttc" id="namespaceAdobeXMPCommon_html_a87fa911f1ea5a79801b7fe3530637c42a48a521a6e08fd24bef691efb926189f4"><div class="ttname"><a href="namespaceAdobeXMPCommon.html#a87fa911f1ea5a79801b7fe3530637c42a48a521a6e08fd24bef691efb926189f4">AdobeXMPCommon::kCECNone</a></div><div class="ttdoc">Indicates no error. </div><div class="ttdef"><b>Definition:</b> <a href="XMPCommonErrorCodes_8h_source.html#l00092">XMPCommonErrorCodes.h:92</a></div></div> +</div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>C:/XMP/XMP-Toolkit-SDK-CC201607/XMP-Toolkit-SDK-CC201607/public/include/XMPCore/Interfaces/<a class="el" href="IClientDOMSerializer_8h_source.html">IClientDOMSerializer.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<hr size="1"><address style="text-align: right;"><small> +XMPToolkit documentation generated by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.11</small></address> +</body> +</html> |