rosteritem.h

/*
  Copyright (c) 2004-2008 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 ROSTERITEM_H__
#define ROSTERITEM_H__

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

#include <string>
#include <list>


namespace gloox
{

  class GLOOX_API RosterItem
  {
    friend class RosterManager;

    public:
      typedef std::map<std::string, Resource*> ResourceMap;

      enum SubscriptionEnum
      {
        S10nNone,            
        S10nNoneOut,         
        S10nNoneIn,          
        S10nNoneOutIn,       
        S10nTo,              
        S10nToIn,            
        S10nFrom,            
        S10nFromOut,         
        S10nBoth              
      };

      RosterItem( const JID& jid, const std::string& name = "" );

      virtual ~RosterItem();

      virtual void setName( const std::string& name );

      virtual const std::string& name() const { return m_name; }

      virtual const std::string& jid() const { return m_jid; }

      virtual SubscriptionEnum subscription() const { return m_subscription; }

      virtual void setGroups( const StringList& groups );

      virtual const StringList& groups() const { return m_groups; }

      virtual bool changed() const { return m_changed; }

      virtual bool online() const;

      virtual const ResourceMap& resources() const { return m_resources; }

      virtual const Resource* resource( const std::string& res ) const;

    protected:
      virtual void setPresence( const std::string& resource, Presence presence );

      virtual void setStatus( const std::string& resource, const std::string& msg );

      virtual void setPriority( const std::string& resource, int priority );

      virtual void setSubscription( const std::string& subscription, bool ask );

      virtual void setSynchronized() { m_changed = false; }

      virtual void removeResource( const std::string& resource );

    private:
      StringList m_groups;
      ResourceMap m_resources;
      SubscriptionEnum m_subscription;
      std::string m_name;
      std::string m_jid;
      bool m_changed;
  };

}

#endif // ROSTERITEM_H__