chatunit.h

Go to the documentation of this file.

/****************************************************************************
**
** qutIM - instant messenger
**
** Copyright © 2011 Ruslan Nigmatullin <euroelessar@yandex.ru>
**
*****************************************************************************
**
** $QUTIM_BEGIN_LICENSE$
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation, either version 3 of the License, or
** (at your option) any later version.
**
** This program 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 General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program.  If not, see http://www.gnu.org/licenses/.
** $QUTIM_END_LICENSE$
**
****************************************************************************/

#ifndef CHATUNIT_H
#define CHATUNIT_H

#include "menucontroller.h"
#include <QMetaType>
#include <QEvent>
#include <QDateTime>

namespace qutim_sdk_0_3
{

class MetaContact;
class Account;
class Message;
class ChatUnit;
class ChatUnitPrivate;
class Contact;
typedef QList<ChatUnit *> ChatUnitList;

enum ChatState
{
    ChatStateActive = 0,    // User is actively participating in the chat session.
    ChatStateInActive,      // User has not been actively participating in the chat session.
    ChatStateGone,          // User has effectively ended their participation in the chat session.
    ChatStateComposing,     // User is composing a message.
    ChatStatePaused         // User had been composing but now has stopped.
};

class LIBQUTIM_EXPORT ChatUnit : public MenuController
{
    Q_DECLARE_PRIVATE(ChatUnit)
    Q_OBJECT
    Q_PROPERTY(QString id READ id CONSTANT)
    Q_PROPERTY(QString title READ title NOTIFY titleChanged)
    Q_PROPERTY(ChatState chatState READ chatState WRITE setChatState NOTIFY chatStateChanged)
    Q_PROPERTY(QDateTime lastActivity READ lastActivity NOTIFY lastActivityChanged)
    Q_PROPERTY(qutim_sdk_0_3::Account* account READ account CONSTANT)
    Q_PROPERTY(bool conference READ isConference CONSTANT)
public:
    ChatUnit(Account *account);
    ChatUnit(ChatUnitPrivate &d, Account *account);
    virtual ~ChatUnit();
    virtual QString id() const = 0;
    virtual QString title() const;
    Account *account();
    const Account *account() const;
    bool isConference() const;
    virtual bool sendMessage(const qutim_sdk_0_3::Message &message) = 0;

    Q_INVOKABLE bool send(const qutim_sdk_0_3::Message &message);
    Q_INVOKABLE virtual QList<qutim_sdk_0_3::ChatUnit*> lowerUnits();
    Q_INVOKABLE virtual qutim_sdk_0_3::ChatUnit *upperUnit();
    ChatUnit *buddy();
    const ChatUnit *buddy() const;
    ChatUnit *metaContact();
    const ChatUnit *metaContact() const;
    virtual const ChatUnit *getHistoryUnit() const;
    QDateTime lastActivity() const;
    void setLastActivity(const QDateTime &time = QDateTime::currentDateTime());
    void setChatState(qutim_sdk_0_3::ChatState state);
    qutim_sdk_0_3::ChatState chatState() const;
public slots:
    quint64 sendMessage(const QString &text);
signals:
    void titleChanged(const QString &current, const QString &previous);
    void lowerUnitAdded(ChatUnit *unit);
    void chatStateChanged(qutim_sdk_0_3::ChatState current,qutim_sdk_0_3::ChatState previous);
    void lastActivityChanged(const QDateTime &current, const QDateTime &previous);
};

class LIBQUTIM_EXPORT ChatStateEvent : public QEvent
{
public:
    ChatStateEvent(ChatState state);
    inline ChatState chatState() const { return m_state; }
    static QEvent::Type eventType();
protected:
    ChatState m_state;
};
}

Q_DECLARE_METATYPE(qutim_sdk_0_3::ChatUnit*)
Q_DECLARE_METATYPE(QList<qutim_sdk_0_3::ChatUnit*>)
Q_ENUMS(qutim_sdk_0_3::ChatState)

#endif // CHATUNIT_H