diff options
Diffstat (limited to 'docs/module-doc/classchanrec.html')
| -rw-r--r-- | docs/module-doc/classchanrec.html | 183 |
1 files changed, 153 insertions, 30 deletions
diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index a3e7664aa..725c7b075 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -22,9 +22,13 @@ Inheritance diagram for chanrec:<p><center><img src="classchanrec__inherit__grap <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classchanrec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> -<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classchanrec.html#a0">chanrec</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Creates a channel record and initialises it with default values.</em> <a href="#a0"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classchanrec.html#a1">~chanrec</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classchanrec.html#a0">SetCustomMode</a> (char mode, bool mode_on)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets or unsets a custom mode in the channels info.</em> <a href="#a0"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classchanrec.html#a1">SetCustomModeParam</a> (char mode, char *parameter, bool mode_on)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets or unsets the parameterrs for a custom mode in a channels info.</em> <a href="#a1"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classchanrec.html#a2">chanrec</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Creates a channel record and initialises it with default values.</em> <a href="#a2"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classchanrec.html#a3">~chanrec</a> ()</td></tr> <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m0">name</a> [CHANMAX]</td></tr> <tr><td> </td><td><font size=-1><em>The channels name.</em> <a href="#m0"></a><em></em></font><br><br></td></tr> @@ -65,7 +69,7 @@ This class represents a channel, and contains its name, modes, time created, top <p> Definition at line <a class="el" href="channels_8h-source.html#l00070">70</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> -<a name="a0" doxytag="chanrec::chanrec"></a><p> +<a name="a2" doxytag="chanrec::chanrec"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -75,7 +79,7 @@ Definition at line <a class="el" href="channels_8h-source.html#l00070">70</a> of <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> - <td class="md" nowrap><code> [inline]</code></td> + <td class="md" nowrap></td> </tr> </table> @@ -94,21 +98,23 @@ Creates a channel record and initialises it with default values. <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00138">138</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +Definition at line <a class="el" href="channels_8cpp-source.html#l00006">6</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>. <p> -<div class="fragment"><pre>00139 { -00140 strcpy(name,<span class="stringliteral">""</span>); -00141 strcpy(custom_modes,<span class="stringliteral">""</span>); -00142 strcpy(topic,<span class="stringliteral">""</span>); -00143 strcpy(setby,<span class="stringliteral">""</span>); -00144 strcpy(key,<span class="stringliteral">""</span>); -00145 <a class="code" href="classchanrec.html#m3">created</a> = <a class="code" href="classchanrec.html#m4">topicset</a> = <a class="code" href="classchanrec.html#m6">limit</a> = 0; -00146 <a class="code" href="classchanrec.html#m8">topiclock</a> = <a class="code" href="classchanrec.html#m9">noexternal</a> = <a class="code" href="classchanrec.html#m10">inviteonly</a> = <a class="code" href="classchanrec.html#m11">moderated</a> = <a class="code" href="classchanrec.html#m12">secret</a> = <a class="code" href="classchanrec.html#m13">c_private</a> = <span class="keyword">false</span>; -00147 } +References <a class="el" href="channels_8h-source.html#l00130">c_private</a>, <a class="el" href="channels_8h-source.html#l00086">created</a>, <a class="el" href="channels_8h-source.html#l00116">inviteonly</a>, <a class="el" href="channels_8h-source.html#l00099">limit</a>, <a class="el" href="channels_8h-source.html#l00120">moderated</a>, <a class="el" href="channels_8h-source.html#l00112">noexternal</a>, <a class="el" href="channels_8h-source.html#l00125">secret</a>, <a class="el" href="channels_8h-source.html#l00108">topiclock</a>, and <a class="el" href="channels_8h-source.html#l00090">topicset</a>. +<p> +<div class="fragment"><pre>00007 { +00008 strcpy(name,<span class="stringliteral">""</span>); +00009 strcpy(custom_modes,<span class="stringliteral">""</span>); +00010 strcpy(topic,<span class="stringliteral">""</span>); +00011 strcpy(setby,<span class="stringliteral">""</span>); +00012 strcpy(key,<span class="stringliteral">""</span>); +00013 <a class="code" href="classchanrec.html#m3">created</a> = <a class="code" href="classchanrec.html#m4">topicset</a> = <a class="code" href="classchanrec.html#m6">limit</a> = 0; +00014 <a class="code" href="classchanrec.html#m8">topiclock</a> = <a class="code" href="classchanrec.html#m9">noexternal</a> = <a class="code" href="classchanrec.html#m10">inviteonly</a> = <a class="code" href="classchanrec.html#m11">moderated</a> = <a class="code" href="classchanrec.html#m12">secret</a> = <a class="code" href="classchanrec.html#m13">c_private</a> = <span class="keyword">false</span>; +00015 } </pre></div> </td> </tr> </table> -<a name="a1" doxytag="chanrec::~chanrec"></a><p> +<a name="a3" doxytag="chanrec::~chanrec"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -135,9 +141,108 @@ Definition at line <a class="el" href="channels_8h-source.html#l00138">138</a> o <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00149">149</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +Definition at line <a class="el" href="channels_8h-source.html#l00148">148</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +<div class="fragment"><pre>00148 { <span class="comment">/* stub */</span> } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a0" doxytag="chanrec::SetCustomMode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void chanrec::SetCustomMode </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char </td> + <td class="mdname" nowrap> <em>mode</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>mode_on</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets or unsets a custom mode in the channels info. +<p> + +<p> +Definition at line <a class="el" href="channels_8cpp-source.html#l00017">17</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>. +<p> +<div class="fragment"><pre>00018 { +00019 } +</pre></div> </td> + </tr> +</table> +<a name="a1" doxytag="chanrec::SetCustomModeParam"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void chanrec::SetCustomModeParam </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char </td> + <td class="mdname" nowrap> <em>mode</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>parameter</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>mode_on</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets or unsets the parameterrs for a custom mode in a channels info. +<p> + +<p> +Definition at line <a class="el" href="channels_8cpp-source.html#l00021">21</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>. <p> -<div class="fragment"><pre>00149 { <span class="comment">/* stub */</span> } +<div class="fragment"><pre>00022 { +00023 } </pre></div> </td> </tr> </table> @@ -191,7 +296,9 @@ Nonzero if the mode +p is set. <p> This value cannot be set at the same time as <a class="el" href="classchanrec.html#m12">chanrec::secret</a> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00130">130</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00130">130</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td> </tr> </table> <a name="m3" doxytag="chanrec::created"></a><p> @@ -217,7 +324,9 @@ Creation time. <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00086">86</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00086">86</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td> </tr> </table> <a name="m1" doxytag="chanrec::custom_modes"></a><p> @@ -269,7 +378,9 @@ Nonzero if the mode +i is set. <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00116">116</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00116">116</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td> </tr> </table> <a name="m7" doxytag="chanrec::key"></a><p> @@ -321,7 +432,9 @@ Contains the channel user limit. <p> If this value is zero, there is no limit in place. <p> -Definition at line <a class="el" href="channels_8h-source.html#l00099">99</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00099">99</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td> </tr> </table> <a name="m11" doxytag="chanrec::moderated"></a><p> @@ -347,7 +460,9 @@ Nonzero if the mode +m is set. <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00120">120</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00120">120</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td> </tr> </table> <a name="m0" doxytag="chanrec::name"></a><p> @@ -399,7 +514,9 @@ Nonzero if the mode +n is set. <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00112">112</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00112">112</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td> </tr> </table> <a name="m12" doxytag="chanrec::secret"></a><p> @@ -425,7 +542,9 @@ Nonzero if the mode +s is set. <p> This value cannot be set at the same time as <a class="el" href="classchanrec.html#m13">chanrec::c_private</a> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00125">125</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00125">125</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td> </tr> </table> <a name="m5" doxytag="chanrec::setby"></a><p> @@ -503,7 +622,9 @@ Nonzero if the mode +t is set. <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00108">108</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00108">108</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td> </tr> </table> <a name="m4" doxytag="chanrec::topicset"></a><p> @@ -529,12 +650,14 @@ Time topic was set. <p> If no topic was ever set, this will be equal to <a class="el" href="classchanrec.html#m3">chanrec::created</a> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00090">90</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00090">90</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00006">chanrec()</a>. </td> </tr> </table> -<hr>The documentation for this class was generated from the following file:<ul> -<li><a class="el" href="channels_8h-source.html">channels.h</a></ul> -<hr><address style="align: right;"><small>Generated on Sun Mar 30 19:35:36 2003 for InspIRCd by +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="channels_8h-source.html">channels.h</a><li><a class="el" href="channels_8cpp-source.html">channels.cpp</a></ul> +<hr><address style="align: right;"><small>Generated on Fri Apr 2 13:37:35 2004 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.3-rc3 </small></address> |