kopeteaccount.h

Go to the documentation of this file.

/*
    kopeteaccount.h - Kopete Account

    Copyright (c) 2007      by Gustavo Pichorim Boiko <gustavo.boiko@kdemail.net>
    Copyright (c) 2003-2005 by Olivier Goffart       <ogoffart@kde.org>
    Copyright (c) 2003-2004 by Martijn Klingens      <klingens@kde.org>
    Copyright (c) 2004      by Richard Smith         <kde@metafoo.co.uk>

    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 KOPETEACCOUNT_H
#define KOPETEACCOUNT_H

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

#include <QtCore/QObject>
#include <QtGui/QPixmap>
#include <QtCore/QHash>

#include <kconfiggroup.h>
#include <kiconloader.h>
#include <solid/networking.h>

class KActionMenu;
class KConfigGroup;

namespace Kopete
{
class Contact;
class Protocol;
class MetaContact;
class Group;
class OnlineStatus;
class BlackLister;
class StatusMessage;
class Identity;
class PropertyContainer;

class KOPETE_EXPORT Account : public QObject
{
    Q_OBJECT

    Q_ENUMS( AddMode )
    Q_PROPERTY( QString accountId READ accountId )
    Q_PROPERTY( bool excludeConnect READ excludeConnect WRITE setExcludeConnect )
    Q_PROPERTY( QColor color READ color WRITE setColor )
    Q_PROPERTY( QPixmap accountIcon READ accountIcon )
    Q_PROPERTY( bool isConnected READ isConnected )
    Q_PROPERTY( bool isAway READ isAway )
    Q_PROPERTY( bool suppressStatusNotification READ suppressStatusNotification )
    Q_PROPERTY( uint priority READ priority WRITE setPriority )

public:
    enum DisconnectReason {
        OtherClient = -4,    
        BadPassword = -3,    
        BadUserName = -2,    
        InvalidHost = -1,    
        Manual = 0,          
        ConnectionReset = 1, 
        Unknown = 99         
    };

    enum AddMode {
        ChangeKABC = 0,     
        DontChangeKABC = 1, 
        Temporary = 2       
    };

    enum OnlineStatusOption {
        None = 0x00,               
        KeepSpecialFlags = 0x01    
    };
    Q_DECLARE_FLAGS(OnlineStatusOptions, OnlineStatusOption)

    
    Account(Protocol *parent, const QString &accountID);

    ~Account();

    Protocol *protocol() const ;

    QString accountId() const;

    QString accountLabel() const;

    uint priority() const;

    void setPriority( uint priority );

    void setExcludeConnect(bool);

    bool excludeConnect() const;

    const QColor color() const;

    void setColor( const QColor &color);

    QPixmap accountIcon( const int size = 0 ) const;

    /*
     * \brief Get the icon path for this account.
     *
     * This is the account icon path.
     *
     * @return the icon path for this account.
     */
    QString accountIconPath(const KIconLoader::Group size) const;

    void setCustomIcon( const QString& );
    
    QString customIcon() const;
    
    Identity * identity() const;

    virtual bool setIdentity( Kopete::Identity *ident );

    Contact * myself() const;

    virtual void fillActionMenu( KActionMenu *actionMenu );

    virtual bool hasCustomStatusMenu() const;

    const QHash<QString,Contact*>& contacts();

    bool suppressStatusNotification() const;

    MetaContact* addContact( const QString &contactId, const QString &displayName = QString(), Group *group = 0, AddMode mode = DontChangeKABC );

    bool addContact( const QString &contactId, MetaContact *parent, AddMode mode = DontChangeKABC );

    bool isConnected() const;

    bool isAway() const;

    bool isBusy() const;

    KConfigGroup *configGroup() const;

    virtual bool removeAccount();

    BlackLister* blackLister();

    virtual bool isBlocked( const QString &contactId );

protected:
    void setMyself( Contact *myself );

    virtual bool createContact( const QString &contactId, MetaContact *parentContact ) =0;


    void setAccountLabel( const QString &label );

protected slots:
    virtual void disconnected( Kopete::Account::DisconnectReason reason );

    void setAllContactsStatus( const Kopete::OnlineStatus &status );

    void networkingStatusChanged( const Solid::Networking::Status status );

signals:
    void colorChanged( const QColor & );

    void accountDestroyed( const Kopete::Account *account );

    void isConnectedChanged();

private:
    void readConfig();

public:
    bool registerContact( Contact *c );

public slots:
    virtual void connect( const Kopete::OnlineStatus& initialStatus = OnlineStatus() ) = 0;

    virtual void disconnect( ) = 0 ;

public slots:
    virtual void setOnlineStatus( const Kopete::OnlineStatus& status,
                                  const Kopete::StatusMessage &reason = Kopete::StatusMessage(),
                                  const OnlineStatusOptions& options = None ) = 0;
    virtual void setStatusMessage( const Kopete::StatusMessage &statusMessage ) = 0;

    bool suspend( const Kopete::StatusMessage &reason = Kopete::StatusMessage() );

    bool resume();

    void editAccount( QWidget* parent = 0L );

    virtual void block( const QString &contactId );

    virtual void unblock( const QString &contactId );

private slots:
    void reconnect();

    void contactDestroyed( Kopete::Contact * );

    void slotOnlineStatusChanged( Kopete::Contact *contact, const Kopete::OnlineStatus &newStatus, const Kopete::OnlineStatus &oldStatus );

    void slotContactPropertyChanged( Kopete::PropertyContainer *, const QString &, const QVariant &, const QVariant & );

    void slotStopSuppression();

private:
    class Private;
    Private * const d;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(Account::OnlineStatusOptions)

} //END namespace Kopete

#endif