include/commands/cmd_topic.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *      the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __CMD_TOPIC_H__
  15 #define __CMD_TOPIC_H__
  16
  17 // include the common header files
  18
  19 #include "users.h"
  20 #include "channels.h"
  21
  22 /** Handle /TOPIC. These command handlers can be reloaded by the core,
  23  * and handle basic RFC1459 commands. Commands within modules work
  24  * the same way, however, they can be fully unloaded, where these
  25  * may not.
  26  */
  27 class CommandTopic : public Command
  28 {
  29  public:
  30         /** Constructor for topic.
  31          */
  32         CommandTopic (InspIRCd* Instance) : Command(Instance,"TOPIC",0,1,false,2) { syntax = "<channel> [<topic>]"; }
  33         /** Handle command.
  34          * @param parameters The parameters to the comamnd
  35          * @param pcnt The number of parameters passed to teh command
  36          * @param user The user issuing the command
  37          * @return A value from CmdResult to indicate command success or failure.
  38          */
  39         CmdResult Handle(const char** parameters, int pcnt, User *user);
  40 };
  41
  42 #endif