docs/man/man3/channels.h.3

   1 .TH "channels.h" 3 "26 Apr 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 \fBUCMODE_OP\fP   1"
  57 .br
  58 .ti -1c
  59 .RI "#define \fBUCMODE_VOICE\fP   2"
  60 .br
  61 .ti -1c
  62 .RI "#define \fBUCMODE_HOP\fP   4"
  63 .br
  64 .ti -1c
  65 .RI "#define \fBUCMODE_PROTECT\fP   8"
  66 .br
  67 .ti -1c
  68 .RI "#define \fBUCMODE_FOUNDER\fP   16"
  69 .br
  70 .in -1c
  71 .SS "Typedefs"
  72
  73 .in +1c
  74 .ti -1c
  75 .RI "typedef std::vector< \fBBanItem\fP > \fBBanList\fP"
  76 .br
  77 .RI "\fIHolds a complete ban list. \fP"
  78 .ti -1c
  79 .RI "typedef std::vector< \fBExemptItem\fP > \fBExemptList\fP"
  80 .br
  81 .RI "\fIHolds a complete exempt list. \fP"
  82 .ti -1c
  83 .RI "typedef std::vector< \fBInviteItem\fP > \fBInviteList\fP"
  84 .br
  85 .RI "\fIHolds a complete invite list. \fP"
  86 .in -1c
  87 .SH "Define Documentation"
  88 .PP
  89 .SS "#define UCMODE_FOUNDER   16"
  90 .PP
  91 Definition at line 250 of file channels.h.
  92 .SS "#define UCMODE_HOP   4"
  93 .PP
  94 Definition at line 248 of file channels.h.
  95 .SS "#define UCMODE_OP   1"
  96 .PP
  97 Definition at line 246 of file channels.h.
  98 .SS "#define UCMODE_PROTECT   8"
  99 .PP
 100 Definition at line 249 of file channels.h.
 101 .SS "#define UCMODE_VOICE   2"
 102 .PP
 103 Definition at line 247 of file channels.h.
 104 .SH "Typedef Documentation"
 105 .PP
 106 .SS "typedef std::vector<\fBBanItem\fP> \fBBanList\fP"
 107 .PP
 108 Holds a complete ban list. Definition at line 80 of file channels.h.
 109 .SS "typedef std::vector<\fBExemptItem\fP> \fBExemptList\fP"
 110 .PP
 111 Holds a complete exempt list. Definition at line 84 of file channels.h.
 112 .SS "typedef std::vector<\fBInviteItem\fP> \fBInviteList\fP"
 113 .PP
 114 Holds a complete invite list. Definition at line 88 of file channels.h.
 115 .SH "Author"
 116 .PP
 117 Generated automatically by Doxygen for InspIRCd from the source code.