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

Public Member Functions

 CommandCSTopic (Module *creator)
 
void Execute (CommandSource &source, const std::vector< Anope::string > &params) anope_override
 
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 const Anope::string GetDesc (CommandSource &source) 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 Lock (CommandSource &source, ChannelInfo *ci, const std::vector< Anope::string > &params)
 
void Unlock (CommandSource &source, ChannelInfo *ci, const std::vector< Anope::string > &params)
 
void Set (CommandSource &source, ChannelInfo *ci, const std::vector< Anope::string > &params)
 
void Append (CommandSource &source, ChannelInfo *ci, const std::vector< Anope::string > &params)
 

Private Attributes

ExtensibleRef< bool > topiclock
 

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 79 of file cs_topic.cpp.

Constructor & Destructor Documentation

CommandCSTopic::CommandCSTopic ( Module creator)
inline

Definition at line 153 of file cs_topic.cpp.

References _, Command::SetDesc(), and Command::SetSyntax().

Member Function Documentation

void CommandCSTopic::Append ( CommandSource source,
ChannelInfo ci,
const std::vector< Anope::string > &  params 
)
inlineprivate
void CommandCSTopic::Execute ( CommandSource source,
const std::vector< Anope::string > &  params 
)
inlinevirtual

Execute this command.

Parameters
sourceThe source
paramsCommand parameters

Implements Command.

Definition at line 162 of file cs_topic.cpp.

References ACCESS_DENIED, Append(), ChannelInfo::c, Anope::string::c_str(), CHAN_X_NOT_IN_USE, CHAN_X_NOT_REGISTERED, Anope::string::equals_ci(), ChannelInfo::Find(), Lock(), ChannelInfo::name, Command::SendSyntax(), Set(), and Unlock().

void CommandCSTopic::Lock ( CommandSource source,
ChannelInfo ci,
const std::vector< Anope::string > &  params 
)
inlineprivate
bool CommandCSTopic::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 185 of file cs_topic.cpp.

References _, and Command::SendSyntax().

void CommandCSTopic::Set ( CommandSource source,
ChannelInfo ci,
const std::vector< Anope::string > &  params 
)
inlineprivate
void CommandCSTopic::Unlock ( CommandSource source,
ChannelInfo ci,
const std::vector< Anope::string > &  params 
)
inlineprivate

Field Documentation

ExtensibleRef<bool> CommandCSTopic::topiclock
private

Definition at line 81 of file cs_topic.cpp.


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