src/common/message.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-07 by The Quassel IRC Development Team             *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef _MESSAGE_H_
  22 #define _MESSAGE_H_
  23
  24 #include <QString>
  25 #include <QDateTime>
  26
  27 #include "bufferinfo.h"
  28 #include "types.h"
  29
  30 class Message {
  31   Q_DECLARE_TR_FUNCTIONS(Message);
  32
  33   public:
  34     /** The different types a message can have for display */
  35     enum Type { Plain, Notice, Action, Nick, Mode, Join, Part, Quit, Kick, Kill, Server, Info, Error };
  36     enum Flags { None = 0, Self = 1, PrivMsg = 2, Highlight = 4 };
  37
  38     Message(BufferInfo buffer = BufferInfo(), Type type = Plain, QString text = "", QString sender = "", quint8 flags = None);
  39
  40     Message(QDateTime ts, BufferInfo buffer = BufferInfo(), Type type = Plain, QString text = "", QString sender = "", quint8 flags = None);
  41
  42     MsgId msgId() const;
  43     void setMsgId(MsgId id);
  44
  45     BufferInfo buffer() const;
  46     QString text() const;
  47     QString sender() const;
  48     Type type() const;
  49     quint8 flags() const;
  50     QDateTime timestamp() const;
  51
  52     QString formattedTimestamp();
  53     QString formattedSender();
  54     QString formattedText();
  55
  56     //static QString formattedToHtml(const QString &);
  57
  58     void format();
  59
  60   private:
  61     QDateTime _timestamp;
  62     MsgId _msgId;
  63     BufferInfo _buffer;
  64     QString _text;
  65     QString _sender;
  66     Type _type;
  67     quint8 _flags;
  68
  69     QString _formattedTimestamp, _formattedSender, _formattedText; // cache
  70
  71     /** Convert mIRC control codes to our own */
  72     QString mircToInternal(QString);
  73
  74     friend QDataStream &operator>>(QDataStream &in, Message &msg);
  75 };
  76
  77 QDataStream &operator<<(QDataStream &out, const Message &msg);
  78 QDataStream &operator>>(QDataStream &in, Message &msg);
  79
  80 Q_DECLARE_METATYPE(Message);
  81
  82 #endif