From 73b9d0c5cb02f0ea8350de28bc3687e0af70ea0f Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 23 Jan 2003 19:45:57 +0000 Subject: Initial revision git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@132 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classchanrec.html | 534 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 534 insertions(+) create mode 100644 docs/module-doc/classchanrec.html (limited to 'docs/module-doc/classchanrec.html') 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 @@ + + +chanrec class Reference + + + + +Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members +

chanrec Class Reference

Holds all relevent information for a channel. +More... +

+#include <channels.h> +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods
chanrec ()
Creates a channel record and initialises it with default values.

virtual ~chanrec ()

Public Attributes
char name [CHANMAX]
The channels name.

char custom_modes [MAXMODES]
Custom modes for the channel.

char topic [MAXBUF]
Channel topic.

time_t created
Creation time.

time_t topicset
Time topic was set.

char setby [NICKMAX]
The last user to set the topic.

long limit
Contains the channel user limit.

char key [32]
Contains the channel key.

short int topiclock
Nonzero if the mode +t is set.

short int noexternal
Nonzero if the mode +n is set.

short int inviteonly
Nonzero if the mode +i is set.

short int moderated
Nonzero if the mode +m is set.

short int secret
Nonzero if the mode +s is set.

short int c_private
Nonzero if the mode +p is set.

BanList bans
The list of all bans set on the channel.

+

Detailed Description

+Holds all relevent information for a channel. +

+This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type. +

+ +

+Definition at line 82 of file channels.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
chanrec::chanrec ( ) [inline]
+
+ + + + + +
+ + + +
+Creates a channel record and initialises it with default values. +
+ +
+Definition at line 150 of file channels.h. +
+
00151 { +00152 strcpy(name,""); +00153 strcpy(custom_modes,""); +00154 strcpy(topic,""); +00155 strcpy(setby,""); +00156 strcpy(key,""); +00157 created = topicset = limit = 0; +00158 topiclock = noexternal = inviteonly = moderated = secret = c_private = false; +00159 } +

+

+ + + + +
+ + + + + + + + + +
virtual chanrec::~chanrec ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+ +
+Definition at line 161 of file channels.h. +
+
00161 { /* stub */ } +

+

Member Data Documentation

+ + + + +
+ + +
BanList chanrec::bans +
+
+ + + + + +
+ + + +
+The list of all bans set on the channel. +
+ +
+Definition at line 146 of file channels.h.
+

+ + + + +
+ + +
short int chanrec::c_private +
+
+ + + + + +
+ + + +
+Nonzero if the mode +p is set. +
+This value cannot be set at the same time as chanrec::secret +
+Definition at line 142 of file channels.h.
+

+ + + + +
+ + +
time_t chanrec::created +
+
+ + + + + +
+ + + +
+Creation time. +
+ +
+Definition at line 98 of file channels.h.
+

+ + + + +
+ + +
char chanrec::custom_modes[MAXMODES] +
+
+ + + + + +
+ + + +
+Custom modes for the channel. +
+Plugins may use this field in any way they see fit. +
+Definition at line 91 of file channels.h.
+

+ + + + +
+ + +
short int chanrec::inviteonly +
+
+ + + + + +
+ + + +
+Nonzero if the mode +i is set. +
+ +
+Definition at line 128 of file channels.h.
+

+ + + + +
+ + +
char chanrec::key[32] +
+
+ + + + + +
+ + + +
+Contains the channel key. +
+If this value is an empty string, there is no channel key in place. +
+Definition at line 116 of file channels.h.
+

+ + + + +
+ + +
long chanrec::limit +
+
+ + + + + +
+ + + +
+Contains the channel user limit. +
+If this value is zero, there is no limit in place. +
+Definition at line 111 of file channels.h.
+

+ + + + +
+ + +
short int chanrec::moderated +
+
+ + + + + +
+ + + +
+Nonzero if the mode +m is set. +
+ +
+Definition at line 132 of file channels.h.
+

+ + + + +
+ + +
char chanrec::name[CHANMAX] +
+
+ + + + + +
+ + + +
+The channels name. +
+ +
+Definition at line 87 of file channels.h.
+

+ + + + +
+ + +
short int chanrec::noexternal +
+
+ + + + + +
+ + + +
+Nonzero if the mode +n is set. +
+ +
+Definition at line 124 of file channels.h.
+

+ + + + +
+ + +
short int chanrec::secret +
+
+ + + + + +
+ + + +
+Nonzero if the mode +s is set. +
+This value cannot be set at the same time as chanrec::c_private +
+Definition at line 137 of file channels.h.
+

+ + + + +
+ + +
char chanrec::setby[NICKMAX] +
+
+ + + + + +
+ + + +
+The last user to set the topic. +
+If this member is an empty string, no topic was ever set. +
+Definition at line 106 of file channels.h.
+

+ + + + +
+ + +
char chanrec::topic[MAXBUF] +
+
+ + + + + +
+ + + +
+Channel topic. +
+If this is an empty string, no channel topic is set. +
+Definition at line 95 of file channels.h.
+

+ + + + +
+ + +
short int chanrec::topiclock +
+
+ + + + + +
+ + + +
+Nonzero if the mode +t is set. +
+ +
+Definition at line 120 of file channels.h.
+

+ + + + +
+ + +
time_t chanrec::topicset +
+
+ + + + + +
+ + + +
+Time topic was set. +
+If no topic was ever set, this will be equal to chanrec::created +
+Definition at line 102 of file channels.h.
+

The documentation for this class was generated from the following file:

channels.h

Generated on Wed Jan 22 20:56:47 2003 for InspIRCd by + +

1.3-rc2

+ + -- cgit v1.2.3


Public Methods
	chanrec ()
	Creates a channel record and initialises it with default values.
virtual	~chanrec ()
Public Attributes
char	name [CHANMAX]
	The channels name.
char	custom_modes [MAXMODES]
	Custom modes for the channel.
char	topic [MAXBUF]
	Channel topic.
time_t	created
	Creation time.
time_t	topicset
	Time topic was set.
char	setby [NICKMAX]
	The last user to set the topic.
long	limit
	Contains the channel user limit.
char	key [32]
	Contains the channel key.
short int	topiclock
	Nonzero if the mode +t is set.
short int	noexternal
	Nonzero if the mode +n is set.
short int	inviteonly
	Nonzero if the mode +i is set.
short int	moderated
	Nonzero if the mode +m is set.
short int	secret
	Nonzero if the mode +s is set.
short int	c_private
	Nonzero if the mode +p is set.
BanList	bans
	The list of all bans set on the channel.