plugins/teamwork/kdevteamwork_messages.h

   1 /***************************************************************************
   2 Copyright 2006 David Nolden <david.nolden.kdevelop@art-master.de>
   3 ***************************************************************************/
   4
   5 /***************************************************************************
   6  *                                                                         *
   7  *   This program is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU General Public License as published by  *
   9  *   the Free Software Foundation; either version 2 of the License, or     *
  10  *   (at your option) any later version.                                   *
  11  *                                                                         *
  12  ***************************************************************************/
  13
  14
  15 #ifndef KDEVTEAMWORK_MESSAGES_H
  16 #define KDEVTEAMWORK_MESSAGES_H
  17
  18 //#include <boost/serialization/extended_type_info_typeid.hpp>
  19
  20 #include "lib/network/serialization.h"
  21 #include "lib/network/messagetypeset.h"
  22 #include "lib/network/teamworkmessages.h"
  23 #include "lib/network/forwardsession.h"
  24
  25 #include <QString>
  26 #include <QDateTime>
  27 #include "utils.h"
  28 #include <QIcon>
  29 #include <QVariant>
  30 #include "lib/network/easymessage.h"
  31 #include <string>
  32 #include <boost/serialization/level.hpp>
  33 #include "loglevel.h"
  34
  35 /*#define BOOST_SERIALIZATION_DEFAULT_TYPE_INFO(T) \
  36     extended_type_info_typeid<const T>*/
  37 /**/
  38
  39 using namespace Teamwork;
  40
  41 class KDevTeamwork;
  42 class QMenu;
  43 class QModelIndex;
  44 class QWidget;
  45
  46 class SafeTeamworkEmitter;
  47 typedef SharedPtr<SafeTeamworkEmitter> SafeTeamworkEmitterPointer;
  48
  49 class IconCache;
  50
  51 class KDevSystemMessage : public SystemMessage {
  52     DECLARE_MESSAGE( KDevSystemMessage, SystemMessage, 5 );
  53   public:
  54     enum Message {
  55       CollaborationAccepted,
  56       CollaborationRefused,
  57       CollaborationClosed,
  58       ActionFailed,     ///An Action failed
  59       ActionSuccessful,
  60       ActionDenied
  61   };
  62     KDevSystemMessage( InArchive& arch, const Teamwork::MessageInfo& info );
  63
  64     KDevSystemMessage( const Teamwork::MessageConstructionInfo& info, Message msg , const string& str = "" );
  65
  66     Message message();
  67
  68     QString messageAsString();
  69
  70     QString text();
  71 };
  72
  73 typedef SafeSharedPtr<KDevSystemMessage> KDevSystemMessagePointer;
  74
  75 struct AbstractGUIMessage {
  76   QVariant data; ///@todo remove
  77   virtual QString messageText() const = 0;
  78   virtual QIcon messageIcon() const;
  79   virtual void fillContextMenu( QMenu* /*menu*/, KDevTeamwork* /*teamwork*/ ) {}
  80   ;
  81   virtual ~AbstractGUIMessage() {}
  82   ;
  83   virtual bool show() {
  84     return true;
  85   }
  86   virtual QString shortName() const {
  87     return "Message";
  88   }
  89   ///This should return an icon that represents the message-type and has nothing to do with the message-instance
  90   virtual QIcon messageTypeIcon() const;
  91
  92   virtual bool canShowInWidget() {
  93     return false;
  94   }
  95
  96   virtual void showInWidget( QWidget* /*widget*/, KDevTeamwork* /*tw*/ ) {}
  97 };
  98
  99 class KDevTeamworkTextMessage : public TextMessage, public AbstractGUIMessage {
 100     DECLARE_MESSAGE( KDevTeamworkTextMessage, TextMessage, 6 );
 101   public:
 102
 103     KDevTeamworkTextMessage( const Teamwork::MessageConstructionInfo& info, const QString& text );
 104
 105     KDevTeamworkTextMessage( InArchive& from, const Teamwork::MessageInfo& info );
 106
 107     virtual QString messageText() const;
 108
 109     virtual QIcon messageIcon() const;
 110
 111     void setAnswered( bool );
 112
 113     bool answered() const;
 114
 115     virtual void serialize( OutArchive& arch );
 116
 117     virtual bool needReply() const;
 118
 119     QDateTime creationTime();
 120
 121     virtual bool canShowInWidget();
 122
 123     ///If this returns false, the widget is not shown.
 124     virtual void showInWidget( QWidget* widget, KDevTeamwork* tw );
 125
 126   private:
 127     QDateTime creationTime_;
 128     bool m_answered;
 129 };
 130
 131 ///Just a dummy for compatible insertion of error-messages to the message-list
 132 class FailureMessage : public KDevTeamworkTextMessage {
 133   public:
 134   FailureMessage( const QString& text, const MessagePointer& msg );
 135
 136   virtual QIcon messageIcon() const;
 137 };
 138
 139 class ConnectionRequest : public KDevTeamworkTextMessage {
 140   public:
 141     enum State {
 142       Waiting,
 143       Denied,
 144       Accepted,
 145       Unknown
 146   };
 147
 148     ConnectionRequest( const Teamwork::MessageConstructionInfo& info, const Teamwork::UserPointer& self, const Teamwork::UserPointer& target, const QString& text, KDevTeamwork* teamwork );
 149
 150     ConnectionRequest( InArchive& arch, const Teamwork::MessageInfo& info );
 151
 152     virtual void serialize( OutArchive& arch );
 153
 154     const Teamwork::User& user();
 155
 156     virtual bool needReply() const;
 157
 158     virtual QIcon messageIcon() const;
 159
 160     virtual ReplyResult gotReply( const MessagePointer& /*p*/ );
 161
 162     void setState( State s );
 163
 164     State state();
 165
 166     virtual void fillContextMenu( QMenu* menu, KDevTeamwork* teamwork );
 167   private:
 168     DECLARE_MESSAGE( ConnectionRequest, KDevTeamworkTextMessage, 1 );
 169     Teamwork::User user_;
 170     State m_state;
 171     SafeTeamworkEmitterPointer m_emitter;
 172 };
 173
 174 BOOST_CLASS_IMPLEMENTATION( NoData, boost::serialization::object_serializable )
 175
 176 EASY_DECLARE_MESSAGE( CollaborationMessage, TextMessage, 9, NoData, 0 );
 177
 178 typedef SafeSharedPtr<CollaborationMessage> CollaborationMessagePointer;
 179
 180 UserPointer userFromSession( const SessionPointer& session );
 181
 182 typedef KDevTeamworkTextMessage KDevTeamworkMessages;
 183
 184 //typedef Teamwork::Binder<Teamwork::AllTeamworkClientMessages, KDevTeamworkMessages >::Append<ConnectionRequest>::Result::Append<KDevSystemMessage>::Result::Append<KDevSystemMessage>::Result AllKDevTeamworkMessages;
 185
 186 #endif
 187
 188 // kate: space-indent on; indent-width 2; tab-width 2; replace-tabs on