kopetecommand.h

Go to the documentation of this file.

/*
    kopetecommand.h - Command

    Copyright (c) 2003      by Jason Keirstead       <jason@keirstead.org>
    Copyright (c) 2005      by Michel Hermier        <michel.hermier@wanadoo.fr>
    Kopete    (c) 2002-2005 by the Kopete developers <kopete-devel@kde.org>

   *************************************************************************
    *                                                                       *
    * This library is free software; you can redistribute it and/or         *
    * modify it under the terms of the GNU Lesser General Public            *
    * License as published by the Free Software Foundation; either          *
    * version 2 of the License, or (at your option) any later version.      *
    *                                                                       *
    *************************************************************************
*/

#ifndef KOPETECOMMAND_H
#define KOPETECOMMAND_H

#include <QtCore/QObject>

#include <kaction.h>
#include "kopetecommandhandler.h"

namespace Kopete
{

class ChatSession;

class Command
    : public KAction
{
    Q_OBJECT

public:
    typedef enum Type
    {
        Normal  = 0,
        System  = 1 << 1, // Not removable command
        Alias   = 1 << 2  // Is an alias
//      Undefined
    } Type;
    Q_DECLARE_FLAGS(Types, Type)

    
     Command( QObject *parent, const QString &command, const char* handlerSlot,
        const QString &help = QString(), CommandHandler::CommandType type = CommandHandler::Normal, const QString &formatString = QString(),
        uint minArgs = 0, int maxArgs = -1, const KShortcut &cut = KShortcut(),
        const QString &pix = QString() );
    ~Command();

    void processCommand( const QString &args, ChatSession *manager, bool gui = false );

     const QString &command() const { return m_command; }

     const QString &help() const { return m_help; }

     CommandHandler::CommandType type() const { return m_type; }

signals:
    void handleCommand( const QString &args, Kopete::ChatSession *manager );

private slots:
    void slotAction();

private:
    void init( const QString &command, const char* slot, const QString &help,
        CommandHandler::CommandType type, const QString &formatString,
        uint minArgs, int maxArgs );

    void printError( const QString &error, ChatSession *manager, bool gui = false ) const;

    QString m_command;
    QString m_help;
    QString m_formatString;
    int m_minArgs;
    int m_maxArgs;
    bool m_processing;
    CommandHandler::CommandType m_type;

    class Private;
    Private * const d;
};

}

Q_DECLARE_OPERATORS_FOR_FLAGS(Kopete::Command::Types)

#endif