include/commands/cmd_topic.h

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