docs/man/man3/channels.h.3

   1 .TH "channels.h" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 channels.h \-
   6 .SH SYNOPSIS
   7 .br
   8 .PP
   9 \fC#include 'inspircd_config.h'\fP
  10 .br
  11 \fC#include 'base.h'\fP
  12 .br
  13 \fC#include <time.h>\fP
  14 .br
  15 \fC#include <vector>\fP
  16 .br
  17 \fC#include <string>\fP
  18 .br
  19
  20 .SS "Compounds"
  21
  22 .in +1c
  23 .ti -1c
  24 .RI "class \fBBanItem\fP"
  25 .br
  26 .RI "\fIA subclass of \fBHostItem\fP designed to hold channel bans (+b). \fP"
  27 .ti -1c
  28 .RI "class \fBchanrec\fP"
  29 .br
  30 .RI "\fIHolds all relevent information for a channel. \fP"
  31 .ti -1c
  32 .RI "class \fBExemptItem\fP"
  33 .br
  34 .RI "\fIA subclass of \fBHostItem\fP designed to hold channel exempts (+e). \fP"
  35 .ti -1c
  36 .RI "class \fBHostItem\fP"
  37 .br
  38 .RI "\fIHolds an entry for a ban list, exemption list, or invite list. \fP"
  39 .ti -1c
  40 .RI "class \fBInviteItem\fP"
  41 .br
  42 .RI "\fIA subclass of \fBHostItem\fP designed to hold channel invites (+I). \fP"
  43 .ti -1c
  44 .RI "class \fBModeParameter\fP"
  45 .br
  46 .RI "\fIHolds a custom parameter to a module-defined channel mode e.g. \fP"
  47 .ti -1c
  48 .RI "class \fBucrec\fP"
  49 .br
  50 .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"
  51 .in -1c
  52 .SS "Defines"
  53
  54 .in +1c
  55 .ti -1c
  56 .RI "#define \fBCM_TOPICLOCK\fP   1"
  57 .br
  58 .ti -1c
  59 .RI "#define \fBCM_NOEXTERNAL\fP   2"
  60 .br
  61 .ti -1c
  62 .RI "#define \fBCM_INVITEONLY\fP   4"
  63 .br
  64 .ti -1c
  65 .RI "#define \fBCM_MODERATED\fP   8"
  66 .br
  67 .ti -1c
  68 .RI "#define \fBCM_SECRET\fP   16"
  69 .br
  70 .ti -1c
  71 .RI "#define \fBCM_PRIVATE\fP   32"
  72 .br
  73 .ti -1c
  74 .RI "#define \fBUCMODE_OP\fP   1"
  75 .br
  76 .ti -1c
  77 .RI "#define \fBUCMODE_VOICE\fP   2"
  78 .br
  79 .ti -1c
  80 .RI "#define \fBUCMODE_HOP\fP   4"
  81 .br
  82 .ti -1c
  83 .RI "#define \fBUCMODE_PROTECT\fP   8"
  84 .br
  85 .ti -1c
  86 .RI "#define \fBUCMODE_FOUNDER\fP   16"
  87 .br
  88 .in -1c
  89 .SS "Typedefs"
  90
  91 .in +1c
  92 .ti -1c
  93 .RI "typedef std::vector< \fBBanItem\fP > \fBBanList\fP"
  94 .br
  95 .RI "\fIHolds a complete ban list. \fP"
  96 .ti -1c
  97 .RI "typedef std::vector< \fBExemptItem\fP > \fBExemptList\fP"
  98 .br
  99 .RI "\fIHolds a complete exempt list. \fP"
 100 .ti -1c
 101 .RI "typedef std::vector< \fBInviteItem\fP > \fBInviteList\fP"
 102 .br
 103 .RI "\fIHolds a complete invite list. \fP"
 104 .in -1c
 105 .SH "Define Documentation"
 106 .PP
 107 .SS "#define CM_INVITEONLY   4"
 108 .PP
 109 Definition at line 28 of file channels.h.
 110 .SS "#define CM_MODERATED   8"
 111 .PP
 112 Definition at line 29 of file channels.h.
 113 .SS "#define CM_NOEXTERNAL   2"
 114 .PP
 115 Definition at line 27 of file channels.h.
 116 .SS "#define CM_PRIVATE   32"
 117 .PP
 118 Definition at line 31 of file channels.h.
 119 .SS "#define CM_SECRET   16"
 120 .PP
 121 Definition at line 30 of file channels.h.
 122 .SS "#define CM_TOPICLOCK   1"
 123 .PP
 124 Definition at line 26 of file channels.h.
 125 .SS "#define UCMODE_FOUNDER   16"
 126 .PP
 127 Definition at line 215 of file channels.h.
 128 .SS "#define UCMODE_HOP   4"
 129 .PP
 130 Definition at line 213 of file channels.h.
 131 .SS "#define UCMODE_OP   1"
 132 .PP
 133 Definition at line 211 of file channels.h.
 134 .SS "#define UCMODE_PROTECT   8"
 135 .PP
 136 Definition at line 214 of file channels.h.
 137 .SS "#define UCMODE_VOICE   2"
 138 .PP
 139 Definition at line 212 of file channels.h.
 140 .SH "Typedef Documentation"
 141 .PP
 142 .SS "typedef std::vector<\fBBanItem\fP> \fBBanList\fP"
 143 .PP
 144 Holds a complete ban list. Definition at line 87 of file channels.h.
 145 .SS "typedef std::vector<\fBExemptItem\fP> \fBExemptList\fP"
 146 .PP
 147 Holds a complete exempt list. Definition at line 91 of file channels.h.
 148 .SS "typedef std::vector<\fBInviteItem\fP> \fBInviteList\fP"
 149 .PP
 150 Holds a complete invite list. Definition at line 95 of file channels.h.
 151 .SH "Author"
 152 .PP
 153 Generated automatically by Doxygen for InspIRCd from the source code.