docs/module-doc/classAdmin.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>Admin 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>Admin Class Reference</h1>Holds /ADMIN data This class contains the admin details of the local server.
  10 <a href="#_details">More...</a>
  11 <p>
  12 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
  13 <p>
  14 Inheritance diagram for Admin:<p><center><img src="classAdmin__inherit__graph.gif" border="0" usemap="#Admin__inherit__map" alt="Inheritance graph"></center>
  15 <map name="Admin__inherit__map">
  16 <area href="classclassbase.html" shape="rect" coords="7,16,73,37" alt="">
  17 </map>
  18 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Admin:<p><center><img src="classAdmin__coll__graph.gif" border="0" usemap="#Admin__coll__map" alt="Collaboration graph"></center>
  19 <map name="Admin__coll__map">
  20 <area href="classclassbase.html" shape="rect" coords="7,107,73,128" alt="">
  21 </map>
  22 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classAdmin-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 nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html#a0">Admin</a> (std::string name, std::string email, std::string nick)</td></tr>
  26 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  27 <tr><td nowrap align=right valign=top>const std::string&nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html#m0">Name</a></td></tr>
  28 <tr><td nowrap align=right valign=top>const std::string&nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html#m1">Email</a></td></tr>
  29 <tr><td nowrap align=right valign=top>const std::string&nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html#m2">Nick</a></td></tr>
  30 </table>
  31 <hr><a name="_details"></a><h2>Detailed Description</h2>
  32 Holds /ADMIN data This class contains the admin details of the local server.
  33 <p>
  34 It is constructed by class <a class="el" href="classServer.html">Server</a>, and has three read-only values, Name, Email and Nick that contain the specified values for the server where the module is running.
  35 <p>
  36
  37 <p>
  38 Definition at line <a class="el" href="modules_8h-source.html#l00080">80</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  39 <a name="a0" doxytag="Admin::Admin"></a><p>
  40 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  41   <tr>
  42     <td class="md">
  43       <table cellpadding="0" cellspacing="0" border="0">
  44         <tr>
  45           <td class="md" nowrap valign="top"> Admin::Admin </td>
  46           <td class="md" valign="top">(&nbsp;</td>
  47           <td class="md" nowrap valign="top">std::string&nbsp;</td>
  48           <td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
  49         </tr>
  50         <tr>
  51           <td></td>
  52           <td></td>
  53           <td class="md" nowrap>std::string&nbsp;</td>
  54           <td class="mdname" nowrap>&nbsp; <em>email</em>, </td>
  55         </tr>
  56         <tr>
  57           <td></td>
  58           <td></td>
  59           <td class="md" nowrap>std::string&nbsp;</td>
  60           <td class="mdname" nowrap>&nbsp; <em>nick</em></td>
  61         </tr>
  62         <tr>
  63           <td></td>
  64           <td class="md">)&nbsp;</td>
  65           <td class="md" colspan="2"></td>
  66         </tr>
  67
  68       </table>
  69     </td>
  70   </tr>
  71 </table>
  72 <table cellspacing=5 cellpadding=0 border=0>
  73   <tr>
  74     <td>
  75       &nbsp;
  76     </td>
  77     <td>
  78
  79 <p>
  80
  81 <p>
  82 Definition at line <a class="el" href="modules_8cpp-source.html#l00109">109</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
  83 <p>
  84 <div class="fragment"><pre>00109 : <a class="code" href="classAdmin.html#m0">Name</a>(name), <a class="code" href="classAdmin.html#m1">Email</a>(email), <a class="code" href="classAdmin.html#m2">Nick</a>(nick) { };
  85 </pre></div>    </td>
  86   </tr>
  87 </table>
  88 <hr><h2>Member Data Documentation</h2>
  89 <a name="m1" doxytag="Admin::Email"></a><p>
  90 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  91   <tr>
  92     <td class="md">
  93       <table cellpadding="0" cellspacing="0" border="0">
  94         <tr>
  95           <td class="md" nowrap valign="top"> const std::string Admin::Email
  96       </table>
  97     </td>
  98   </tr>
  99 </table>
 100 <table cellspacing=5 cellpadding=0 border=0>
 101   <tr>
 102     <td>
 103       &nbsp;
 104     </td>
 105     <td>
 106
 107 <p>
 108
 109 <p>
 110 Definition at line <a class="el" href="modules_8h-source.html#l00083">83</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 111   </tr>
 112 </table>
 113 <a name="m0" doxytag="Admin::Name"></a><p>
 114 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 115   <tr>
 116     <td class="md">
 117       <table cellpadding="0" cellspacing="0" border="0">
 118         <tr>
 119           <td class="md" nowrap valign="top"> const std::string Admin::Name
 120       </table>
 121     </td>
 122   </tr>
 123 </table>
 124 <table cellspacing=5 cellpadding=0 border=0>
 125   <tr>
 126     <td>
 127       &nbsp;
 128     </td>
 129     <td>
 130
 131 <p>
 132
 133 <p>
 134 Definition at line <a class="el" href="modules_8h-source.html#l00083">83</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 135   </tr>
 136 </table>
 137 <a name="m2" doxytag="Admin::Nick"></a><p>
 138 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 139   <tr>
 140     <td class="md">
 141       <table cellpadding="0" cellspacing="0" border="0">
 142         <tr>
 143           <td class="md" nowrap valign="top"> const std::string Admin::Nick
 144       </table>
 145     </td>
 146   </tr>
 147 </table>
 148 <table cellspacing=5 cellpadding=0 border=0>
 149   <tr>
 150     <td>
 151       &nbsp;
 152     </td>
 153     <td>
 154
 155 <p>
 156
 157 <p>
 158 Definition at line <a class="el" href="modules_8h-source.html#l00083">83</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 159   </tr>
 160 </table>
 161 <hr>The documentation for this class was generated from the following files:<ul>
 162 <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
 163 <hr><address style="align: right;"><small>Generated on Sun Apr 25 00:24:15 2004 for InspIRCd by
 164 <a href="http://www.doxygen.org/index.html">
 165 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 166 width=110 height=53></a>1.3-rc3 </small></address>
 167 </body>
 168 </html>