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 <QCoreApplication>
  25 #include <QString>
  26 #include <QDateTime>
  27
  28 #include "global.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(BufferId buffer = BufferId(), Type type = Plain, QString text = "", QString sender = "", quint8 flags = None);
  39
  40     Message(QDateTime ts, BufferId buffer = BufferId(), Type type = Plain, QString text = "", QString sender = "", quint8 flags = None);
  41
  42     MsgId msgId() const;
  43     void setMsgId(MsgId id);
  44
  45     BufferId 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     void format();
  57
  58   private:
  59     QDateTime _timeStamp;
  60     MsgId _msgId;
  61     BufferId _buffer;
  62     QString _text;
  63     QString _sender;
  64     Type _type;
  65     quint8 _flags;
  66
  67     QString _formattedTimeStamp, _formattedSender, _formattedText; // cache
  68
  69     /** Convert mIRC control codes to our own */
  70     QString mircToInternal(QString);
  71
  72     friend QDataStream &operator>>(QDataStream &in, Message &msg);
  73 };
  74
  75 QDataStream &operator<<(QDataStream &out, const Message &msg);
  76 QDataStream &operator>>(QDataStream &in, Message &msg);
  77
  78 Q_DECLARE_METATYPE(Message);
  79
  80 #endif