kopeteplugin.h

Go to the documentation of this file.

/*
    kopeteplugin.h - Kopete Plugin API

    Copyright (c) 2001-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) 2002-2003 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 KOPETEPLUGIN_H
#define KOPETEPLUGIN_H

#include <kxmlguiclient.h>
#include <QtCore/QObject>
#include <kdemacros.h>

#include "kopete_export.h"

class KPluginInfo;

namespace Kopete
{

class MetaContact;

class KOPETE_EXPORT Plugin : public QObject, public KXMLGUIClient
{
    Q_OBJECT

public:
    Plugin( const KComponentData &instance, QObject *parent );
    virtual ~Plugin();

    KPluginInfo pluginInfo() const;

    QString pluginIcon() const;

    QString displayName() const;

    QString pluginId() const;

    QStringList addressBookFields() const;

    QString addressBookIndexField() const;

    enum AddressBookFieldAddMode { AddOnly, MakeIndexField };

    void addAddressBookField( const QString &field, AddressBookFieldAddMode mode = AddOnly );

    virtual void aboutToUnload();

    Q_INVOKABLE bool showCloseWindowMessage();

    Q_INVOKABLE bool shouldExitOnclose();

signals:
    void settingsChanged();

    void readyForUnload();

public slots:

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

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


} //END namespace Kopete


#endif