docs/module-doc/classModeParameter.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>InspIRCd: ModeParameter class Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   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">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>ModeParameter Class Reference</h1>Holds a custom parameter to a module-defined channel mode e.g.
   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 ModeParameter:<p><center><img src="classModeParameter__inherit__graph.gif" border="0" usemap="#ModeParameter__inherit__map" alt="Inheritance graph"></center>
  14 <map name="ModeParameter__inherit__map">
  15 <area href="classclassbase.html" shape="rect" coords="26,7,106,34" alt="">
  16 </map>
  17 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ModeParameter:<p><center><img src="classModeParameter__coll__graph.gif" border="0" usemap="#ModeParameter__coll__map" alt="Collaboration graph"></center>
  18 <map name="ModeParameter__coll__map">
  19 <area href="classclassbase.html" shape="rect" coords="7,98,87,125" alt="">
  20 </map>
  21 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classModeParameter-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  22 <tr><td></td></tr>
  23 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  24 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModeParameter.html#o0">mode</a></td></tr>
  25
  26 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModeParameter.html#o1">parameter</a> [MAXBUF]</td></tr>
  27
  28 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModeParameter.html#o2">channel</a> [CHANMAX]</td></tr>
  29
  30 </table>
  31 <hr><a name="_details"></a><h2>Detailed Description</h2>
  32 Holds a custom parameter to a module-defined channel mode e.g.
  33 <p>
  34 for +L this would hold the channel name.
  35 <p>
  36
  37 <p>
  38 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>.<hr><h2>Member Data Documentation</h2>
  39 <a name="o2" doxytag="ModeParameter::channel"></a><p>
  40 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  41   <tr>
  42     <td class="mdRow">
  43       <table cellpadding="0" cellspacing="0" border="0">
  44         <tr>
  45           <td class="md" nowrap valign="top"> char <a class="el" href="classModeParameter.html#o2">ModeParameter::channel</a>[CHANMAX]
  46       </table>
  47     </td>
  48   </tr>
  49 </table>
  50 <table cellspacing=5 cellpadding=0 border=0>
  51   <tr>
  52     <td>
  53       &nbsp;
  54     </td>
  55     <td>
  56
  57 <p>
  58
  59 <p>
  60 Definition at line <a class="el" href="channels_8h-source.html#l00082">82</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
  61 <p>
  62 Referenced by <a class="el" href="channels_8cpp-source.html#l00150">chanrec::SetCustomModeParam()</a>.    </td>
  63   </tr>
  64 </table>
  65 <a name="o0" doxytag="ModeParameter::mode"></a><p>
  66 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  67   <tr>
  68     <td class="mdRow">
  69       <table cellpadding="0" cellspacing="0" border="0">
  70         <tr>
  71           <td class="md" nowrap valign="top"> char <a class="el" href="classModeParameter.html#o0">ModeParameter::mode</a>
  72       </table>
  73     </td>
  74   </tr>
  75 </table>
  76 <table cellspacing=5 cellpadding=0 border=0>
  77   <tr>
  78     <td>
  79       &nbsp;
  80     </td>
  81     <td>
  82
  83 <p>
  84
  85 <p>
  86 Definition at line <a class="el" href="channels_8h-source.html#l00080">80</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
  87 <p>
  88 Referenced by <a class="el" href="channels_8cpp-source.html#l00150">chanrec::SetCustomModeParam()</a>.    </td>
  89   </tr>
  90 </table>
  91 <a name="o1" doxytag="ModeParameter::parameter"></a><p>
  92 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  93   <tr>
  94     <td class="mdRow">
  95       <table cellpadding="0" cellspacing="0" border="0">
  96         <tr>
  97           <td class="md" nowrap valign="top"> char <a class="el" href="classModeParameter.html#o1">ModeParameter::parameter</a>[MAXBUF]
  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#l00081">81</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 113 <p>
 114 Referenced by <a class="el" href="channels_8cpp-source.html#l00150">chanrec::SetCustomModeParam()</a>.    </td>
 115   </tr>
 116 </table>
 117 <hr>The documentation for this class was generated from the following file:<ul>
 118 <li><a class="el" href="channels_8h-source.html">channels.h</a></ul>
 119 <hr size="1"><address style="align: right;"><small>Generated on Fri May 13 01:59:52 2005 for InspIRCd by
 120 <a href="http://www.doxygen.org/index.html">
 121 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 122 </a>1.3.3 </small></address>
 123 </body>
 124 </html>