kopeteonlinestatusmanager.h

Go to the documentation of this file.

/*
    kopeteonlinestatusmanager.h

    Copyright (c) 2004-2005 by Olivier Goffart  <ogoffart@kde.org>

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

#include "kopete_export.h"

#include <QtCore/QObject>
#include <QtCore/QFlags>
#include <QtCore/QMap>

class QPixmap;
class QColor;
class KIcon;

namespace Kopete
{
    class OnlineStatus;
    class Protocol;


class KOPETE_EXPORT OnlineStatusManager : public QObject
{
    Q_OBJECT
public:
    static OnlineStatusManager* self();
    ~OnlineStatusManager();

    //please be carrefull when modifying values of status.  read comment in onlineStatus()
    enum Category
    {
        Idle=1<<8,  ExtendedAway=1<<9 , Invisible=1<<10,
        //  \     /             __________/
          /*1<<4*/    Busy=1<<5,           FreeForChat=1<<6,         /* 1<<7*/
        //   \       /                         /
             Away=1<<2,                   /* 1<<3 */
        //       \                           /
                        Online=1<<1,
        Offline=1
    };
    Q_DECLARE_FLAGS(Categories, Category)


    
    enum Option
    {
        HasStatusMessage = 0x01,
        DisabledIfOffline = 0x02,
        HideFromMenu = 0x04
    };
    Q_DECLARE_FLAGS(Options, Option)

    
    void registerOnlineStatus(const OnlineStatus& status);

    OnlineStatus onlineStatus(Protocol *protocol, Categories category) const;

    QList<OnlineStatus> registeredStatusList( Protocol *protocol ) const;

    static KIcon pixmapForCategory( Categories category );

    Kopete::OnlineStatusManager::Category initialStatus() const;

private:
    friend class OnlineStatus;
    friend class OnlineStatusIconEngine;
    QPixmap cacheLookupByObject( const OnlineStatus &statusFor, const QString& icon, int size, QColor color, bool idle = false);
    QPixmap cacheLookupByMimeSource( const QString &mimeSource );
    QString fingerprint( const OnlineStatus &statusFor, const QString& icon, int size, QColor color, bool idle = false);
    QPixmap* renderIcon( const OnlineStatus &statusFor, const QString& baseicon, int size, QColor color, bool idle = false) const;

signals:
    void iconsChanged();

private slots:
    void slotIconsChanged();

private:
    OnlineStatusManager();
    class Private;
    Private * const d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(OnlineStatusManager::Categories)
Q_DECLARE_OPERATORS_FOR_FLAGS(OnlineStatusManager::Options)

}  //END namespace Kopete

#endif

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