summaryrefslogtreecommitdiff
path: root/docs/man/man3/channels.h.3
blob: f1fb458f06ae50a10c215dad019f5e7d61e4f5a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
.TH "channels.h" 3 "14 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
channels.h \- 
.SH SYNOPSIS
.br
.PP
\fC#include 'inspircd_config.h'\fP
.br
\fC#include 'base.h'\fP
.br
\fC#include <time.h>\fP
.br
\fC#include <vector>\fP
.br
\fC#include <string>\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBHostItem\fP"
.br
.RI "\fIHolds an entry for a ban list, exemption list, or invite list. \fP"
.ti -1c
.RI "class \fBBanItem\fP"
.br
.RI "\fIA subclass of \fBHostItem\fP designed to hold channel bans (+b). \fP"
.ti -1c
.RI "class \fBExemptItem\fP"
.br
.RI "\fIA subclass of \fBHostItem\fP designed to hold channel exempts (+e). \fP"
.ti -1c
.RI "class \fBInviteItem\fP"
.br
.RI "\fIA subclass of \fBHostItem\fP designed to hold channel invites (+I). \fP"
.ti -1c
.RI "class \fBModeParameter\fP"
.br
.RI "\fIHolds a custom parameter to a module-defined channel mode e.g. \fP"
.ti -1c
.RI "class \fBchanrec\fP"
.br
.RI "\fIHolds all relevent information for a channel. \fP"
.ti -1c
.RI "class \fBucrec\fP"
.br
.RI "\fIHolds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class. \fP"
.in -1c
.SS "Defines"

.in +1c
.ti -1c
.RI "#define \fBCM_TOPICLOCK\fP   1"
.br
.ti -1c
.RI "#define \fBCM_NOEXTERNAL\fP   2"
.br
.ti -1c
.RI "#define \fBCM_INVITEONLY\fP   4"
.br
.ti -1c
.RI "#define \fBCM_MODERATED\fP   8"
.br
.ti -1c
.RI "#define \fBCM_SECRET\fP   16"
.br
.ti -1c
.RI "#define \fBCM_PRIVATE\fP   32"
.br
.ti -1c
.RI "#define \fBUCMODE_OP\fP   1"
.br
.ti -1c
.RI "#define \fBUCMODE_VOICE\fP   2"
.br
.ti -1c
.RI "#define \fBUCMODE_HOP\fP   4"
.br
.ti -1c
.RI "#define \fBUCMODE_PROTECT\fP   8"
.br
.ti -1c
.RI "#define \fBUCMODE_FOUNDER\fP   16"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef std::vector< \fBBanItem\fP > \fBBanList\fP"
.br
.RI "\fIHolds a complete ban list. \fP"
.ti -1c
.RI "typedef std::vector< \fBExemptItem\fP > \fBExemptList\fP"
.br
.RI "\fIHolds a complete exempt list. \fP"
.ti -1c
.RI "typedef std::vector< \fBInviteItem\fP > \fBInviteList\fP"
.br
.RI "\fIHolds a complete invite list. \fP"
.in -1c
.SH "Define Documentation"
.PP 
.SS "#define CM_INVITEONLY   4"
.PP
Definition at line 28 of file channels.h.
.SS "#define CM_MODERATED   8"
.PP
Definition at line 29 of file channels.h.
.SS "#define CM_NOEXTERNAL   2"
.PP
Definition at line 27 of file channels.h.
.SS "#define CM_PRIVATE   32"
.PP
Definition at line 31 of file channels.h.
.SS "#define CM_SECRET   16"
.PP
Definition at line 30 of file channels.h.
.SS "#define CM_TOPICLOCK   1"
.PP
Definition at line 26 of file channels.h.
.SS "#define UCMODE_FOUNDER   16"
.PP
Definition at line 234 of file channels.h.
.SS "#define UCMODE_HOP   4"
.PP
Definition at line 232 of file channels.h.
.SS "#define UCMODE_OP   1"
.PP
Definition at line 230 of file channels.h.
.SS "#define UCMODE_PROTECT   8"
.PP
Definition at line 233 of file channels.h.
.SS "#define UCMODE_VOICE   2"
.PP
Definition at line 231 of file channels.h.
.SH "Typedef Documentation"
.PP 
.SS "typedef std::vector<\fBBanItem\fP> \fBBanList\fP"
.PP
Holds a complete ban list. 
.PP
Definition at line 87 of file channels.h.
.SS "typedef std::vector<\fBExemptItem\fP> \fBExemptList\fP"
.PP
Holds a complete exempt list. 
.PP
Definition at line 91 of file channels.h.
.SS "typedef std::vector<\fBInviteItem\fP> \fBInviteList\fP"
.PP
Holds a complete invite list. 
.PP
Definition at line 95 of file channels.h.
.SH "Author"
.PP 
Generated automatically by Doxygen for InspIRCd from the source code.