Anope IRC Services  Version 2.0
Public Member Functions
BadWords Struct Referenceabstract

#include <bs_badwords.h>

Inheritance diagram for BadWords:
Inheritance graph
[legend]

Public Member Functions

virtual ~BadWords ()
 
virtual BadWordAddBadWord (const Anope::string &word, BadWordType type)=0
 
virtual BadWordGetBadWord (unsigned index) const =0
 
virtual unsigned GetBadWordCount () const =0
 
virtual void EraseBadWord (unsigned index)=0
 
virtual void ClearBadWords ()=0
 
virtual void Check ()=0
 

Detailed Description

Definition at line 40 of file bs_badwords.h.

Constructor & Destructor Documentation

virtual BadWords::~BadWords ( )
inlinevirtual

Definition at line 42 of file bs_badwords.h.

Member Function Documentation

virtual BadWord* BadWords::AddBadWord ( const Anope::string word,
BadWordType  type 
)
pure virtual

Add a badword to the badword list

Parameters
wordThe badword
typeThe type (SINGLE START END)
Returns
The badword

Implemented in BadWordsImpl.

Referenced by CommandBSBadwords::DoAdd(), CommandCSClone::Execute(), and LoadChannels().

virtual void BadWords::Check ( )
pure virtual
virtual void BadWords::ClearBadWords ( )
pure virtual

Clear all badwords from the channel

Implemented in BadWordsImpl.

Referenced by CommandBSBadwords::DoClear(), and CommandCSClone::Execute().

virtual void BadWords::EraseBadWord ( unsigned  index)
pure virtual

Remove a badword

Parameters
indexThe index of the badword

Implemented in BadWordsImpl.

Referenced by CommandBSBadwords::DoDelete(), and BadwordsDelCallback::HandleNumber().

virtual BadWord* BadWords::GetBadWord ( unsigned  index) const
pure virtual

Get a badword structure by index

Parameters
indexThe index
Returns
The badword

Implemented in BadWordsImpl.

Referenced by CommandBSBadwords::DoAdd(), CommandBSBadwords::DoDelete(), CommandBSBadwords::DoList(), BadwordsDelCallback::HandleNumber(), and BSKick::OnPrivmsg().

virtual unsigned BadWords::GetBadWordCount ( ) const
pure virtual

Get how many badwords are on this channel

Returns
The number of badwords in the vector

Implemented in BadWordsImpl.

Referenced by CommandBSBadwords::DoAdd(), CommandBSBadwords::DoDelete(), CommandBSBadwords::DoList(), BadwordsDelCallback::HandleNumber(), and BSKick::OnPrivmsg().


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