kopeteavatarmanager.h

Go to the documentation of this file.

/*
    kopeteavatarmanager.h - Global avatar manager

    Copyright (c) 2007      by Michaël Larouche      <larouche@kde.org>

    Kopete    (c) 2002-2007 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 KOPETE_AVATARMANAGER_H
#define KOPETE_AVATARMANAGER_H

#include <QtCore/QObject>
#include <QtCore/QList>
#include <QtGui/QImage>
#include <kjob.h>
#include "kopete_export.h"

class QImage;

namespace Kopete
{

class Contact;
class KOPETE_EXPORT AvatarManager : public QObject
{
    Q_OBJECT
public:
    enum AvatarCategoryType
    {
        User=1, 
        Contact, 
        All = User | Contact 
    };
    Q_DECLARE_FLAGS(AvatarCategory, AvatarCategoryType)

    
    typedef struct AvatarEntry
    {
        QString name; 
        QString path; 
        QImage image; 
        QByteArray data; 
        QString dataPath; 
        Kopete::Contact *contact; 
        AvatarManager::AvatarCategory category; 
    } AvatarEntry;

public:
    ~AvatarManager();

    static AvatarManager *self();

Q_SIGNALS:
    void avatarAdded(Kopete::AvatarManager::AvatarEntry newEntry);

    void avatarRemoved(Kopete::AvatarManager::AvatarEntry entryRemoved);

public Q_SLOTS:
    Kopete::AvatarManager::AvatarEntry add(Kopete::AvatarManager::AvatarEntry newEntry);

    bool remove(Kopete::AvatarManager::AvatarEntry entryToRemove);

    bool exists(Kopete::AvatarManager::AvatarEntry avatarToCheck);

    bool exists(const QString &avatarName);

private:
    AvatarManager(QObject *parent = 0);

private:
    static AvatarManager *s_self;

    class Private;
    Private * const d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(Kopete::AvatarManager::AvatarCategory)


// TODO: Use new Kopete::Task or KCompositeJob
class KOPETE_EXPORT AvatarQueryJob : public KJob
{
    Q_OBJECT
public:
    AvatarQueryJob(QObject *parent = 0);
    ~AvatarQueryJob();

    void setQueryFilter(Kopete::AvatarManager::AvatarCategory category);

    virtual void start();

    QList<Kopete::AvatarManager::AvatarEntry> avatarList() const;

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

}

#endif