kopeteonlinestatus.h

Go to the documentation of this file.

/*
    kopeteonlinestatus.h - Kopete Online Status

    Copyright (c) 2003      by Martijn Klingens <klingens@kde.org>
    Copyright (c) 2003      by Duncan Mac-Vicar Prett <duncan@kde.org>
    Copyright (c) 2003      by Will Stephenson <wstephenson@kde.org>
    Copyright (c) 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 kopeteonlinestatus_h
#define kopeteonlinestatus_h

#include "kopete_export.h"

#include <kdemacros.h>
#include <ksharedptr.h>
#include <kiconloader.h>

#include <QtCore/QObject>
#include <QtCore/QFlags>
#include <QtGui/QIcon>

#include "kopeteonlinestatusmanager.h"

class QString;
class QPixmap;
class QColor;

namespace Kopete
{
    class OnlineStatusManager;

    class Identity;
    class Protocol;
    class Account;
    class Contact;

class KOPETE_EXPORT OnlineStatus
{
public:
    enum StatusType
    {
        Unknown=0,
        Offline=10,
        Connecting=20,
        Invisible=30,
        Away=40,
        Busy=45,
        Online=50
    };
    // note than Unknown is first, because the metacontact algorithm to detect
    // the metacontact status from the contact status starts from Unknown, and
    // takes a contact only if its status is greater

    enum ReservedInternalStatus
    {
        AccountOffline = 0x80000001
    };


    OnlineStatus();


    OnlineStatus( StatusType status, unsigned weight, Protocol *protocol,
        unsigned internalStatus, const QStringList &overlayIcons, const QString &description );

    OnlineStatus( StatusType status, unsigned weight, Protocol *protocol, unsigned internalStatus, const QStringList &overlayIcon,
        const QString &description, const QString& caption, OnlineStatusManager::Categories categories = 0x0 , OnlineStatusManager::Options options = 0x0 );


    OnlineStatus( StatusType status ); /* implicit */

    OnlineStatus( const OnlineStatus &other );

    ~OnlineStatus();

    StatusType status() const;

    unsigned internalStatus() const;

    unsigned weight() const;

    QStringList overlayIcons() const;

    QString description() const;

    Protocol* protocol() const;

    QString caption() const;

    OnlineStatusManager::Categories categories() const;

    OnlineStatusManager::Options options() const;

    bool isDefinitelyOnline() const;


    

    QIcon iconFor( const Contact *contact ) const;

    KDE_DEPRECATED QPixmap iconFor( const Contact *contact, int size ) const
    { return iconFor(contact).pixmap(size); }

    QString mimeSourceFor( const Contact *contact, int size = 16 ) const;

    QIcon iconFor( const Account *account ) const;

    KDE_DEPRECATED QPixmap iconFor( const Account *account, int size  ) const
    { return iconFor(account).pixmap(size); }

    QString mimeSourceFor( const Account *account, int size = 16 ) const;

    QPixmap iconFor( const QString &mimeSource ) const;

    QPixmap protocolIcon(const KIconLoader::StdSizes size) const;

    KDE_DEPRECATED QPixmap protocolIcon() const;

    OnlineStatus & operator=( const OnlineStatus &other );

    bool operator==( const OnlineStatus &other ) const;

    bool operator!=( const OnlineStatus &other ) const;

    bool operator>( const OnlineStatus &other ) const;

    bool operator<( const OnlineStatus &other ) const;

     static QString statusTypeToString(OnlineStatus::StatusType status);

     static OnlineStatus::StatusType statusStringToType(const QString& string);



private:

    class Private;
    KSharedPtr<Private> d;

    QString mimeSource( const QString& icon, int size, QColor color, bool idle) const;


};

}  //END namespace Kopete

#endif