diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/class_context_type_registry_info.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/class_context_type_registry_info.html | 284 |
1 files changed, 284 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/class_context_type_registry_info.html b/libcontextsubscriber/doc/html/class_context_type_registry_info.html new file mode 100644 index 00000000..d07351ea --- /dev/null +++ b/libcontextsubscriber/doc/html/class_context_type_registry_info.html @@ -0,0 +1,284 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<title>libcontextsubscriber: ContextTypeRegistryInfo Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<!-- Generated by Doxygen 1.6.1 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</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 class="tabs"> + <ul> + <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> +<div class="contents"> +<h1>ContextTypeRegistryInfo Class Reference</h1><!-- doxytag: class="ContextTypeRegistryInfo" --> +<p>A class to access the type registry. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="contexttyperegistryinfo_8h_source.html">contexttyperegistryinfo.h</a>></code></p> + +<p><a href="class_context_type_registry_info-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#a988d768b9a8fd1dc46db67d2d7af563d">registryPath</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the full path to the registry directory. <a href="#a988d768b9a8fd1dc46db67d2d7af563d"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#a1fe24a4cdfc689ceee6f713b3fe2124a">coreTypesPath</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the full path to the core property declaration file. <a href="#a1fe24a4cdfc689ceee6f713b3fe2124a"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_assoc_tree.html">AssocTree</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#a20121b701a3d3293e99804ca5841d36e">typeDefinitionForName</a> (QString name)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a type definition for the type with the given name. <a href="#a20121b701a3d3293e99804ca5841d36e"></a><br/></td></tr> +<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_context_type_registry_info.html">ContextTypeRegistryInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#a5c2ab7a27488ddcb0d486904b37b4e02">instance</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the singleton instance of the <a class="el" href="class_context_type_registry_info.html" title="A class to access the type registry.">ContextTypeRegistryInfo</a>. <a href="#a5c2ab7a27488ddcb0d486904b37b4e02"></a><br/></td></tr> +<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#a1ed1dabebbe6336324f5e6c9a031c185">ContextTypeRegistryInfo</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Private constructor. Do not use. <a href="#a1ed1dabebbe6336324f5e6c9a031c185"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#a5344c1f657439f0c240e1cf8df9f9743">ContextTypeRegistryInfo</a> (const <a class="el" href="class_context_type_registry_info.html">ContextTypeRegistryInfo</a> &)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Private constructor. Do not use. <a href="#a5344c1f657439f0c240e1cf8df9f9743"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_context_type_registry_info.html">ContextTypeRegistryInfo</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#aed28e0db18d12acc7ac5cc996c34f2f3">operator=</a> (const <a class="el" href="class_context_type_registry_info.html">ContextTypeRegistryInfo</a> &)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Private operator. Do not use. <a href="#aed28e0db18d12acc7ac5cc996c34f2f3"></a><br/></td></tr> +<tr><td colspan="2"><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_assoc_tree.html">AssocTree</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#ab8412d6fdc61f2a6bf33370f23b9d798">coreTree</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The core.types as <a class="el" href="class_assoc_tree.html">AssocTree</a>. Read on construction. <a href="#ab8412d6fdc61f2a6bf33370f23b9d798"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QHash< QString, <a class="el" href="class_assoc_tree.html">AssocTree</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#a7800d06cfcdcb9e6862f4bdf4729a3e5">typeCache</a></td></tr> +<tr><td colspan="2"><h2>Static Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_context_type_registry_info.html">ContextTypeRegistryInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#a8a076bbf240be4a82fd98770c1927d83">registryInstance</a> = NULL</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the actual pointer to the singleton instance. <a href="#a8a076bbf240be4a82fd98770c1927d83"></a><br/></td></tr> +<tr><td colspan="2"><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_type_registry_info.html#ac8de3e69b61de37a62ff1e706adcad18">ContextTypeRegistryInfoUnitTest</a></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>A class to access the type registry. </p> +<p>This is a singelton class used to obtain information about the core types defined in the type registry. Information is provided as type definitions returned as <a class="el" href="class_assoc_tree.html">AssocTree</a> instances. Each type definition is a QVariant tree wrapped in <a class="el" href="class_assoc_tree.html">AssocTree</a> for easy helper key accessors.</p> +<h2><a class="anchor" id="Usage"> +Usage</a></h2> +<p>To obtain a type definition for a given type:</p> +<div class="fragment"><pre class="fragment"> <a class="code" href="class_assoc_tree.html">AssocTree</a> typeDefinition = <a class="code" href="class_context_type_registry_info.html#a5c2ab7a27488ddcb0d486904b37b4e02" title="Returns the singleton instance of the ContextTypeRegistryInfo.">ContextTypeRegistryInfo::instance</a>()-><a class="code" href="class_context_type_registry_info.html#a20121b701a3d3293e99804ca5841d36e" title="Returns a type definition for the type with the given name.">typeDefinitionForName</a>(<span class="stringliteral">"string-enum"</span>); +</pre></div><p>Unless you're building a dedicated type-introspection application, you don't want to deal with <a class="el" href="class_context_type_registry_info.html" title="A class to access the type registry.">ContextTypeRegistryInfo</a> directly. Instead, you can use the <a class="el" href="class_context_type_info.html">ContextTypeInfo</a> class to fetch concrete types and use the easy accessors provided there. </p> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a1ed1dabebbe6336324f5e6c9a031c185"></a><!-- doxytag: member="ContextTypeRegistryInfo::ContextTypeRegistryInfo" ref="a1ed1dabebbe6336324f5e6c9a031c185" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextTypeRegistryInfo::ContextTypeRegistryInfo </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Private constructor. Do not use. </p> + +</div> +</div> +<a class="anchor" id="a5344c1f657439f0c240e1cf8df9f9743"></a><!-- doxytag: member="ContextTypeRegistryInfo::ContextTypeRegistryInfo" ref="a5344c1f657439f0c240e1cf8df9f9743" args="(const ContextTypeRegistryInfo &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextTypeRegistryInfo::ContextTypeRegistryInfo </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_context_type_registry_info.html">ContextTypeRegistryInfo</a> & </td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Private constructor. Do not use. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a1fe24a4cdfc689ceee6f713b3fe2124a"></a><!-- doxytag: member="ContextTypeRegistryInfo::coreTypesPath" ref="a1fe24a4cdfc689ceee6f713b3fe2124a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString ContextTypeRegistryInfo::coreTypesPath </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns the full path to the core property declaration file. </p> +<p>Takes the <code>CONTEXT_CORE_TYPES</code> env variable into account. </p> + +</div> +</div> +<a class="anchor" id="a5c2ab7a27488ddcb0d486904b37b4e02"></a><!-- doxytag: member="ContextTypeRegistryInfo::instance" ref="a5c2ab7a27488ddcb0d486904b37b4e02" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_context_type_registry_info.html">ContextTypeRegistryInfo</a> * ContextTypeRegistryInfo::instance </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns the singleton instance of the <a class="el" href="class_context_type_registry_info.html" title="A class to access the type registry.">ContextTypeRegistryInfo</a>. </p> +<p>The object is constructed automaticall on first access. </p> + +</div> +</div> +<a class="anchor" id="aed28e0db18d12acc7ac5cc996c34f2f3"></a><!-- doxytag: member="ContextTypeRegistryInfo::operator=" ref="aed28e0db18d12acc7ac5cc996c34f2f3" args="(const ContextTypeRegistryInfo &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_context_type_registry_info.html">ContextTypeRegistryInfo</a>& ContextTypeRegistryInfo::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_context_type_registry_info.html">ContextTypeRegistryInfo</a> & </td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Private operator. Do not use. </p> + +</div> +</div> +<a class="anchor" id="a988d768b9a8fd1dc46db67d2d7af563d"></a><!-- doxytag: member="ContextTypeRegistryInfo::registryPath" ref="a988d768b9a8fd1dc46db67d2d7af563d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString ContextTypeRegistryInfo::registryPath </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns the full path to the registry directory. </p> +<p>Takes the <code>CONTEXT_TYPES</code> env variable into account. </p> + +</div> +</div> +<a class="anchor" id="a20121b701a3d3293e99804ca5841d36e"></a><!-- doxytag: member="ContextTypeRegistryInfo::typeDefinitionForName" ref="a20121b701a3d3293e99804ca5841d36e" args="(QString name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_assoc_tree.html">AssocTree</a> ContextTypeRegistryInfo::typeDefinitionForName </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>name</em></td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns a type definition for the type with the given name. </p> +<p>The type is being fetched from the registry. </p> + +</div> +</div> +<hr/><h2>Friends And Related Function Documentation</h2> +<a class="anchor" id="ac8de3e69b61de37a62ff1e706adcad18"></a><!-- doxytag: member="ContextTypeRegistryInfo::ContextTypeRegistryInfoUnitTest" ref="ac8de3e69b61de37a62ff1e706adcad18" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class ContextTypeRegistryInfoUnitTest<code> [friend]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="ab8412d6fdc61f2a6bf33370f23b9d798"></a><!-- doxytag: member="ContextTypeRegistryInfo::coreTree" ref="ab8412d6fdc61f2a6bf33370f23b9d798" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_assoc_tree.html">AssocTree</a> <a class="el" href="class_context_type_registry_info.html#ab8412d6fdc61f2a6bf33370f23b9d798">ContextTypeRegistryInfo::coreTree</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The core.types as <a class="el" href="class_assoc_tree.html">AssocTree</a>. Read on construction. </p> + +</div> +</div> +<a class="anchor" id="a8a076bbf240be4a82fd98770c1927d83"></a><!-- doxytag: member="ContextTypeRegistryInfo::registryInstance" ref="a8a076bbf240be4a82fd98770c1927d83" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_context_type_registry_info.html">ContextTypeRegistryInfo</a> * <a class="el" href="class_context_type_registry_info.html#a8a076bbf240be4a82fd98770c1927d83">ContextTypeRegistryInfo::registryInstance</a> = NULL<code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Holds the actual pointer to the singleton instance. </p> +<p>Mutex protected during creation. </p> + +</div> +</div> +<a class="anchor" id="a7800d06cfcdcb9e6862f4bdf4729a3e5"></a><!-- doxytag: member="ContextTypeRegistryInfo::typeCache" ref="a7800d06cfcdcb9e6862f4bdf4729a3e5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QHash<QString, <a class="el" href="class_assoc_tree.html">AssocTree</a>> <a class="el" href="class_context_type_registry_info.html#a7800d06cfcdcb9e6862f4bdf4729a3e5">ContextTypeRegistryInfo::typeCache</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="contexttyperegistryinfo_8h_source.html">contexttyperegistryinfo.h</a></li> +<li><a class="el" href="contexttyperegistryinfo_8cpp.html">contexttyperegistryinfo.cpp</a></li> +</ul> +</div> +<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Dec 10 16:51:58 2009 for libcontextsubscriber by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |