diff options
Diffstat (limited to 'docs/API/classAdobeXMPCommon_1_1IConfigurable.html')
| -rwxr-xr-x | docs/API/classAdobeXMPCommon_1_1IConfigurable.html | 964 |
1 files changed, 964 insertions, 0 deletions
diff --git a/docs/API/classAdobeXMPCommon_1_1IConfigurable.html b/docs/API/classAdobeXMPCommon_1_1IConfigurable.html new file mode 100755 index 0000000..8908247 --- /dev/null +++ b/docs/API/classAdobeXMPCommon_1_1IConfigurable.html @@ -0,0 +1,964 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>AdobeXMPCommon::IConfigurable 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('classAdobeXMPCommon_1_1IConfigurable.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#pub-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="#friends">Friends</a> | +<a href="classAdobeXMPCommon_1_1IConfigurable-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">AdobeXMPCommon::IConfigurable Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>Interface that allows to attach various key-value parameters to the underlying object. + <a href="classAdobeXMPCommon_1_1IConfigurable.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="IConfigurable_8h_source.html">IConfigurable.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for AdobeXMPCommon::IConfigurable:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classAdobeXMPCommon_1_1IConfigurable.png" usemap="#AdobeXMPCommon::IConfigurable_map" alt=""/> + <map id="AdobeXMPCommon::IConfigurable_map" name="AdobeXMPCommon::IConfigurable_map"> +<area href="classAdobeXMPCore_1_1IDOMParser__v1.html" title="Version 1 of the interface that supports parsing of the XMP Data Model. " alt="AdobeXMPCore::IDOMParser_v1" shape="rect" coords="0,56,219,80"/> +<area href="classAdobeXMPCore_1_1IDOMSerializer__v1.html" title="Version1 of the interface that represents an object that can serialize an XMP Data Model to a buffer..." alt="AdobeXMPCore::IDOMSerializer_v1" shape="rect" coords="229,56,448,80"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="unionAdobeXMPCommon_1_1IConfigurable_1_1CombinedDataValue.html">CombinedDataValue</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A union data type to store all kind of values. <a href="unionAdobeXMPCommon_1_1IConfigurable_1_1CombinedDataValue.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><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:ad64e6ae45633298b7158be2b0dce79a1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1">eDataType</a> { <br /> +  <a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a0233b4bacf60f59232fd3fc0dee50a27">kDTNone</a> = 0, +<a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1abdf14ab0f7a234fc99bc476dc4212f4e">kDTBool</a> = 1 << 0, +<a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1ad24c2bb370f5fa12dee346051c13409e">kDTUint64</a> = 1 << 1, +<a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a5c57cf68bc47c55815b5bfc1146df0c3">kDTInt64</a> = 1 << 2, +<br /> +  <a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a01da29c7d11b67856b0e9d5f3fe4cdb4">kDTChar</a> = 1 << 3, +<a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a11c2a544d5ac467b22d7d10098237efa">kDTDouble</a> = 1 << 4, +<a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a8d6faef7e1737835b5007987ed99c48d">kDTConstCharBuffer</a> = 1 << 5, +<a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a242c98a52e8d324027a00ee6f66d4c39">kDTConstVoidPtr</a> = 1 << 6, +<br /> +  <a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1ac5217140bec2fb51971d31759f24b81a">kDTAll</a> = 0xFFFFFFFF +<br /> + }<tr class="memdesc:ad64e6ae45633298b7158be2b0dce79a1"><td class="mdescLeft"> </td><td class="mdescRight">Indicates various types of parameter values. <a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1">More...</a><br /></td></tr> +</td></tr> +<tr class="separator:ad64e6ae45633298b7158be2b0dce79a1"><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 class="memitem:a046edf1c0c7d4f994295207dea1242f7"><td class="memItemLeft" align="right" valign="top">virtual bool APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a046edf1c0c7d4f994295207dea1242f7">RemoveParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key)=0</td></tr> +<tr class="memdesc:a046edf1c0c7d4f994295207dea1242f7"><td class="mdescLeft"> </td><td class="mdescRight">Removes a particular parameter if present. <a href="#a046edf1c0c7d4f994295207dea1242f7">More...</a><br /></td></tr> +<tr class="separator:a046edf1c0c7d4f994295207dea1242f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad0e79a0e44353d08139358a56e8510fb"><td class="memItemLeft" align="right" valign="top">virtual std::vector< <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> > APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad0e79a0e44353d08139358a56e8510fb">GetAllParameters</a> () const =0</td></tr> +<tr class="memdesc:ad0e79a0e44353d08139358a56e8510fb"><td class="mdescLeft"> </td><td class="mdescRight">Get all the keys of the parameters associated with the object. <a href="#ad0e79a0e44353d08139358a56e8510fb">More...</a><br /></td></tr> +<tr class="separator:ad0e79a0e44353d08139358a56e8510fb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2a1e1d3f515d431478ec309fa9dcd977"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceAdobeXMPCommon.html#a1c85c2f558b495c3d41eabe692a96cf2">sizet</a> APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a2a1e1d3f515d431478ec309fa9dcd977">Size</a> () const <a class="el" href="XMPCommonDefines_8h.html#a5a929113d3d50bda3fb7135a5c8b24a2">__NOTHROW__</a>=0</td></tr> +<tr class="memdesc:a2a1e1d3f515d431478ec309fa9dcd977"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of parameters associated with the object. <a href="#a2a1e1d3f515d431478ec309fa9dcd977">More...</a><br /></td></tr> +<tr class="separator:a2a1e1d3f515d431478ec309fa9dcd977"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7e71691861d38ae351bdd42392b78af6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1">eDataType</a> APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a7e71691861d38ae351bdd42392b78af6">GetDataType</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key) const =0</td></tr> +<tr class="memdesc:a7e71691861d38ae351bdd42392b78af6"><td class="mdescLeft"> </td><td class="mdescRight">Get the value type of a particular parameter. <a href="#a7e71691861d38ae351bdd42392b78af6">More...</a><br /></td></tr> +<tr class="separator:a7e71691861d38ae351bdd42392b78af6"><td class="memSeparator" colspan="2"> </td></tr> +<tr><td colspan="2"><div class="groupHeader"></div></td></tr> +<tr class="memitem:a174330a36f7e3d27cc0230698ff59313"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a174330a36f7e3d27cc0230698ff59313">SetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, bool value)=0</td></tr> +<tr class="memdesc:a174330a36f7e3d27cc0230698ff59313"><td class="mdescLeft"> </td><td class="mdescRight">Add/Change a value of a parameter. <a href="#a174330a36f7e3d27cc0230698ff59313">More...</a><br /></td></tr> +<tr class="separator:a174330a36f7e3d27cc0230698ff59313"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abc24d334364271934f6f8f1ac9051836"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#abc24d334364271934f6f8f1ac9051836">SetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> value)=0</td></tr> +<tr class="separator:abc24d334364271934f6f8f1ac9051836"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad248a17a9bc7ca1c189f353f62e829c4"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad248a17a9bc7ca1c189f353f62e829c4">SetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, <a class="el" href="namespaceAdobeXMPCommon.html#aee4f68e01de51c2cf1c1044ecafebc25">int64</a> value)=0</td></tr> +<tr class="separator:ad248a17a9bc7ca1c189f353f62e829c4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad3b3acdbd19e5860d3e5c5cdcffeb016"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad3b3acdbd19e5860d3e5c5cdcffeb016">SetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, double value)=0</td></tr> +<tr class="separator:ad3b3acdbd19e5860d3e5c5cdcffeb016"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4f5a64d500f2fd8110f31a2b582e0759"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a4f5a64d500f2fd8110f31a2b582e0759">SetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, char value)=0</td></tr> +<tr class="separator:a4f5a64d500f2fd8110f31a2b582e0759"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae3de9436a04fcd5f6f8bd21fcc9a9edd"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ae3de9436a04fcd5f6f8bd21fcc9a9edd">SetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, const char *value)=0</td></tr> +<tr class="separator:ae3de9436a04fcd5f6f8bd21fcc9a9edd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a75784001a19ac899764807095e648c70"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a75784001a19ac899764807095e648c70">SetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, const void *value)=0</td></tr> +<tr class="separator:a75784001a19ac899764807095e648c70"><td class="memSeparator" colspan="2"> </td></tr> +<tr><td colspan="2"><div class="groupHeader"></div></td></tr> +<tr class="memitem:adc0c0be10213808b04e9cef27a0efa4c"><td class="memItemLeft" align="right" valign="top">virtual bool APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#adc0c0be10213808b04e9cef27a0efa4c">GetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, bool &value) const =0</td></tr> +<tr class="memdesc:adc0c0be10213808b04e9cef27a0efa4c"><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a parameter if present. <a href="#adc0c0be10213808b04e9cef27a0efa4c">More...</a><br /></td></tr> +<tr class="separator:adc0c0be10213808b04e9cef27a0efa4c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a11b855a90f26dee8d87b70ee485e6ec3"><td class="memItemLeft" align="right" valign="top">virtual bool APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a11b855a90f26dee8d87b70ee485e6ec3">GetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &value) const =0</td></tr> +<tr class="separator:a11b855a90f26dee8d87b70ee485e6ec3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af655f02a3941826182ea54a2eb012e0d"><td class="memItemLeft" align="right" valign="top">virtual bool APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#af655f02a3941826182ea54a2eb012e0d">GetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, <a class="el" href="namespaceAdobeXMPCommon.html#aee4f68e01de51c2cf1c1044ecafebc25">int64</a> &value) const =0</td></tr> +<tr class="separator:af655f02a3941826182ea54a2eb012e0d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abc8b38df0036ec164aa6c108cdee9a5e"><td class="memItemLeft" align="right" valign="top">virtual bool APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#abc8b38df0036ec164aa6c108cdee9a5e">GetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, double &value) const =0</td></tr> +<tr class="separator:abc8b38df0036ec164aa6c108cdee9a5e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4c35becce65c3cb18075f4cac9d57609"><td class="memItemLeft" align="right" valign="top">virtual bool APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a4c35becce65c3cb18075f4cac9d57609">GetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, char &value) const =0</td></tr> +<tr class="separator:a4c35becce65c3cb18075f4cac9d57609"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6115940df0fe3a07749cbf4a2bb0acbb"><td class="memItemLeft" align="right" valign="top">virtual bool APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a6115940df0fe3a07749cbf4a2bb0acbb">GetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, const char *&value) const =0</td></tr> +<tr class="separator:a6115940df0fe3a07749cbf4a2bb0acbb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a99fb34ba1e27e2e6cadea3755284cee1"><td class="memItemLeft" align="right" valign="top">virtual bool APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a99fb34ba1e27e2e6cadea3755284cee1">GetParameter</a> (const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> &key, const void *&value) const =0</td></tr> +<tr class="separator:a99fb34ba1e27e2e6cadea3755284cee1"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:a932bf0b8f4396de0e29f6c165954e5dc"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a932bf0b8f4396de0e29f6c165954e5dc">ConvertCharBufferToUint64</a> (const char *key)</td></tr> +<tr class="memdesc:a932bf0b8f4396de0e29f6c165954e5dc"><td class="mdescLeft"> </td><td class="mdescRight">Utility function to convert character buffer ( maximum of 8 characters ) to uint64 representation. <a href="#a932bf0b8f4396de0e29f6c165954e5dc">More...</a><br /></td></tr> +<tr class="separator:a932bf0b8f4396de0e29f6c165954e5dc"><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:a7c19f627db3d07e227e93a6a0e6b20ab"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#a7c19f627db3d07e227e93a6a0e6b20ab">~IConfigurable</a> () <a class="el" href="XMPCommonDefines_8h.html#a5a929113d3d50bda3fb7135a5c8b24a2">__NOTHROW__</a></td></tr> +<tr class="separator:a7c19f627db3d07e227e93a6a0e6b20ab"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abb69da6d73e4b56c30e56b43f5a37b9b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#abb69da6d73e4b56c30e56b43f5a37b9b">REQ_FRIEND_CLASS_DECLARATION</a> ()</td></tr> +<tr class="separator:abb69da6d73e4b56c30e56b43f5a37b9b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> +Friends</h2></td></tr> +<tr class="memitem:ac321e3926928c7c9b58bab66d6270da5"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ac321e3926928c7c9b58bab66d6270da5">IConfigurableProxy</a></td></tr> +<tr class="separator:ac321e3926928c7c9b58bab66d6270da5"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Interface that allows to attach various key-value parameters to the underlying object. </p> +<p>Key is an unsigned 64-bit integer value which can be a char buffer of eight characters also. </p><dl class="section note"><dt>Note</dt><dd>For all value types except user data ( const void * ) or char buffer ( const char * ) a copy is made and is stored, so the scope is maintained internally. But for user data ( const void * ) or char buffer ( const char * ) its clients responsibility to make sure these pointers remain valid through out the life span of the object or objects derived from it. </dd></dl> + +<p>Definition at line <a class="el" href="IConfigurable_8h_source.html#l00030">30</a> of file <a class="el" href="IConfigurable_8h_source.html">IConfigurable.h</a>.</p> +</div><h2 class="groupheader">Member Enumeration Documentation</h2> +<a class="anchor" id="ad64e6ae45633298b7158be2b0dce79a1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1">AdobeXMPCommon::IConfigurable::eDataType</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Indicates various types of parameter values. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ad64e6ae45633298b7158be2b0dce79a1a0233b4bacf60f59232fd3fc0dee50a27"></a>kDTNone </td><td class="fielddoc"> +<p>Data type is none. </p> +<p>Data type is boolean. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="ad64e6ae45633298b7158be2b0dce79a1abdf14ab0f7a234fc99bc476dc4212f4e"></a>kDTBool </td><td class="fielddoc"> +<p>Data type is unsigned 64 bit integer. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="ad64e6ae45633298b7158be2b0dce79a1ad24c2bb370f5fa12dee346051c13409e"></a>kDTUint64 </td><td class="fielddoc"> +<p>Data type is signed 64 bit integer. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="ad64e6ae45633298b7158be2b0dce79a1a5c57cf68bc47c55815b5bfc1146df0c3"></a>kDTInt64 </td><td class="fielddoc"> +<p>Data type is character. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="ad64e6ae45633298b7158be2b0dce79a1a01da29c7d11b67856b0e9d5f3fe4cdb4"></a>kDTChar </td><td class="fielddoc"> +<p>Data type is double. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="ad64e6ae45633298b7158be2b0dce79a1a11c2a544d5ac467b22d7d10098237efa"></a>kDTDouble </td><td class="fielddoc"> +<p>Data type is char buffer. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="ad64e6ae45633298b7158be2b0dce79a1a8d6faef7e1737835b5007987ed99c48d"></a>kDTConstCharBuffer </td><td class="fielddoc"> +<p>Data type is user data ( pointer to const void ). </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="ad64e6ae45633298b7158be2b0dce79a1a242c98a52e8d324027a00ee6f66d4c39"></a>kDTConstVoidPtr </td><td class="fielddoc"> +<p>Maximum value this enum can hold. </p> +</td></tr> +<tr><td class="fieldname"><a class="anchor" id="ad64e6ae45633298b7158be2b0dce79a1ac5217140bec2fb51971d31759f24b81a"></a>kDTAll </td><td class="fielddoc"> +</td></tr> +</table> + +<p>Definition at line <a class="el" href="IConfigurable_8h_source.html#l00037">37</a> of file <a class="el" href="IConfigurable_8h_source.html">IConfigurable.h</a>.</p> +<div class="fragment"><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a0233b4bacf60f59232fd3fc0dee50a27">kDTNone</a> = 0,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1abdf14ab0f7a234fc99bc476dc4212f4e">kDTBool</a> = 1 << 0,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1ad24c2bb370f5fa12dee346051c13409e">kDTUint64</a> = 1 << 1,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a5c57cf68bc47c55815b5bfc1146df0c3">kDTInt64</a> = 1 << 2,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a01da29c7d11b67856b0e9d5f3fe4cdb4">kDTChar</a> = 1 << 3,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a11c2a544d5ac467b22d7d10098237efa">kDTDouble</a> = 1 << 4,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a8d6faef7e1737835b5007987ed99c48d">kDTConstCharBuffer</a> = 1 << 5,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a242c98a52e8d324027a00ee6f66d4c39">kDTConstVoidPtr</a> = 1 << 6,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1ac5217140bec2fb51971d31759f24b81a">kDTAll</a> = 0xFFFFFFFF</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  } <a class="code" href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1">eDataType</a>;</div><div class="ttc" id="classAdobeXMPCommon_1_1IConfigurable_html_ad64e6ae45633298b7158be2b0dce79a1ad24c2bb370f5fa12dee346051c13409e"><div class="ttname"><a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1ad24c2bb370f5fa12dee346051c13409e">AdobeXMPCommon::IConfigurable::kDTUint64</a></div><div class="ttdoc">Data type is signed 64 bit integer. </div><div class="ttdef"><b>Definition:</b> <a href="IConfigurable_8h_source.html#l00043">IConfigurable.h:43</a></div></div> +<div class="ttc" id="classAdobeXMPCommon_1_1IConfigurable_html_ad64e6ae45633298b7158be2b0dce79a1a8d6faef7e1737835b5007987ed99c48d"><div class="ttname"><a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a8d6faef7e1737835b5007987ed99c48d">AdobeXMPCommon::IConfigurable::kDTConstCharBuffer</a></div><div class="ttdoc">Data type is user data ( pointer to const void ). </div><div class="ttdef"><b>Definition:</b> <a href="IConfigurable_8h_source.html#l00051">IConfigurable.h:51</a></div></div> +<div class="ttc" id="classAdobeXMPCommon_1_1IConfigurable_html_ad64e6ae45633298b7158be2b0dce79a1a0233b4bacf60f59232fd3fc0dee50a27"><div class="ttname"><a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a0233b4bacf60f59232fd3fc0dee50a27">AdobeXMPCommon::IConfigurable::kDTNone</a></div><div class="ttdoc">Data type is none. </div><div class="ttdef"><b>Definition:</b> <a href="IConfigurable_8h_source.html#l00039">IConfigurable.h:39</a></div></div> +<div class="ttc" id="classAdobeXMPCommon_1_1IConfigurable_html_ad64e6ae45633298b7158be2b0dce79a1a01da29c7d11b67856b0e9d5f3fe4cdb4"><div class="ttname"><a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a01da29c7d11b67856b0e9d5f3fe4cdb4">AdobeXMPCommon::IConfigurable::kDTChar</a></div><div class="ttdoc">Data type is double. </div><div class="ttdef"><b>Definition:</b> <a href="IConfigurable_8h_source.html#l00047">IConfigurable.h:47</a></div></div> +<div class="ttc" id="classAdobeXMPCommon_1_1IConfigurable_html_ad64e6ae45633298b7158be2b0dce79a1a11c2a544d5ac467b22d7d10098237efa"><div class="ttname"><a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a11c2a544d5ac467b22d7d10098237efa">AdobeXMPCommon::IConfigurable::kDTDouble</a></div><div class="ttdoc">Data type is char buffer. </div><div class="ttdef"><b>Definition:</b> <a href="IConfigurable_8h_source.html#l00049">IConfigurable.h:49</a></div></div> +<div class="ttc" id="classAdobeXMPCommon_1_1IConfigurable_html_ad64e6ae45633298b7158be2b0dce79a1"><div class="ttname"><a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1">AdobeXMPCommon::IConfigurable::eDataType</a></div><div class="ttdeci">eDataType</div><div class="ttdoc">Indicates various types of parameter values. </div><div class="ttdef"><b>Definition:</b> <a href="IConfigurable_8h_source.html#l00037">IConfigurable.h:37</a></div></div> +<div class="ttc" id="classAdobeXMPCommon_1_1IConfigurable_html_ad64e6ae45633298b7158be2b0dce79a1abdf14ab0f7a234fc99bc476dc4212f4e"><div class="ttname"><a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1abdf14ab0f7a234fc99bc476dc4212f4e">AdobeXMPCommon::IConfigurable::kDTBool</a></div><div class="ttdoc">Data type is unsigned 64 bit integer. </div><div class="ttdef"><b>Definition:</b> <a href="IConfigurable_8h_source.html#l00041">IConfigurable.h:41</a></div></div> +<div class="ttc" id="classAdobeXMPCommon_1_1IConfigurable_html_ad64e6ae45633298b7158be2b0dce79a1ac5217140bec2fb51971d31759f24b81a"><div class="ttname"><a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1ac5217140bec2fb51971d31759f24b81a">AdobeXMPCommon::IConfigurable::kDTAll</a></div><div class="ttdef"><b>Definition:</b> <a href="IConfigurable_8h_source.html#l00056">IConfigurable.h:56</a></div></div> +<div class="ttc" id="classAdobeXMPCommon_1_1IConfigurable_html_ad64e6ae45633298b7158be2b0dce79a1a242c98a52e8d324027a00ee6f66d4c39"><div class="ttname"><a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a242c98a52e8d324027a00ee6f66d4c39">AdobeXMPCommon::IConfigurable::kDTConstVoidPtr</a></div><div class="ttdoc">Maximum value this enum can hold. </div><div class="ttdef"><b>Definition:</b> <a href="IConfigurable_8h_source.html#l00053">IConfigurable.h:53</a></div></div> +<div class="ttc" id="classAdobeXMPCommon_1_1IConfigurable_html_ad64e6ae45633298b7158be2b0dce79a1a5c57cf68bc47c55815b5bfc1146df0c3"><div class="ttname"><a href="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1a5c57cf68bc47c55815b5bfc1146df0c3">AdobeXMPCommon::IConfigurable::kDTInt64</a></div><div class="ttdoc">Data type is character. </div><div class="ttdef"><b>Definition:</b> <a href="IConfigurable_8h_source.html#l00045">IConfigurable.h:45</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a7c19f627db3d07e227e93a6a0e6b20ab"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual AdobeXMPCommon::IConfigurable::~IConfigurable </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>protected Virtual Destructor </p> + +<p>Definition at line <a class="el" href="IConfigurable_8h_source.html#l00171">171</a> of file <a class="el" href="IConfigurable_8h_source.html">IConfigurable.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="l00171"></a><span class="lineno"> 171</span> {};</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a932bf0b8f4396de0e29f6c165954e5dc"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> AdobeXMPCommon::IConfigurable::ConvertCharBufferToUint64 </td> + <td>(</td> + <td class="paramtype">const char * </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">inline</span><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Utility function to convert character buffer ( maximum of 8 characters ) to uint64 representation. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>A pointer to const char buffer, maximum characters used are 8 provided there is no null character present in the buffer between 1st to 8 characters, otherwise characters upto NULL character (excluding NULL) are read. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A 64-bit unsigned integer representing the first 8 characters of the character buffer. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Return 0 in case key is NULL. </dd></dl> + +<p>Definition at line <a class="el" href="IConfigurable_8h_source.html#l00132">132</a> of file <a class="el" href="IConfigurable_8h_source.html">IConfigurable.h</a>.</p> +<div class="fragment"><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  {</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <a class="code" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> keyAsuint64 = 0;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordflow">if</span> ( key ) {</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordflow">for</span> ( <span class="keywordtype">int</span> i = 0; i < 8 && key[ i ] != <span class="charliteral">'\0'</span>; i++ ) {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  keyAsuint64 = keyAsuint64 << 8;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  keyAsuint64 += ( <span class="keywordtype">unsigned</span> char ) key[ i ];</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  }</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordflow">return</span> keyAsuint64;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  }</div><div class="ttc" id="namespaceAdobeXMPCommon_html_aea1d692da07b844d1f642b47ea6a91bd"><div class="ttname"><a href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">AdobeXMPCommon::uint64</a></div><div class="ttdeci">XMP_Uns64 uint64</div><div class="ttdef"><b>Definition:</b> <a href="XMPCommonDefines_8h_source.html#l00142">XMPCommonDefines.h:142</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a class="anchor" id="ad0e79a0e44353d08139358a56e8510fb"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual std::vector< <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> > APICALL AdobeXMPCommon::IConfigurable::GetAllParameters </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>Get all the keys of the parameters associated with the object. </p> +<p>Provide a std::vector containing the keys of all the parameters associated with the object. </p><dl class="section return"><dt>Returns</dt><dd>A std::vector of unsigned 64 bit integers. </dd></dl> + +</div> +</div> +<a class="anchor" id="a7e71691861d38ae351bdd42392b78af6"></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="classAdobeXMPCommon_1_1IConfigurable.html#ad64e6ae45633298b7158be2b0dce79a1">eDataType</a> APICALL AdobeXMPCommon::IConfigurable::GetDataType </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> & </td> + <td class="paramname"><em>key</em></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>Get the value type of a particular 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> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A value of type eDataType indicating the type of value the parameter is supposed to hold. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>return kDTNone in case no such key is associated with the object. </dd></dl> + +</div> +</div> +<a class="anchor" id="adc0c0be10213808b04e9cef27a0efa4c"></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 AdobeXMPCommon::IConfigurable::GetParameter </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">bool & </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</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>Get the value of a parameter if present. </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">[out]</td><td class="paramname">value</td><td>The value of the parameter. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>false if no such parameter is present, otherwise true. </dd></dl> +<dl class="section attention"><dt>Attention</dt><dd>Error is thrown in case the type of the parameter is not the one client is asking for. </dd></dl> + +</div> +</div> +<a class="anchor" id="a11b855a90f26dee8d87b70ee485e6ec3"></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 AdobeXMPCommon::IConfigurable::GetParameter </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="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> & </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</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"> + +</div> +</div> +<a class="anchor" id="af655f02a3941826182ea54a2eb012e0d"></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 AdobeXMPCommon::IConfigurable::GetParameter </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="namespaceAdobeXMPCommon.html#aee4f68e01de51c2cf1c1044ecafebc25">int64</a> & </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</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"> + +</div> +</div> +<a class="anchor" id="abc8b38df0036ec164aa6c108cdee9a5e"></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 AdobeXMPCommon::IConfigurable::GetParameter </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">double & </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</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"> + +</div> +</div> +<a class="anchor" id="a4c35becce65c3cb18075f4cac9d57609"></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 AdobeXMPCommon::IConfigurable::GetParameter </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">char & </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</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"> + +</div> +</div> +<a class="anchor" id="a6115940df0fe3a07749cbf4a2bb0acbb"></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 AdobeXMPCommon::IConfigurable::GetParameter </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">const char *& </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</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"> + +</div> +</div> +<a class="anchor" id="a99fb34ba1e27e2e6cadea3755284cee1"></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 AdobeXMPCommon::IConfigurable::GetParameter </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">const void *& </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</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"> + +</div> +</div> +<a class="anchor" id="a046edf1c0c7d4f994295207dea1242f7"></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 AdobeXMPCommon::IConfigurable::RemoveParameter </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> & </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">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Removes a particular parameter if present. </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> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>True in case key was present and is deleted. </dd></dl> +<dl class="section attention"><dt>Attention</dt><dd>Error is thrown in case<ul> +<li>key is a must have for the underlying object. </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="abb69da6d73e4b56c30e56b43f5a37b9b"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">AdobeXMPCommon::IConfigurable::REQ_FRIEND_CLASS_DECLARATION </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"> + +</div> +</div> +<a class="anchor" id="a174330a36f7e3d27cc0230698ff59313"></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 AdobeXMPCommon::IConfigurable::SetParameter </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">bool </td> + <td class="paramname"><em>value</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>Add/Change a value of 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">value</td><td>New value of the parameter. </td></tr> + </table> + </dd> +</dl> +<dl class="section attention"><dt>Attention</dt><dd>Error is thrown in case<ul> +<li>the previous type of value associated with key is of different type.</li> +<li>the type of value associated with key is not as expected. </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="abc24d334364271934f6f8f1ac9051836"></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 AdobeXMPCommon::IConfigurable::SetParameter </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="namespaceAdobeXMPCommon.html#aea1d692da07b844d1f642b47ea6a91bd">uint64</a> </td> + <td class="paramname"><em>value</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"> + +</div> +</div> +<a class="anchor" id="ad248a17a9bc7ca1c189f353f62e829c4"></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 AdobeXMPCommon::IConfigurable::SetParameter </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="namespaceAdobeXMPCommon.html#aee4f68e01de51c2cf1c1044ecafebc25">int64</a> </td> + <td class="paramname"><em>value</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"> + +</div> +</div> +<a class="anchor" id="ad3b3acdbd19e5860d3e5c5cdcffeb016"></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 AdobeXMPCommon::IConfigurable::SetParameter </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">double </td> + <td class="paramname"><em>value</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"> + +</div> +</div> +<a class="anchor" id="a4f5a64d500f2fd8110f31a2b582e0759"></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 AdobeXMPCommon::IConfigurable::SetParameter </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">char </td> + <td class="paramname"><em>value</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"> + +</div> +</div> +<a class="anchor" id="ae3de9436a04fcd5f6f8bd21fcc9a9edd"></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 AdobeXMPCommon::IConfigurable::SetParameter </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">const char * </td> + <td class="paramname"><em>value</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"> + +</div> +</div> +<a class="anchor" id="a75784001a19ac899764807095e648c70"></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 AdobeXMPCommon::IConfigurable::SetParameter </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">const void * </td> + <td class="paramname"><em>value</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"> + +</div> +</div> +<a class="anchor" id="a2a1e1d3f515d431478ec309fa9dcd977"></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#a1c85c2f558b495c3d41eabe692a96cf2">sizet</a> APICALL AdobeXMPCommon::IConfigurable::Size </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>Get the number of parameters associated with the object. </p> + +</div> +</div> +<h2 class="groupheader">Friends And Related Function Documentation</h2> +<a class="anchor" id="ac321e3926928c7c9b58bab66d6270da5"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">friend class IConfigurableProxy</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">friend</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="IConfigurable_8h_source.html#l00171">171</a> of file <a class="el" href="IConfigurable_8h_source.html">IConfigurable.h</a>.</p> + +</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/XMPCommon/Interfaces/BaseInterfaces/<a class="el" href="IConfigurable_8h_source.html">IConfigurable.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> |