ouch/inspircd
2
0
Fork 0
mirror of https://github.com/inspircd/inspircd.git synced 2025-03-10 19:19:02 -04:00
Code Issues Packages Projects Releases Wiki Activity
inspircd/docs/module-doc/classExtensible.html
brain 1899777c6d Added base.cpp, fixed documentation for userrec::HasPermission 
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@757 e03df62e-2008-0410-955e-edbf42e46eb7
2004-04-30 14:47:34 +00:00

187 lines
9.1 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Extensible class Reference</title>
<link href="inspircd.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3-rc3 -->
<center>
<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>Extensible Class Reference</h1>class Extensible is the parent class of many classes such as userrec and chanrec.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="base_8h-source.html">base.h</a>&gt;</code>
<p>
Inheritance diagram for Extensible:<p><center><img src="classExtensible__inherit__graph.gif" border="0" usemap="#Extensible__inherit__map" alt="Inheritance graph"></center>
<map name="Extensible__inherit__map">
<area href="classchanrec.html" shape="rect" coords="7,155,65,176" alt="">
<area href="classcommand__t.html" shape="rect" coords="89,155,167,176" alt="">
<area href="classconnection.html" shape="rect" coords="191,155,260,176" alt="">
<area href="classircd__connector.html" shape="rect" coords="284,155,380,176" alt="">
<area href="classucrec.html" shape="rect" coords="404,155,449,176" alt="">
<area href="classclassbase.html" shape="rect" coords="192,16,259,38" alt="">
<area href="classserverrec.html" shape="rect" coords="149,224,216,246" alt="">
<area href="classuserrec.html" shape="rect" coords="240,224,296,246" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Extensible:<p><center><img src="classExtensible__coll__graph.gif" border="0" usemap="#Extensible__coll__map" alt="Collaboration graph"></center>
<map name="Extensible__coll__map">
<area href="classclassbase.html" shape="rect" coords="7,107,73,128" alt="">
</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&nbsp;</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>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classExtensible.html#a1">Shrink</a> (std::string key)</td></tr>
<tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="classExtensible.html#a2">GetExt</a> (std::string key)</td></tr>
<tr><td>&nbsp;</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&lt; std::string, <a class="el" href="base_8h.html#a0">VoidPointer</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="classExtensible.html#o0">Extension_Items</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Private data store.</em> <a href="#o0"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
class Extensible is the parent class of many classes such as userrec and chanrec.
<p>
class Extensible implements a system which allows modules to 'extend' the class by attaching data within a map associated with the object. In this way modules can store their own custom information within user objects, channel objects and server objects, without breaking other modules (this is more sensible than using a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and supports arbitary data storage).
<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 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">(&nbsp;</td>
<td class="md" nowrap valign="top">std::string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>key</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="base_8h.html#a0">VoidPointer</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>p</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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">(&nbsp;</td>
<td class="md" nowrap valign="top">std::string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>key</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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">(&nbsp;</td>
<td class="md" nowrap valign="top">std::string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>key</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::map&lt;std::string,<a class="el" href="base_8h.html#a0">VoidPointer</a>&gt; Extensible::Extension_Items<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Private data store.
<p>
<p>
Definition at line <a class="el" href="base_8h-source.html#l00042">42</a> of file <a class="el" href="base_8h-source.html">base.h</a>. </td>
</tr>
</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 Fri Apr 30 15:46:38 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>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink