mucroomconfighandler.h

/*
  Copyright (c) 2006-2009 by Jakob Schroeter <js@camaya.net>
  This file is part of the gloox library. http://camaya.net/gloox

  This software is distributed under a license. The full license
  agreement can be found in the file LICENSE in this distribution.
  This software may not be copied, modified, sold or distributed
  other than expressed in the named license agreement.

  This software is distributed without any warranty.
*/



#ifndef MUCROOMCONFIGHANDLER_H__
#define MUCROOMCONFIGHANDLER_H__

#include "gloox.h"
#include "jid.h"

#include <string>
#include <list>

namespace gloox
{

  class MUCRoom;
  class DataForm;

  class MUCListItem
  {
    public:
      MUCListItem( const JID& jid )
        : m_jid( jid ), m_affiliation( AffiliationInvalid ), m_role( RoleInvalid )
      {}

      MUCListItem( const JID& jid, MUCRoomRole role, MUCRoomAffiliation affiliation,
                   const std::string& nick )
        : m_jid( jid ), m_nick( nick ), m_affiliation( affiliation ), m_role( role )
      {}

      MUCListItem( const std::string& nick, MUCRoomAffiliation affiliation, const std::string& reason )
        : m_nick( nick ), m_affiliation( affiliation ), m_role( RoleInvalid ),
          m_reason( reason )
      {}

      MUCListItem( const std::string& nick, MUCRoomRole role, const std::string& reason )
        : m_nick( nick ), m_affiliation( AffiliationInvalid ), m_role( role ),
          m_reason( reason )
      {}

      ~MUCListItem() {}

      const JID& jid() const { return m_jid; }

      const std::string& nick() const { return m_nick; }

      MUCRoomAffiliation affiliation() const { return m_affiliation; }

      MUCRoomRole role() const { return m_role; }

      const std::string& reason() const { return m_reason; }

    private:
      JID m_jid;                   
      std::string m_nick;           
      MUCRoomAffiliation m_affiliation; 
      MUCRoomRole m_role;           
      std::string m_reason;         
  };

  typedef std::list<MUCListItem> MUCListItemList;

  enum MUCOperation
  {
    RequestUniqueName,              
    CreateInstantRoom,              
    CancelRoomCreation,             
    RequestRoomConfig,              
    SendRoomConfig,                 
    DestroyRoom,                    
    GetRoomInfo,                    
    GetRoomItems,                   
    SetRNone,                       
    SetVisitor,                     
    SetParticipant,                 
    SetModerator,                   
    SetANone,                       
    SetOutcast,                     
    SetMember,                      
    SetAdmin,                       
    SetOwner,                       
    RequestVoiceList,               
    StoreVoiceList,                 
    RequestBanList,                 
    StoreBanList,                   
    RequestMemberList,              
    StoreMemberList,                
    RequestModeratorList,           
    StoreModeratorList,             
    RequestOwnerList,               
    StoreOwnerList,                 
    RequestAdminList,               
    StoreAdminList,                 
    InvalidOperation                
  };

  class GLOOX_API MUCRoomConfigHandler
  {
    public:
      virtual ~MUCRoomConfigHandler() {}

      virtual void handleMUCConfigList( MUCRoom* room, const MUCListItemList& items,
                                        MUCOperation operation ) = 0;

      virtual void handleMUCConfigForm( MUCRoom* room, const DataForm& form ) = 0;

      virtual void handleMUCConfigResult( MUCRoom* room, bool success, MUCOperation operation ) = 0;

      virtual void handleMUCRequest( MUCRoom* room, const DataForm& form ) = 0;

  };

}

#endif // MUCROOMCONFIGHANDLER_H__