kopetemetacontact.h

Go to the documentation of this file.

/*
    kopetemetacontact.h - Kopete Meta Contact

    Copyright (c) 2002-2003 by Martijn Klingens       <klingens@kde.org>
    Copyright (c) 2002-2005 by Duncan Mac-Vicar Prett <duncan@kde.org>
    Copyright (c) 2002-2005 by Olivier Goffart        <ogoffart@kde.org>
    Copyright (c) 2003      by Will Stephenson        <will@stevello.free-online.co.uk>

    Kopete    (c) 2002-2005 by the Kopete developers  <kopete-devel@kde.org>

    *************************************************************************
    *                                                                       *
    * This library is free software; you can redistribute it and/or         *
    * modify it under the terms of the GNU Lesser General Public            *
    * License as published by the Free Software Foundation; either          *
    * version 2 of the License, or (at your option) any later version.      *
    *                                                                       *
    *************************************************************************
*/

#ifndef kopetemetacontact_h__
#define kopetemetacontact_h__

#include "kopetecontactlistelement.h"

#include <QtCore/QList>
#include <QtCore/QUuid>

#include <kdemacros.h>
#include <kurl.h>
#include "kopete_export.h"

#include "kopeteonlinestatus.h"
#include "kopetestatusmessage.h"

namespace Kopete {


class Plugin;
class Group;
class Picture;

class KOPETE_EXPORT MetaContact : public ContactListElement
{
    Q_OBJECT

    Q_PROPERTY( QString displayName READ displayName WRITE setDisplayName )
    Q_PROPERTY( QString statusString READ statusString )
    Q_PROPERTY( QString statusIcon READ statusIcon )
    Q_PROPERTY( bool isOnline READ isOnline )
    Q_PROPERTY( bool isReachable READ isReachable )
    Q_PROPERTY( bool isTemporary READ isTemporary )
    Q_PROPERTY( bool canAcceptFiles READ canAcceptFiles )
    //Q_PROPERTY( ulong idleTime READ idleTime )
    Q_PROPERTY( QUuid metaContactId READ metaContactId WRITE setMetaContactId )
    Q_PROPERTY( bool photoSyncedWithKABC READ isPhotoSyncedWithKABC WRITE setPhotoSyncedWithKABC )

public:
    typedef QList<MetaContact *> List;
    enum PropertySource { 
        SourceContact , 
        SourceKABC , 
        SourceCustom 
    };

    MetaContact();
    ~MetaContact();

    QUuid metaContactId() const;
  
    void setMetaContactId( const QUuid& newMetaContactId );

    QString kabcId() const;

    void setKabcId( const QString& newKabcId );

    QList<Contact *> contacts() const;

    QList<Group *> groups() const;

    Contact *findContact( const QString &protocolId, const QString &accountId, const QString &contactId );

    void setDisplayNameSource(PropertySource source);

    void setDisplayNameSource( const QString &nameSourcePID, const QString &nameSourceAID, const QString &nameSourceCID );

    PropertySource displayNameSource() const;

    void setPhotoSource(PropertySource source);

    void setPhotoSource( const QString &photoSourcePID, const QString &photoSourceAID, const QString &photoSourceCID );

    PropertySource photoSource() const;

    QString displayName() const;

    KDE_DEPRECATED QImage photo() const;

    Picture &picture() const;

    void setDisplayName( const QString &name );

    QString customDisplayName() const;

    KUrl customPhoto() const;


    void setPhoto( const KUrl &url );

    Contact *displayNameSourceContact() const;

    void setDisplayNameSourceContact( Contact* contact );

    Contact *photoSourceContact() const;

    void setPhotoSourceContact( Contact* contact );

    bool isPhotoSyncedWithKABC() const;

    void setPhotoSyncedWithKABC(bool b);


    bool isTemporary() const;

    void addContact( Contact *c );

    void removeContact( Contact *c , bool deleted = false );

    Contact *preferredContact();

    QString statusIcon() const;

    QString statusString() const;

    bool isOnline() const;

    bool isAlwaysVisible() const;

    bool canAcceptFiles() const;

    OnlineStatus::StatusType status() const;

    bool isReachable() const;

    quint32 idleTime() const;

    QString addressBookField( Plugin *p, const QString &app, const QString &key ) const;

    void setAddressBookField( Plugin *p, const QString &app, const QString &key, const QString &value );

    StatusMessage statusMessage() const;

public slots:

    void sendFile( const KUrl &sourceURL, const QString &altFileName = QString(),
        unsigned long fileSize = 0L );

    void serialize();

signals:
    void contactIdleStateChanged( Kopete::Contact *contact );

    void statusMessageChanged( Kopete::MetaContact *metaContact );

public slots:

    void moveToGroup( Kopete::Group *from, Kopete::Group *to );

    void removeFromGroup( Kopete::Group *from );

    void addToGroup( Kopete::Group *to );

    void setTemporary( bool b = true, Kopete::Group *group = 0L );

    Contact *execute();

    Contact *sendMessage();

    Contact *startChat();

    void slotAllPluginsLoaded();

    void slotPluginLoaded( Kopete::Plugin *plugin );

    void slotProtocolLoaded( Kopete::Protocol *p );

signals:
    void onlineStatusChanged( Kopete::MetaContact *contact, Kopete::OnlineStatus::StatusType status );

    void contactStatusChanged( Kopete::Contact *contact, const Kopete::OnlineStatus &status );

    void displayNameChanged( const QString &oldName, const QString &newName );

    void photoChanged();

    void movedToGroup( Kopete::MetaContact *contact, Kopete::Group *from, Kopete::Group *to );

    void removedFromGroup( Kopete::MetaContact *contact, Kopete::Group *group );

    void addedToGroup( Kopete::MetaContact *contact, Kopete::Group *to );

    void contactAdded( Kopete::Contact *c );

    void contactRemoved( Kopete::Contact *c );

    void persistentDataChanged(  );

private slots:
    void updateOnlineStatus();

    void slotContactStatusChanged( Kopete::Contact *c, const Kopete::OnlineStatus &status, const Kopete::OnlineStatus &oldStatus );

    void slotPropertyChanged( Kopete::PropertyContainer *contact, const QString &key, const QVariant &oldValue, const QVariant &newValue  );

    void slotContactDestroyed( Kopete::Contact* );

    void slotUpdateAddressBookPicture();

protected:
    //QImage photoFromContact( Kopete::Contact *c) const;
    //QImage photoFromKABC( const QString &id ) const;
    QImage photoFromCustom() const;
    //QString nameFromContact( Kopete::Contact *c) const;
    //QString nameFromKABC( const QString &id ) const;

    void onlineStatusNotification( Kopete::Contact * c );

private:
    class Private;
    Private * const d;
};

// util functions shared with metacontact property dialog
KOPETE_EXPORT QImage photoFromContact( Kopete::Contact *c) /*const*/;
KOPETE_EXPORT QImage photoFromKABC( const QString &id ) /*const*/;
KOPETE_EXPORT QString nameFromContact( Kopete::Contact *c) /*const*/;
KOPETE_EXPORT QString nameFromKABC( const QString &id ) /*const*/;

} //END namespace Kopete


#endif

// vim: set noet ts=4 sts=4 sw=4: