kchatbase.h

Go to the documentation of this file.

/*
    This file is part of the KDE games library
    Copyright (C) 2001 Andreas Beckermann (b_mann@gmx.de)
    Copyright (C) 2007 Gael de Chalendar (aka Kleag) <kleag@free.fr>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef __KCHATBASE_H__
#define __KCHATBASE_H__

#include <QtGui/QFrame>

#include <kglobalsettings.h>
#include "libkdegamesprivate_export.h"

class KConfig;

class KChatBasePrivate;
class KChatBaseModel;
class KChatBaseItemDelegate;
class QModelIndex;
class QPoint;

class KDEGAMESPRIVATE_EXPORT KChatBase : public QFrame
{
    Q_OBJECT
public:
    explicit KChatBase(QWidget* parent, KChatBaseModel* model=0, 
                           KChatBaseItemDelegate* delegate=0,
                           bool noComboBox = false);

    virtual ~KChatBase();

    enum SendingIds {
        SendToAll = 0
    };

    virtual QString fromName() const = 0;

    bool addSendingEntry(const QString& text, int id);

    bool insertSendingEntry(const QString& text, int id, int index = -1);

    void changeSendingEntry(const QString& text, int id);

    void setSendingEntry(int id);

    void removeSendingEntry(int id);

    int sendingEntry() const;
    
    int findIndex(int id) const;

    int nextId() const;

    virtual bool acceptMessage() const;

    void setCompletionMode(KGlobalSettings::Completion mode);

    void setNameFont(const QFont& font);
    
    void setMessageFont(const QFont& font);

    void setBothFont(const QFont& font);

    void setSystemNameFont(const QFont& font);

    void setSystemMessageFont(const QFont& font);

    void setSystemBothFont(const QFont& font);

    QFont nameFont() const;

    QFont messageFont() const;

    QFont systemNameFont() const;

    QFont systemMessageFont() const;

    virtual void saveConfig(KConfig* conf = 0);

    virtual void readConfig(KConfig* conf = 0);

    void setMaxItems(int maxItems);

    void clear();

    int maxItems() const;

     KChatBaseModel* model();
     void setModel(KChatBaseModel* m);

public Q_SLOTS:
    virtual void addMessage(const QString& fromName, const QString& text);

    virtual void addSystemMessage(const QString& fromName, const QString& text);

    void slotClear();

    void setAcceptMessage(bool a);

protected:
    virtual void returnPressed(const QString& text) = 0;

    virtual QString comboBoxItem(const QString& name) const;

        const QModelIndex indexAt(const QPoint& pos) const;

private Q_SLOTS:
    void slotReturnPressed(const QString&);

        virtual void customMenuHandler(const QPoint &pos);

private:

    KChatBasePrivate* d;
};

#endif