diff options
Diffstat (limited to 'docs/API/XMP_8hpp.html')
| -rwxr-xr-x | docs/API/XMP_8hpp.html | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/docs/API/XMP_8hpp.html b/docs/API/XMP_8hpp.html new file mode 100755 index 0000000..fd21411 --- /dev/null +++ b/docs/API/XMP_8hpp.html @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>C:/XMP/XMP-Toolkit-SDK-CC201607/XMP-Toolkit-SDK-CC201607/public/include/XMP.hpp File 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><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File 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('XMP_8hpp.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="headertitle"> +<div class="title">XMP.hpp File Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Overall header file for the XMP Toolkit. +<a href="#details">More...</a></p> +<div class="textblock"><code>#include "<a class="el" href="XMP__Environment_8h_source.html">XMP_Environment.h</a>"</code><br /> +<code>#include "<a class="el" href="XMP__Version_8h_source.html">XMP_Version.h</a>"</code><br /> +<code>#include "<a class="el" href="XMP__Const_8h_source.html">XMP_Const.h</a>"</code><br /> +</div> +<p><a href="XMP_8hpp_source.html">Go to the source code of this file.</a></p> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Overall header file for the XMP Toolkit. </p> +<p>This is an overall header file, the only one that C++ clients should include.</p> +<p>The full client API is in the <code><a class="el" href="TXMPMeta_8hpp.html" title="API for access to the XMP Toolkit core services. ">TXMPMeta.hpp</a></code>, <code><a class="el" href="TXMPIterator_8hpp.html" title="API for access to the XMP Toolkit iteration services. ">TXMPIterator.hpp</a></code>, <code><a class="el" href="TXMPUtils_8hpp.html" title="API for access to the XMP Toolkit utility services. ">TXMPUtils.hpp</a></code> headers. Read these for information, but do not include them directly. The <code>TXMP</code>... classes are C++ template classes that must be instantiated with a string class such as <code>std::string</code>. The string class is used to return text strings for property values, serialized XMP, and so on. Clients must also compile <code>XMP.incl_cpp</code> to ensure that all client-side glue code is generated. This should be done by including it in exactly one client source file.</p> +<p>There are two C preprocessor macros that simplify use of the templates:</p> +<ul> +<li><code>TXMP_STRING_TYPE</code> - Define this as the string class to use with the template. You will get the template headers included and typedefs (<code>SXMPMeta</code>, and so on) to use in your code.</li> +</ul> +<ul> +<li><code>TXMP_EXPAND_INLINE</code> - Define this as 1 if you want to have the template functions expanded inline in your code. Leave it undefined, or defined as 0, to use out-of-line instantiations of the template functions. Compiling <code>XMP.incl_cpp</code> generates explicit out-of-line instantiations if <code>TXMP_EXPAND_INLINE</code> is off.</li> +</ul> +<p>The template parameter, class <code>tStringObj</code>, must have the following member functions (which match those for <code>std::string</code>):</p> +<pre> + tStringObj& assign ( const char * str, size_t len ) + size_t size() const + const char * c_str() const +</pre><p>The string class must be suitable for at least UTF-8. This is the encoding used for all general values, and is the default encoding for serialized XMP. The string type must also be suitable for UTF-16 or UTF-32 if those serialization encodings are used. This mainly means tolerating embedded 0 bytes, which <code>std::string</code> does. </p> + +<p>Definition in file <a class="el" href="XMP_8hpp_source.html">XMP.hpp</a>.</p> +</div></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> |