diff options
Diffstat (limited to 'docs/module-doc/classchanrec.html')
| -rw-r--r-- | docs/module-doc/classchanrec.html | 534 |
1 files changed, 534 insertions, 0 deletions
diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html new file mode 100644 index 000000000..bf8299560 --- /dev/null +++ b/docs/module-doc/classchanrec.html @@ -0,0 +1,534 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>chanrec class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3-rc2 --> +<center> +<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> +<hr><h1>chanrec Class Reference</h1>Holds all relevent information for a channel. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="channels_8h-source.html">channels.h</a>></code> +<p> +<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 Methods</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 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> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m1">custom_modes</a> [MAXMODES]</td></tr> +<tr><td> </td><td><font size=-1><em>Custom modes for the channel.</em> <a href="#m1"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m2">topic</a> [MAXBUF]</td></tr> +<tr><td> </td><td><font size=-1><em>Channel topic.</em> <a href="#m2"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classchanrec.html#m3">created</a></td></tr> +<tr><td> </td><td><font size=-1><em>Creation time.</em> <a href="#m3"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classchanrec.html#m4">topicset</a></td></tr> +<tr><td> </td><td><font size=-1><em>Time topic was set.</em> <a href="#m4"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m5">setby</a> [NICKMAX]</td></tr> +<tr><td> </td><td><font size=-1><em>The last user to set the topic.</em> <a href="#m5"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classchanrec.html#m6">limit</a></td></tr> +<tr><td> </td><td><font size=-1><em>Contains the channel user limit.</em> <a href="#m6"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classchanrec.html#m7">key</a> [32]</td></tr> +<tr><td> </td><td><font size=-1><em>Contains the channel key.</em> <a href="#m7"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m8">topiclock</a></td></tr> +<tr><td> </td><td><font size=-1><em>Nonzero if the mode +t is set.</em> <a href="#m8"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m9">noexternal</a></td></tr> +<tr><td> </td><td><font size=-1><em>Nonzero if the mode +n is set.</em> <a href="#m9"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m10">inviteonly</a></td></tr> +<tr><td> </td><td><font size=-1><em>Nonzero if the mode +i is set.</em> <a href="#m10"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m11">moderated</a></td></tr> +<tr><td> </td><td><font size=-1><em>Nonzero if the mode +m is set.</em> <a href="#m11"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m12">secret</a></td></tr> +<tr><td> </td><td><font size=-1><em>Nonzero if the mode +s is set.</em> <a href="#m12"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>short int </td><td valign=bottom><a class="el" href="classchanrec.html#m13">c_private</a></td></tr> +<tr><td> </td><td><font size=-1><em>Nonzero if the mode +p is set.</em> <a href="#m13"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="channels_8h.html#a5">BanList</a> </td><td valign=bottom><a class="el" href="classchanrec.html#m14">bans</a></td></tr> +<tr><td> </td><td><font size=-1><em>The list of all bans set on the channel.</em> <a href="#m14"></a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Holds all relevent information for a channel. +<p> +This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type. +<p> + +<p> +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>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="chanrec::chanrec"></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"> chanrec::chanrec </td> + <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> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a channel record and initialises it with default values. +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00150">150</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +<div class="fragment"><pre>00151 { +00152 strcpy(name,<span class="stringliteral">""</span>); +00153 strcpy(custom_modes,<span class="stringliteral">""</span>); +00154 strcpy(topic,<span class="stringliteral">""</span>); +00155 strcpy(setby,<span class="stringliteral">""</span>); +00156 strcpy(key,<span class="stringliteral">""</span>); +00157 <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; +00158 <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>; +00159 } +</pre></div> </td> + </tr> +</table> +<a name="a1" doxytag="chanrec::~chanrec"></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"> virtual chanrec::~chanrec </td> + <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, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00161">161</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +<div class="fragment"><pre>00161 { <span class="comment">/* stub */</span> } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="m14" doxytag="chanrec::bans"></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"> <a class="el" href="channels_8h.html#a5">BanList</a> chanrec::bans + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The list of all bans set on the channel. +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00146">146</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m13" doxytag="chanrec::c_private"></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"> short int chanrec::c_private + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00142">142</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m3" doxytag="chanrec::created"></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"> time_t chanrec::created + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creation time. +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00098">98</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m1" doxytag="chanrec::custom_modes"></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"> char chanrec::custom_modes[MAXMODES] + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Custom modes for the channel. +<p> +Plugins may use this field in any way they see fit. +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00091">91</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m10" doxytag="chanrec::inviteonly"></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"> short int chanrec::inviteonly + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Nonzero if the mode +i is set. +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00128">128</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m7" doxytag="chanrec::key"></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"> char chanrec::key[32] + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Contains the channel key. +<p> +If this value is an empty string, there is no channel key in place. +<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> + </tr> +</table> +<a name="m6" doxytag="chanrec::limit"></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"> long chanrec::limit + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00111">111</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m11" doxytag="chanrec::moderated"></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"> short int chanrec::moderated + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Nonzero if the mode +m is set. +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00132">132</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m0" doxytag="chanrec::name"></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"> char chanrec::name[CHANMAX] + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The channels name. +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00087">87</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m9" doxytag="chanrec::noexternal"></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"> short int chanrec::noexternal + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Nonzero if the mode +n is set. +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00124">124</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m12" doxytag="chanrec::secret"></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"> short int chanrec::secret + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00137">137</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m5" doxytag="chanrec::setby"></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"> char chanrec::setby[NICKMAX] + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The last user to set the topic. +<p> +If this member is an empty string, no topic was ever set. +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00106">106</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m2" doxytag="chanrec::topic"></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"> char chanrec::topic[MAXBUF] + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Channel topic. +<p> +If this is an empty string, no channel topic is set. +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00095">95</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> + </tr> +</table> +<a name="m8" doxytag="chanrec::topiclock"></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"> short int chanrec::topiclock + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Nonzero if the mode +t 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> + </tr> +</table> +<a name="m4" doxytag="chanrec::topicset"></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"> time_t chanrec::topicset + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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#l00102">102</a> of file <a class="el" href="channels_8h-source.html">channels.h</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 Wed Jan 22 20:56:47 2003 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-rc2 </small></address> +</body> +</html> |