Would you like to make this site your homepage? It's fast and easy...
Yes, Please make this my home page!
class Command
|
Base class for commands. More... |
|
|
Public Methods
- Command (IRCModule* ircModule, DCCUser* pUser, QString text)
- virtual ~Command ()
- virtual void execute ()
- virtual void unExecute ()
Protected Methods
Protected Members
- IRCModule* _ircModule
- DCCUser* _user
- Message* _msg
Detailed Description
Construct a new Command object.
PRECONDITIONS: ircModule != 0 ; pUser != 0
Parameters:
| ircModule | A pointer to the IRCModule object the
command should use to interact with the IRC server.
|
| pUser | A pointer to the DCCUser object of the user
initiating the command.
|
| text | A string containing the text the user sent
(including the command's name and parameters).
|
[pure virtual]
Make the command execute.
Subclasses must redefine this method and implement
their specific behavior.
[virtual]
Cancel the effects of a command, if possible.
Subclasses can redefine this method to implement
command undoing.
This method does nothing by default.
| bool hasAccess (unsigned int level)
|
[protected]
Determine if the user pointed to by the _user member has
the specified access on his current channel.
Parameters:
| level | The minimum level needed to execute the command.
|
Returns: true if the user's level on his current channel is
equal or higher than level, false otherwise.
| bool hasGlobalAccess (unsigned int level)
|
[protected]
Determine if the user pointed to by the _user member has
the specified global access (access on channel "*")
Parameters:
| level | The minimum level needed to execute the command.
|
Returns: true if the user's level on special channel "*" is
equal or higher than level, false otherwise.
| bool hasEnoughParams (unsigned int min,QString syntax = "")
|
[protected]
Determine if the user specified enough parameters for the command.
If the user specified less than min parameters, he is given an error
message with the syntax parameter for more details.
Parameters:
| min | Minimum necessary number of parameters to the command.
|
| syntax | A string containing an explanation of the command's syntax.
this string is displayed to the user if he did not supply enough
parameters.
|
- Author: David M.
The Command class defines an interface for all
commands the bot receives from users.
Each command is a specific Command subclass.
This allows handling the commands no matter
what it is, along with undoing commands,
and smaller parsing/handling methods.
- Generated: nightsky@centauri on Sat Jan 15 23:06:10 2000, using kdoc 2.0a30.
