diff options
Diffstat (limited to 'docs/module-doc/classExtensible.html')
| -rw-r--r-- | docs/module-doc/classExtensible.html | 114 |
1 files changed, 112 insertions, 2 deletions
diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html index ab505f9ed..61543dbed 100644 --- a/docs/module-doc/classExtensible.html +++ b/docs/module-doc/classExtensible.html @@ -28,6 +28,13 @@ Inheritance diagram for Extensible:<p><center><img src="classExtensible__inherit </map> <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classExtensible-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classExtensible.html#a0">Extend</a> (std::string key, <a class="el" href="base_8h.html#a0">VoidPointer</a> p)</td></tr> +<tr><td> </td><td><font size=-1><em>Extend an Extensible class.</em> <a href="#a0"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classExtensible.html#a1">Shrink</a> (std::string key)</td></tr> +<tr><td> </td><td><font size=-1><em>Shrink an Extensible class.</em> <a href="#a1"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="base_8h.html#a0">VoidPointer</a> </td><td valign=bottom><a class="el" href="classExtensible.html#a2">GetExt</a> (std::string key)</td></tr> +<tr><td> </td><td><font size=-1><em>Get an extension item.</em> <a href="#a2"></a><em></em></font><br><br></td></tr> <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> <tr><td nowrap align=right valign=top>std::map< std::string, <a class="el" href="base_8h.html#a0">VoidPointer</a> > </td><td valign=bottom><a class="el" href="classExtensible.html#o0">Extension_Items</a></td></tr> <tr><td> </td><td><font size=-1><em>Private data store.</em> <a href="#o0"></a><em></em></font><br><br></td></tr> @@ -39,7 +46,110 @@ class Extensible implements a system which allows modules to 'extend' the class <p> <p> -Definition at line <a class="el" href="base_8h-source.html#l00038">38</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Member Data Documentation</h2> +Definition at line <a class="el" href="base_8h-source.html#l00038">38</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a0" doxytag="Extensible::Extend"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool Extensible::Extend </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string </td> + <td class="mdname" nowrap> <em>key</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="base_8h.html#a0">VoidPointer</a> </td> + <td class="mdname" nowrap> <em>p</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Extend an Extensible class. +<p> +You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, <a class="el" href="classExtensible.html#a0">Extensible::Extend</a> will return false in this case. On successful extension, Extend returns true. </td> + </tr> +</table> +<a name="a2" doxytag="Extensible::GetExt"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="base_8h.html#a0">VoidPointer</a> Extensible::GetExt </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string </td> + <td class="mdname1" valign="top" nowrap> <em>key</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get an extension item. +<p> +You must provide a key name, which is case sensitive. If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned. </td> + </tr> +</table> +<a name="a1" doxytag="Extensible::Shrink"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool Extensible::Shrink </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string </td> + <td class="mdname1" valign="top" nowrap> <em>key</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Shrink an Extensible class. +<p> +You must provide a key name. The given key name will be removed from the classes data. If you provide a nonexistent key (case is important) then the function will return false. Returns true on success. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> <a name="o0" doxytag="Extensible::Extension_Items"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> @@ -68,7 +178,7 @@ Definition at line <a class="el" href="base_8h-source.html#l00042">42</a> of fil </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="base_8h-source.html">base.h</a></ul> -<hr><address style="align: right;"><small>Generated on Thu Apr 29 16:30:49 2004 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Fri Apr 30 13:23:30 2004 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.3-rc3 </small></address> |