Anope IRC Services  Version 2.0
Public Member Functions | Private Member Functions
CommandCSXOP Class Reference
Inheritance diagram for CommandCSXOP:
Inheritance graph
[legend]
Collaboration diagram for CommandCSXOP:
Collaboration graph
[legend]

Public Member Functions

 CommandCSXOP (Module *modname)
 
const Anope::string GetDesc (CommandSource &source) const anope_override
 
void Execute (CommandSource &source, const std::vector< Anope::string > &params)
 
bool OnHelp (CommandSource &source, const Anope::string &subcommand) anope_override
 
- Public Member Functions inherited from Command
virtual ~Command ()
 
bool AllowUnregistered () const
 
bool RequireUser () const
 
virtual void OnServHelp (CommandSource &source)
 
virtual void OnSyntaxError (CommandSource &source, const Anope::string &subcommand)
 
- Public Member Functions inherited from Service
 Service (Module *o, const Anope::string &t, const Anope::string &n)
 
virtual ~Service ()
 
void Register ()
 
void Unregister ()
 
- Public Member Functions inherited from Base
 Base ()
 
virtual ~Base ()
 
void AddReference (ReferenceBase *r)
 
void DelReference (ReferenceBase *r)
 

Private Member Functions

void DoAdd (CommandSource &source, ChannelInfo *ci, const std::vector< Anope::string > &params)
 
void DoDel (CommandSource &source, ChannelInfo *ci, const std::vector< Anope::string > &params)
 
void DoList (CommandSource &source, ChannelInfo *ci, const std::vector< Anope::string > &params)
 
void DoClear (CommandSource &source, ChannelInfo *ci)
 

Additional Inherited Members

- Static Public Member Functions inherited from Command
static void Run (CommandSource &source, const Anope::string &message)
 
static bool FindCommandFromService (const Anope::string &command_service, BotInfo *&bi, Anope::string &name)
 
- Static Public Member Functions inherited from Service
static ServiceFindService (const Anope::string &t, const Anope::string &n)
 
static std::vector< Anope::stringGetServiceKeys (const Anope::string &t)
 
static void AddAlias (const Anope::string &t, const Anope::string &n, const Anope::string &v)
 
static void DelAlias (const Anope::string &t, const Anope::string &n)
 
- Data Fields inherited from Command
size_t max_params
 
size_t min_params
 
Modulemodule
 
- Data Fields inherited from Service
Moduleowner
 
Anope::string type
 
Anope::string name
 
- Protected Member Functions inherited from Command
 Command (Module *owner, const Anope::string &sname, size_t min_params, size_t max_params=0)
 
void SetDesc (const Anope::string &d)
 
void ClearSyntax ()
 
void SetSyntax (const Anope::string &s)
 
void SendSyntax (CommandSource &)
 
void AllowUnregistered (bool b)
 
void RequireUser (bool b)
 

Detailed Description

Definition at line 97 of file cs_xop.cpp.

Constructor & Destructor Documentation

CommandCSXOP::CommandCSXOP ( Module modname)
inline

Definition at line 483 of file cs_xop.cpp.

References _, and Command::SetSyntax().

Member Function Documentation

void CommandCSXOP::DoAdd ( CommandSource source,
ChannelInfo ci,
const std::vector< Anope::string > &  params 
)
inlineprivate
void CommandCSXOP::DoClear ( CommandSource source,
ChannelInfo ci 
)
inlineprivate
void CommandCSXOP::DoDel ( CommandSource source,
ChannelInfo ci,
const std::vector< Anope::string > &  params 
)
inlineprivate
void CommandCSXOP::DoList ( CommandSource source,
ChannelInfo ci,
const std::vector< Anope::string > &  params 
)
inlineprivate
void CommandCSXOP::Execute ( CommandSource source,
const std::vector< Anope::string > &  params 
)
inlinevirtual

Execute this command.

Parameters
sourceThe source
paramsCommand parameters

Implements Command.

Definition at line 496 of file cs_xop.cpp.

References CHAN_X_NOT_REGISTERED, DoAdd(), DoClear(), DoDel(), DoList(), Anope::string::equals_ci(), ChannelInfo::Find(), Command::OnSyntaxError(), and CommandSource::Reply().

const Anope::string CommandCSXOP::GetDesc ( CommandSource source) const
inlinevirtual

Get the command description

Parameters
sourceThe source wanting the command description
Returns
The commands description

Reimplemented from Command.

Definition at line 491 of file cs_xop.cpp.

References _, Anope::printf(), and Language::Translate().

bool CommandCSXOP::OnHelp ( CommandSource source,
const Anope::string subcommand 
)
inlinevirtual

Requested when the user is requesting help on this command. Help on this command should be sent to the user.

Parameters
sourceThe source
subcommandThe subcommand the user is requesting help on, or an empty string. (e.g. /ns help set foo bar lol gives a subcommand of "FOO BAR LOL")
Returns
true if help was provided to the user, false otherwise.

Reimplemented from Command.

Definition at line 520 of file cs_xop.cpp.

References _, Anope::string::c_str(), Anope::string::clear(), Anope::string::empty(), Command::FindCommandFromService(), Anope::string::length(), User::nick, Command::SendSyntax(), Anope::string::substr(), and Anope::string::upper().


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