docs/module-doc/classucrec.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>ucrec class 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>ucrec Class Reference</h1>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.
  10 <a href="#_details">More...</a>
  11 <p>
  12 <code>#include &lt;<a class="el" href="channels_8h-source.html">channels.h</a>&gt;</code>
  13 <p>
  14 Inheritance diagram for ucrec:<p><center><img src="classucrec__inherit__graph.gif" border="0" usemap="#ucrec__inherit__map" alt="Inheritance graph"></center>
  15 <map name="ucrec__inherit__map">
  16 <area href="classExtensible.html" shape="rect" coords="7,85,76,106" alt="">
  17 <area href="classclassbase.html" shape="rect" coords="8,16,75,37" alt="">
  18 </map>
  19 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ucrec:<p><center><img src="classucrec__coll__graph.gif" border="0" usemap="#ucrec__coll__map" alt="Collaboration graph"></center>
  20 <map name="ucrec__coll__map">
  21 <area href="classExtensible.html" shape="rect" coords="19,16,88,37" alt="">
  22 <area href="classchanrec.html" shape="rect" coords="69,107,128,128" alt="">
  23 </map>
  24 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classucrec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  25 <tr><td></td></tr>
  26 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  27 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classucrec.html#a0">ucrec</a> ()</td></tr>
  28 <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classucrec.html#a1">~ucrec</a> ()</td></tr>
  29 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  30 <tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classucrec.html#m0">uc_modes</a></td></tr>
  31 <tr><td>&nbsp;</td><td><font size=-1><em>Contains a bitmask of the UCMODE_OP ...</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
  32 <tr><td nowrap align=right valign=top><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td><td valign=bottom><a class="el" href="classucrec.html#m1">channel</a></td></tr>
  33 <tr><td>&nbsp;</td><td><font size=-1><em>Points to the channel record where the given modes apply.</em> <a href="#m1"></a><em></em></font><br><br></td></tr>
  34 </table>
  35 <hr><a name="_details"></a><h2>Detailed Description</h2>
  36 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.
  37 <p>
  38 The uc_modes member holds a bitmask of which privilages the user has on the channel, such as op, voice, etc.
  39 <p>
  40
  41 <p>
  42 Definition at line <a class="el" href="channels_8h-source.html#l00191">191</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  43 <a name="a0" doxytag="ucrec::ucrec"></a><p>
  44 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  45   <tr>
  46     <td class="md">
  47       <table cellpadding="0" cellspacing="0" border="0">
  48         <tr>
  49           <td class="md" nowrap valign="top"> ucrec::ucrec </td>
  50           <td class="md" valign="top">(&nbsp;</td>
  51           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  52           <td class="md" valign="top">)&nbsp;</td>
  53           <td class="md" nowrap><code> [inline]</code></td>
  54         </tr>
  55
  56       </table>
  57     </td>
  58   </tr>
  59 </table>
  60 <table cellspacing=5 cellpadding=0 border=0>
  61   <tr>
  62     <td>
  63       &nbsp;
  64     </td>
  65     <td>
  66
  67 <p>
  68
  69 <p>
  70 Definition at line <a class="el" href="channels_8h-source.html#l00204">204</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
  71 <p>
  72 <div class="fragment"><pre>00204 { <span class="comment">/* stub */</span> }
  73 </pre></div>    </td>
  74   </tr>
  75 </table>
  76 <a name="a1" doxytag="ucrec::~ucrec"></a><p>
  77 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  78   <tr>
  79     <td class="md">
  80       <table cellpadding="0" cellspacing="0" border="0">
  81         <tr>
  82           <td class="md" nowrap valign="top"> virtual ucrec::~ucrec </td>
  83           <td class="md" valign="top">(&nbsp;</td>
  84           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  85           <td class="md" valign="top">)&nbsp;</td>
  86           <td class="md" nowrap><code> [inline, virtual]</code></td>
  87         </tr>
  88
  89       </table>
  90     </td>
  91   </tr>
  92 </table>
  93 <table cellspacing=5 cellpadding=0 border=0>
  94   <tr>
  95     <td>
  96       &nbsp;
  97     </td>
  98     <td>
  99
 100 <p>
 101
 102 <p>
 103 Definition at line <a class="el" href="channels_8h-source.html#l00205">205</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 104 <p>
 105 <div class="fragment"><pre>00205 { <span class="comment">/* stub */</span> }
 106 </pre></div>    </td>
 107   </tr>
 108 </table>
 109 <hr><h2>Member Data Documentation</h2>
 110 <a name="m1" doxytag="ucrec::channel"></a><p>
 111 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 112   <tr>
 113     <td class="md">
 114       <table cellpadding="0" cellspacing="0" border="0">
 115         <tr>
 116           <td class="md" nowrap valign="top"> <a class="el" href="classchanrec.html">chanrec</a>* ucrec::channel
 117       </table>
 118     </td>
 119   </tr>
 120 </table>
 121 <table cellspacing=5 cellpadding=0 border=0>
 122   <tr>
 123     <td>
 124       &nbsp;
 125     </td>
 126     <td>
 127
 128 <p>
 129 Points to the channel record where the given modes apply.
 130 <p>
 131 If the record is not in use, this value will be NULL.
 132 <p>
 133 Definition at line <a class="el" href="channels_8h-source.html#l00202">202</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 134 <p>
 135 Referenced by <a class="el" href="users_8cpp-source.html#l00013">userrec::userrec()</a>.    </td>
 136   </tr>
 137 </table>
 138 <a name="m0" doxytag="ucrec::uc_modes"></a><p>
 139 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 140   <tr>
 141     <td class="md">
 142       <table cellpadding="0" cellspacing="0" border="0">
 143         <tr>
 144           <td class="md" nowrap valign="top"> long ucrec::uc_modes
 145       </table>
 146     </td>
 147   </tr>
 148 </table>
 149 <table cellspacing=5 cellpadding=0 border=0>
 150   <tr>
 151     <td>
 152       &nbsp;
 153     </td>
 154     <td>
 155
 156 <p>
 157 Contains a bitmask of the UCMODE_OP ...
 158 <p>
 159 UCMODE_FOUNDER values. If this value is zero, the user has no privilages upon the channel.
 160 <p>
 161 Definition at line <a class="el" href="channels_8h-source.html#l00197">197</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 162 <p>
 163 Referenced by <a class="el" href="users_8cpp-source.html#l00013">userrec::userrec()</a>.    </td>
 164   </tr>
 165 </table>
 166 <hr>The documentation for this class was generated from the following file:<ul>
 167 <li><a class="el" href="channels_8h-source.html">channels.h</a></ul>
 168 <hr><address style="align: right;"><small>Generated on Sat May 1 13:39:26 2004 for InspIRCd by
 169 <a href="http://www.doxygen.org/index.html">
 170 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 171 width=110 height=53></a>1.3-rc3 </small></address>
 172 </body>
 173 </html>