kopeteprotocol.h

Go to the documentation of this file.

/*
    kopeteprotocol.h - Kopete Protocol

    Copyright (c) 2002      by Duncan Mac-Vicar Prett <duncan@kde.org>
    Copyright (c) 2002-2003 by Martijn Klingens       <klingens@kde.org>
    Copyright (c) 2002-2005 by Olivier Goffart        <ogoffart@kde.org>
    Copyright (c) 2007      by Michaël Larouche       <larouche@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 KOPETEPROTOCOL_H
#define KOPETEPROTOCOL_H

#include <QtCore/QFlags>

#include "kopeteplugin.h"
#include "kopeteonlinestatus.h"

class KopeteEditAccountWidget;
class AddContactPage;
class KJob;

#include "kopete_export.h"

namespace Kopete
{

class Contact;
class MetaContact;
class Account;

/*namespace UI
{
    class EditAccountWidget;
    class AddContactPage;
}*/


class KOPETE_EXPORT Protocol : public Plugin
{
    Q_OBJECT

public:

    virtual ~Protocol();

    virtual Account *createNewAccount( const QString &accountId ) = 0;

    virtual AddContactPage *createAddContactWidget( QWidget *parent, Account *account ) = 0;

    virtual KopeteEditAccountWidget * createEditAccountWidget( Account *account, QWidget *parent ) = 0;

    enum Capability
    {
        BaseFgColor = 0x1,     
        BaseBgColor = 0x2,     
        RichFgColor = 0x4,       
        RichBgColor = 0x8,       

        BaseFont = 0x10,        
        RichFont = 0x20,       

        BaseUFormatting = 0x40,
        BaseIFormatting = 0x80,
        BaseBFormatting = 0x100,

        RichUFormatting = 0x200,
        RichIFormatting = 0x400,
        RichBFormatting = 0x800,

        Alignment = 0x1000,     

        BaseFormatting = BaseIFormatting | BaseUFormatting | BaseBFormatting,

        RichFormatting = RichIFormatting | RichUFormatting | RichBFormatting,

        RichColor = RichBgColor | RichFgColor,
        BaseColor = BaseBgColor | BaseFgColor,

        //Shortcut for All of the above - full HTML
        FullRTF =  RichFormatting | Alignment | RichFont | RichFgColor | RichBgColor ,


        CanSendOffline = 0x10000 
    };
    Q_DECLARE_FLAGS(Capabilities, Capability)

    
    Capabilities capabilities() const;

    bool canAddMyself() const;
    
    Kopete::OnlineStatus accountOfflineStatus() const;


protected:
    Protocol( const KComponentData &instance, QObject *parent, bool canAddMyself = false );

    void setCapabilities( Capabilities );

public:

    virtual void aboutToUnload();

private slots:
    void slotAccountOnlineStatusChanged( Kopete::Contact *self );

    void slotAccountDestroyed(  );


public:

    virtual void deserialize( MetaContact *metaContact, const QMap<QString, QString> &serializedData );

    virtual void deserializeContactList( MetaContact *metaContact, const QList< QMap<QString, QString> > &dataList );

    virtual Contact *deserializeContact( MetaContact *metaContact,
        const QMap<QString, QString> &serializedData,
        const QMap<QString, QString> &addressBookData );

    virtual KJob *createProtocolTask(const QString &taskType);

     virtual bool validatePassword( const QString & password ) const;

public:
    void serialize( Kopete::MetaContact *metaContact );


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

Q_DECLARE_OPERATORS_FOR_FLAGS(Protocol::Capabilities)

} //END namespace kopete

#endif