docs/module-doc/channels_8h.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>channels.h File Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc3 -->
   7 <center>
   8 <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>
   9 <hr><h1>channels.h File Reference</h1><code>#include "inspircd_config.h"</code><br>
  10 <code>#include "<a class="el" href="base_8h-source.html">base.h</a>"</code><br>
  11 <code>#include &lt;time.h&gt;</code><br>
  12 <code>#include &lt;vector&gt;</code><br>
  13 <code>#include &lt;string&gt;</code><br>
  14
  15 <p>
  16 Include dependency graph for channels.h:<p><center><img src="channels_8h__incl.gif" border="0" usemap="#channels.h_map" alt="Include dependency graph"></center>
  17 <map name="channels.h_map">
  18 <area href="base_8h.html" shape="rect" coords="88,85,136,106" alt="">
  19 </map>
  20
  21 <p>
  22 This graph shows which files directly or indirectly include this file:<p><center><img src="channels_8h__dep__incl.gif" border="0" usemap="#channels.hdep_map" alt="Included by dependency graph"></center>
  23 <map name="channels.hdep_map">
  24 <area href="channels_8cpp.html" shape="rect" coords="7,155,95,176" alt="">
  25 <area href="users_8cpp.html" shape="rect" coords="48,86,115,107" alt="">
  26 <area href="users_8h.html" shape="rect" coords="220,155,271,176" alt="">
  27 <area href="commands_8h.html" shape="rect" coords="139,86,221,107" alt="">
  28 <area href="modules_8cpp.html" shape="rect" coords="240,16,323,38" alt="">
  29 <area href="message_8h.html" shape="rect" coords="245,86,317,107" alt="">
  30 <area href="mode_8h.html" shape="rect" coords="341,86,392,107" alt="">
  31 <area href="xline_8h.html" shape="rect" coords="416,86,464,107" alt="">
  32 </map>
  33
  34 <p>
  35 <a href="channels_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  36 <tr><td></td></tr>
  37 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
  38 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classBanItem.html">BanItem</a></td></tr>
  39 <tr><td>&nbsp;</td><td><font size=-1><em>A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel bans (+b).</em> <a href="classBanItem.html#_details">More...</a><em></em></font><br><br></td></tr>
  40 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html">chanrec</a></td></tr>
  41 <tr><td>&nbsp;</td><td><font size=-1><em>Holds all relevent information for a channel.</em> <a href="classchanrec.html#_details">More...</a><em></em></font><br><br></td></tr>
  42 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classExemptItem.html">ExemptItem</a></td></tr>
  43 <tr><td>&nbsp;</td><td><font size=-1><em>A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel exempts (+e).</em> <a href="classExemptItem.html#_details">More...</a><em></em></font><br><br></td></tr>
  44 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classHostItem.html">HostItem</a></td></tr>
  45 <tr><td>&nbsp;</td><td><font size=-1><em>Holds an entry for a ban list, exemption list, or invite list.</em> <a href="classHostItem.html#_details">More...</a><em></em></font><br><br></td></tr>
  46 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classInviteItem.html">InviteItem</a></td></tr>
  47 <tr><td>&nbsp;</td><td><font size=-1><em>A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel invites (+I).</em> <a href="classInviteItem.html#_details">More...</a><em></em></font><br><br></td></tr>
  48 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classModeParameter.html">ModeParameter</a></td></tr>
  49 <tr><td>&nbsp;</td><td><font size=-1><em>Holds a custom parameter to a module-defined channel mode e.g.</em> <a href="classModeParameter.html#_details">More...</a><em></em></font><br><br></td></tr>
  50 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classucrec.html">ucrec</a></td></tr>
  51 <tr><td>&nbsp;</td><td><font size=-1><em>Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class.</em> <a href="classucrec.html#_details">More...</a><em></em></font><br><br></td></tr>
  52 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  53 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="channels_8h.html#a0">UCMODE_OP</a>&nbsp;&nbsp;&nbsp;1</td></tr>
  54 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="channels_8h.html#a1">UCMODE_VOICE</a>&nbsp;&nbsp;&nbsp;2</td></tr>
  55 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="channels_8h.html#a2">UCMODE_HOP</a>&nbsp;&nbsp;&nbsp;4</td></tr>
  56 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="channels_8h.html#a3">UCMODE_PROTECT</a>&nbsp;&nbsp;&nbsp;8</td></tr>
  57 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="channels_8h.html#a4">UCMODE_FOUNDER</a>&nbsp;&nbsp;&nbsp;16</td></tr>
  58 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  59 <tr><td nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classBanItem.html">BanItem</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="channels_8h.html#a5">BanList</a></td></tr>
  60 <tr><td>&nbsp;</td><td><font size=-1><em>Holds a complete ban list.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
  61 <tr><td nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classExemptItem.html">ExemptItem</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="channels_8h.html#a6">ExemptList</a></td></tr>
  62 <tr><td>&nbsp;</td><td><font size=-1><em>Holds a complete exempt list.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
  63 <tr><td nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classInviteItem.html">InviteItem</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="channels_8h.html#a7">InviteList</a></td></tr>
  64 <tr><td>&nbsp;</td><td><font size=-1><em>Holds a complete invite list.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
  65 </table>
  66 <hr><h2>Define Documentation</h2>
  67 <a name="a4" doxytag="channels.h::UCMODE_FOUNDER"></a><p>
  68 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  69   <tr>
  70     <td class="md">
  71       <table cellpadding="0" cellspacing="0" border="0">
  72         <tr>
  73           <td class="md" nowrap valign="top"> #define UCMODE_FOUNDER&nbsp;&nbsp;&nbsp;16
  74       </table>
  75     </td>
  76   </tr>
  77 </table>
  78 <table cellspacing=5 cellpadding=0 border=0>
  79   <tr>
  80     <td>
  81       &nbsp;
  82     </td>
  83     <td>
  84
  85 <p>
  86
  87 <p>
  88 Definition at line <a class="el" href="channels_8h-source.html#l00184">184</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
  89   </tr>
  90 </table>
  91 <a name="a2" doxytag="channels.h::UCMODE_HOP"></a><p>
  92 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  93   <tr>
  94     <td class="md">
  95       <table cellpadding="0" cellspacing="0" border="0">
  96         <tr>
  97           <td class="md" nowrap valign="top"> #define UCMODE_HOP&nbsp;&nbsp;&nbsp;4
  98       </table>
  99     </td>
 100   </tr>
 101 </table>
 102 <table cellspacing=5 cellpadding=0 border=0>
 103   <tr>
 104     <td>
 105       &nbsp;
 106     </td>
 107     <td>
 108
 109 <p>
 110
 111 <p>
 112 Definition at line <a class="el" href="channels_8h-source.html#l00182">182</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 113   </tr>
 114 </table>
 115 <a name="a0" doxytag="channels.h::UCMODE_OP"></a><p>
 116 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 117   <tr>
 118     <td class="md">
 119       <table cellpadding="0" cellspacing="0" border="0">
 120         <tr>
 121           <td class="md" nowrap valign="top"> #define UCMODE_OP&nbsp;&nbsp;&nbsp;1
 122       </table>
 123     </td>
 124   </tr>
 125 </table>
 126 <table cellspacing=5 cellpadding=0 border=0>
 127   <tr>
 128     <td>
 129       &nbsp;
 130     </td>
 131     <td>
 132
 133 <p>
 134
 135 <p>
 136 Definition at line <a class="el" href="channels_8h-source.html#l00180">180</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 137   </tr>
 138 </table>
 139 <a name="a3" doxytag="channels.h::UCMODE_PROTECT"></a><p>
 140 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 141   <tr>
 142     <td class="md">
 143       <table cellpadding="0" cellspacing="0" border="0">
 144         <tr>
 145           <td class="md" nowrap valign="top"> #define UCMODE_PROTECT&nbsp;&nbsp;&nbsp;8
 146       </table>
 147     </td>
 148   </tr>
 149 </table>
 150 <table cellspacing=5 cellpadding=0 border=0>
 151   <tr>
 152     <td>
 153       &nbsp;
 154     </td>
 155     <td>
 156
 157 <p>
 158
 159 <p>
 160 Definition at line <a class="el" href="channels_8h-source.html#l00183">183</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 161   </tr>
 162 </table>
 163 <a name="a1" doxytag="channels.h::UCMODE_VOICE"></a><p>
 164 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 165   <tr>
 166     <td class="md">
 167       <table cellpadding="0" cellspacing="0" border="0">
 168         <tr>
 169           <td class="md" nowrap valign="top"> #define UCMODE_VOICE&nbsp;&nbsp;&nbsp;2
 170       </table>
 171     </td>
 172   </tr>
 173 </table>
 174 <table cellspacing=5 cellpadding=0 border=0>
 175   <tr>
 176     <td>
 177       &nbsp;
 178     </td>
 179     <td>
 180
 181 <p>
 182
 183 <p>
 184 Definition at line <a class="el" href="channels_8h-source.html#l00181">181</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 185   </tr>
 186 </table>
 187 <hr><h2>Typedef Documentation</h2>
 188 <a name="a5" doxytag="channels.h::BanList"></a><p>
 189 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 190   <tr>
 191     <td class="md">
 192       <table cellpadding="0" cellspacing="0" border="0">
 193         <tr>
 194           <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classBanItem.html">BanItem</a>&gt; BanList
 195       </table>
 196     </td>
 197   </tr>
 198 </table>
 199 <table cellspacing=5 cellpadding=0 border=0>
 200   <tr>
 201     <td>
 202       &nbsp;
 203     </td>
 204     <td>
 205
 206 <p>
 207 Holds a complete ban list.
 208 <p>
 209
 210 <p>
 211 Definition at line <a class="el" href="channels_8h-source.html#l00069">69</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 212   </tr>
 213 </table>
 214 <a name="a6" doxytag="channels.h::ExemptList"></a><p>
 215 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 216   <tr>
 217     <td class="md">
 218       <table cellpadding="0" cellspacing="0" border="0">
 219         <tr>
 220           <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classExemptItem.html">ExemptItem</a>&gt; ExemptList
 221       </table>
 222     </td>
 223   </tr>
 224 </table>
 225 <table cellspacing=5 cellpadding=0 border=0>
 226   <tr>
 227     <td>
 228       &nbsp;
 229     </td>
 230     <td>
 231
 232 <p>
 233 Holds a complete exempt list.
 234 <p>
 235
 236 <p>
 237 Definition at line <a class="el" href="channels_8h-source.html#l00073">73</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 238   </tr>
 239 </table>
 240 <a name="a7" doxytag="channels.h::InviteList"></a><p>
 241 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 242   <tr>
 243     <td class="md">
 244       <table cellpadding="0" cellspacing="0" border="0">
 245         <tr>
 246           <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classInviteItem.html">InviteItem</a>&gt; InviteList
 247       </table>
 248     </td>
 249   </tr>
 250 </table>
 251 <table cellspacing=5 cellpadding=0 border=0>
 252   <tr>
 253     <td>
 254       &nbsp;
 255     </td>
 256     <td>
 257
 258 <p>
 259 Holds a complete invite list.
 260 <p>
 261
 262 <p>
 263 Definition at line <a class="el" href="channels_8h-source.html#l00077">77</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
 264   </tr>
 265 </table>
 266 <hr><address style="align: right;"><small>Generated on Sun Apr 25 00:24:07 2004 for InspIRCd by
 267 <a href="http://www.doxygen.org/index.html">
 268 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 269 width=110 height=53></a>1.3-rc3 </small></address>
 270 </body>
 271 </html>