kopetecontact.h

Go to the documentation of this file.

/*
    kopetecontact.h - Kopete Contact

    Copyright (c) 2002-2004 by Duncan Mac-Vicar Prett <duncan@kde.org>
    Copyright (c) 2002-2003 by Martijn Klingens       <klingens@kde.org>
    Copyright (c) 2002-2004 by Olivier Goffart        <ogoffart@kde.org>

    Kopete    (c) 2002-2004 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 KOPETECONTACT_H
#define KOPETECONTACT_H

#include "kopetecontactlistelement.h"
#include "kopetepropertycontainer.h"

#include <kurl.h>
#include <kdemacros.h>
#include <ktoggleaction.h>
#include "kopeteglobal.h"

#include "kopete_export.h"

class KMenu;
class KAction;

namespace Kopete
{

class Group;
class MetaContact;
class ChatSession;
class OnlineStatus;
class Plugin;
class Protocol;
class Account;
class StatusMessage;

typedef QList<Group *> GroupList;

class KOPETE_EXPORT Contact
    : public ContactListElement
{
    Q_OBJECT

    Q_ENUMS( CanCreateFlags )
    Q_PROPERTY( QString formattedName READ formattedName )
    Q_PROPERTY( QString formattedIdleTime READ formattedIdleTime )
    Q_PROPERTY( bool isOnline READ isOnline )
    Q_PROPERTY( bool fileCapable READ isFileCapable WRITE setFileCapable )
    Q_PROPERTY( bool canAcceptFiles READ canAcceptFiles )
    //Q_PROPERTY( bool isReachable READ isReachable )
    Q_PROPERTY( QString contactId READ contactId )
    Q_PROPERTY( QString icon READ icon WRITE setIcon )
    Q_PROPERTY( QString toolTip READ toolTip )
    Q_PROPERTY( QString nickName READ nickName WRITE setNickName )
    //Q_PROPERTY( unsigned long idleTime READ idleTime WRITE setIdleTime )

public: 
    enum Changed{ MovedBetweenGroup = 0x01, 
              DisplayNameChanged = 0x02 
    };

    enum NameType {
        NickName,   
        CustomName, 
        FormattedName,  
        ContactId,  
    };

    static NameType nameTypeFromString(const QString &nameType);
    static const QString nameTypeToString(NameType nameType);

    Contact( Account *account, const QString &id, MetaContact *parent,
        const QString &icon = QString() );

    ~Contact();

    MetaContact *metaContact() const;


    QString contactId() const;

    Protocol* protocol() const;

    Account* account() const;

    void setMetaContact(MetaContact *m);

    bool isOnline() const;

    // FIXME: After KDE 3.2 we should split this into a public, NON-virtual
    //        isReachable() accessor that checks for account->isConnected()
    //        and then calls a new virtual method that does the
    //        protocol-specific work, like 'doIsUnreachable' or so - Martijn
    //
    //FIXME: Can this be made const please? - JK
    virtual bool isReachable();

    virtual void serialize( QMap<QString, QString> &serializedData, QMap<QString, QString> &addressBookData );

    OnlineStatus onlineStatus() const;

    void setOnlineStatus(const OnlineStatus &status);

    Kopete::StatusMessage statusMessage() const;
    void setStatusMessage(const Kopete::StatusMessage &statusMessage);
     
    virtual QList<KAction *> *customContextMenuActions();

    virtual KDE_DEPRECATED QList<KAction *> *customContextMenuActions( ChatSession *manager );

    KMenu *popupMenu();

    KDE_DEPRECATED KMenu *popupMenu( ChatSession *manager );

    bool isFileCapable() const;

    void setFileCapable( bool filecap );

    bool canAcceptFiles() const;

    enum CanCreateFlags {  CannotCreate=false , CanCreate=true  };

    virtual ChatSession * manager( CanCreateFlags canCreate = CannotCreate ) =0;

    QString& icon() const;

    void setIcon( const QString& icon );

    virtual unsigned long int idleTime() const;

    void setIdleTime(unsigned long int);

    void setNickName( const QString &name );

    QString nickName() const;

    void setCustomName( const QString &name );

    QString customName() const;

    void setPreferredNameType(NameType type);

    NameType preferredNameType() const;

    QString displayName() const;

    QString toolTip() const;

    QString formattedName() const;

    QString formattedIdleTime() const;

    void setPhoto(const QString &photoPath);

public slots:
    void startChat();

    void sendMessage();

    void execute();

    void toggleAlwaysVisible();

    void changeMetaContact();
    virtual void slotUserInfo() {}

    virtual void sync(unsigned int changed = 0xFF);

    virtual KDE_DEPRECATED void deleteContact();

    virtual void sendFile( const KUrl &sourceURL = KUrl(),
                   const QString &fileName = QString(), uint fileSize = 0L );
private slots:
    void slotAddContact();

    void slotDelete();

    void slotBlock();

    void slotUnblock();

    void slotAccountIsConnectedChanged();

    void slotMetaContactDestroyed( QObject* mc );

    void slotPropertyChanged(Kopete::PropertyContainer *, const QString &key, const QVariant &oldValue, const QVariant &newValue);
signals:
    void onlineStatusChanged( Kopete::Contact *contact,
        const Kopete::OnlineStatus &status, const Kopete::OnlineStatus &oldStatus );

    void statusMessageChanged( Kopete::Contact *contact );

    void contactDestroyed( Kopete::Contact *contact );

    void idleStateChanged( Kopete::Contact *contact );

    void canAcceptFilesChanged();

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

private:
    class Private;
    Private * const d;


};


} //END namespace Kopete

#endif