docs/module-doc/classucrec.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>InspIRCd: ucrec Class Reference</title>
   4 <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.4.4-20050815 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>ucrec Class Reference</h1><!-- doxytag: class="ucrec" --><!-- doxytag: inherits="classbase" -->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.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="channels_8h-source.html">channels.h</a>&gt;</code>
  12 <p>
  13 Inheritance diagram for ucrec:<p><center><img src="classucrec__inherit__graph.gif" border="0" usemap="#ucrec__inherit__map" alt="Inheritance graph"></center>
  14 <map name="ucrec__inherit__map">
  15 <area href="classclassbase.html" shape="rect" coords="7,7,87,34" alt="">
  16 </map>
  17 <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>
  18 <map name="ucrec__coll__map">
  19 <area href="classclassbase.html" shape="rect" coords="7,177,87,204" alt="">
  20 <area href="classchanrec.html" shape="rect" coords="221,177,291,204" alt="">
  21 </map>
  22 <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">
  23 <tr><td></td></tr>
  24 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  25 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classucrec.html#ucrec_28_29">ucrec</a> ()</td></tr>
  26
  27 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classucrec.html#_7Eucrec_28_29">~ucrec</a> ()</td></tr>
  28
  29 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
  30 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classucrec.html#uc_5Fmodes">uc_modes</a></td></tr>
  31
  32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Contains a bitmask of the UCMODE_OP .  <a href="#uc_5Fmodes"></a><br></td></tr>
  33 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classchanrec.html">chanrec</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classucrec.html#channel">channel</a></td></tr>
  34
  35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Points to the channel record where the given modes apply.  <a href="#channel"></a><br></td></tr>
  36 </table>
  37 <hr><a name="_details"></a><h2>Detailed Description</h2>
  38 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.
  39 <p>
  40 The uc_modes member holds a bitmask of which privilages the user has on the channel, such as op, voice, etc.
  41 <p>
  42
  43 <p>
  44 Definition at line <a class="el" href="channels_8h-source.html#l00241">241</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  45 <a class="anchor" name="ucrec_28_29"></a><!-- doxytag: member="ucrec::ucrec" ref="ucrec_28_29" args="()" --><p>
  46 <table class="mdTable" cellpadding="2" cellspacing="0">
  47   <tr>
  48     <td class="mdRow">
  49       <table cellpadding="0" cellspacing="0" border="0">
  50         <tr>
  51           <td class="md" nowrap valign="top">ucrec::ucrec           </td>
  52           <td class="md" valign="top">(&nbsp;</td>
  53           <td class="mdname1" valign="top" nowrap>          </td>
  54           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  55           <td class="md" nowrap><code> [inline]</code></td>
  56         </tr>
  57       </table>
  58     </td>
  59   </tr>
  60 </table>
  61 <table cellspacing="5" cellpadding="0" border="0">
  62   <tr>
  63     <td>
  64       &nbsp;
  65     </td>
  66     <td>
  67
  68 <p>
  69
  70 <p>
  71 Definition at line <a class="el" href="channels_8h-source.html#l00254">254</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<div class="fragment"><pre class="fragment"><a name="l00254"></a>00254 { <span class="comment">/* stub */</span> }
  72 </pre></div>
  73 <p>
  74     </td>
  75   </tr>
  76 </table>
  77 <a class="anchor" name="_7Eucrec_28_29"></a><!-- doxytag: member="ucrec::~ucrec" ref="_7Eucrec_28_29" args="()" --><p>
  78 <table class="mdTable" cellpadding="2" cellspacing="0">
  79   <tr>
  80     <td class="mdRow">
  81       <table cellpadding="0" cellspacing="0" border="0">
  82         <tr>
  83           <td class="md" nowrap valign="top">virtual ucrec::~ucrec           </td>
  84           <td class="md" valign="top">(&nbsp;</td>
  85           <td class="mdname1" valign="top" nowrap>          </td>
  86           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  87           <td class="md" nowrap><code> [inline, virtual]</code></td>
  88         </tr>
  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#l00255">255</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<div class="fragment"><pre class="fragment"><a name="l00255"></a>00255 { <span class="comment">/* stub */</span> }
 104 </pre></div>
 105 <p>
 106     </td>
 107   </tr>
 108 </table>
 109 <hr><h2>Member Data Documentation</h2>
 110 <a class="anchor" name="channel"></a><!-- doxytag: member="ucrec::channel" ref="channel" args="" --><p>
 111 <table class="mdTable" cellpadding="2" cellspacing="0">
 112   <tr>
 113     <td class="mdRow">
 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>* <a class="el" href="classucrec.html#channel">ucrec::channel</a>          </td>
 117         </tr>
 118       </table>
 119     </td>
 120   </tr>
 121 </table>
 122 <table cellspacing="5" cellpadding="0" border="0">
 123   <tr>
 124     <td>
 125       &nbsp;
 126     </td>
 127     <td>
 128
 129 <p>
 130 Points to the channel record where the given modes apply.
 131 <p>
 132 If the record is not in use, this value will be NULL.
 133 <p>
 134 Definition at line <a class="el" href="channels_8h-source.html#l00252">252</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 135 <p>
 136 Referenced by <a class="el" href="modules_8cpp-source.html#l00670">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00033">userrec::userrec()</a>.    </td>
 137   </tr>
 138 </table>
 139 <a class="anchor" name="uc_5Fmodes"></a><!-- doxytag: member="ucrec::uc_modes" ref="uc_5Fmodes" args="" --><p>
 140 <table class="mdTable" cellpadding="2" cellspacing="0">
 141   <tr>
 142     <td class="mdRow">
 143       <table cellpadding="0" cellspacing="0" border="0">
 144         <tr>
 145           <td class="md" nowrap valign="top">char <a class="el" href="classucrec.html#uc_5Fmodes">ucrec::uc_modes</a>          </td>
 146         </tr>
 147       </table>
 148     </td>
 149   </tr>
 150 </table>
 151 <table cellspacing="5" cellpadding="0" border="0">
 152   <tr>
 153     <td>
 154       &nbsp;
 155     </td>
 156     <td>
 157
 158 <p>
 159 Contains a bitmask of the UCMODE_OP .
 160 <p>
 161 .. UCMODE_FOUNDER values. If this value is zero, the user has no privilages upon the channel.
 162 <p>
 163 Definition at line <a class="el" href="channels_8h-source.html#l00247">247</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 164 <p>
 165 Referenced by <a class="el" href="users_8cpp-source.html#l00033">userrec::userrec()</a>.    </td>
 166   </tr>
 167 </table>
 168 <hr>The documentation for this class was generated from the following file:<ul>
 169 <li><a class="el" href="channels_8h-source.html">channels.h</a></ul>
 170 <hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:26 2005 for InspIRCd by&nbsp;
 171 <a href="http://www.doxygen.org/index.html">
 172 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 173 </body>
 174 </html>