docs/module-doc/classModeParameter.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: ModeParameter 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>ModeParameter Class Reference</h1><!-- doxytag: class="ModeParameter" --><!-- doxytag: inherits="classbase" -->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,97,87,124" 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#mode">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#parameter_5BMAXBUF_5D">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#channel_5BCHANMAX_5D">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#l00079">79</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Member Data Documentation</h2>
  39 <a class="anchor" name="channel_5BCHANMAX_5D"></a><!-- doxytag: member="ModeParameter::channel" ref="channel_5BCHANMAX_5D" args="[CHANMAX]" --><p>
  40 <table class="mdTable" 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#channel_5BCHANMAX_5D">ModeParameter::channel</a>[CHANMAX]          </td>
  46         </tr>
  47       </table>
  48     </td>
  49   </tr>
  50 </table>
  51 <table cellspacing="5" cellpadding="0" border="0">
  52   <tr>
  53     <td>
  54       &nbsp;
  55     </td>
  56     <td>
  57
  58 <p>
  59
  60 <p>
  61 Definition at line <a class="el" href="channels_8h-source.html#l00084">84</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
  62 <p>
  63 Referenced by <a class="el" href="channels_8cpp-source.html#l00110">chanrec::SetCustomModeParam()</a>.    </td>
  64   </tr>
  65 </table>
  66 <a class="anchor" name="mode"></a><!-- doxytag: member="ModeParameter::mode" ref="mode" args="" --><p>
  67 <table class="mdTable" cellpadding="2" cellspacing="0">
  68   <tr>
  69     <td class="mdRow">
  70       <table cellpadding="0" cellspacing="0" border="0">
  71         <tr>
  72           <td class="md" nowrap valign="top">char <a class="el" href="classModeParameter.html#mode">ModeParameter::mode</a>          </td>
  73         </tr>
  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#l00082">82</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
  89 <p>
  90 Referenced by <a class="el" href="channels_8cpp-source.html#l00110">chanrec::SetCustomModeParam()</a>.    </td>
  91   </tr>
  92 </table>
  93 <a class="anchor" name="parameter_5BMAXBUF_5D"></a><!-- doxytag: member="ModeParameter::parameter" ref="parameter_5BMAXBUF_5D" args="[MAXBUF]" --><p>
  94 <table class="mdTable" cellpadding="2" cellspacing="0">
  95   <tr>
  96     <td class="mdRow">
  97       <table cellpadding="0" cellspacing="0" border="0">
  98         <tr>
  99           <td class="md" nowrap valign="top">char <a class="el" href="classModeParameter.html#parameter_5BMAXBUF_5D">ModeParameter::parameter</a>[MAXBUF]          </td>
 100         </tr>
 101       </table>
 102     </td>
 103   </tr>
 104 </table>
 105 <table cellspacing="5" cellpadding="0" border="0">
 106   <tr>
 107     <td>
 108       &nbsp;
 109     </td>
 110     <td>
 111
 112 <p>
 113
 114 <p>
 115 Definition at line <a class="el" href="channels_8h-source.html#l00083">83</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 116 <p>
 117 Referenced by <a class="el" href="channels_8cpp-source.html#l00110">chanrec::SetCustomModeParam()</a>.    </td>
 118   </tr>
 119 </table>
 120 <hr>The documentation for this class was generated from the following file:<ul>
 121 <li><a class="el" href="channels_8h-source.html">channels.h</a></ul>
 122 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:02:15 2005 for InspIRCd by&nbsp;
 123 <a href="http://www.doxygen.org/index.html">
 124 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 125 </body>
 126 </html>