plugin.h

/*
  This file is part of the KDE Kontact Plugin Interface Library.

  Copyright (c) 2001 Matthias Hoelzer-Kluepfel <mhk@kde.org>
  Copyright (c) 2002-2003 Daniel Molkentin <molkentin@kde.org>
  Copyright (c) 2003 Cornelius Schumacher <schumacher@kde.org>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/

#ifndef KONTACTINTERFACE_PLUGIN_H
#define KONTACTINTERFACE_PLUGIN_H

#include "kontactinterface_export.h"

#include <kpluginfactory.h>
#include <kxmlguiclient.h>

#include <QtCore/QList>
#include <QtCore/QObject>

class KAboutData;
class KAction;
class KConfig;
class KConfigGroup;
class QDropEvent;
class QMimeData;
class QStringList;
class QWidget;
namespace KParts {
  class ReadOnlyPart;
}

#define EXPORT_KONTACT_PLUGIN( pluginclass, pluginname ) \
class Instance                                           \
{                                                        \
  public:                                                \
    static QObject *createInstance( QWidget *, QObject *parent, const QVariantList &list ) \
    { return new pluginclass( static_cast<KontactInterface::Core*>( parent ), list ); } \
};                                                                    \
K_PLUGIN_FACTORY( KontactPluginFactory, registerPlugin< pluginclass >   \
                  ( QString(), Instance::createInstance ); )            \
K_EXPORT_PLUGIN( KontactPluginFactory( "kontact_" #pluginname "plugin" ) )

#define KONTACT_PLUGIN_VERSION 9

namespace KontactInterface {

class Core;
class Summary;

class KONTACTINTERFACE_EXPORT Plugin : public QObject, virtual public KXMLGUIClient
{
  Q_OBJECT

  public:
    Plugin( Core *core, QObject *parent, const char *appName, const char *pluginName = 0 );

    virtual ~Plugin();

    void setIdentifier( const QString &identifier );

    QString identifier() const;

    void setTitle( const QString &title );

    QString title() const;

    void setIcon( const QString &icon );

    QString icon() const;

    void setExecutableName( const QString &name );

    QString executableName() const;

    void setPartLibraryName( const QByteArray &name );

    virtual bool createDBUSInterface( const QString &serviceType );

    virtual bool isRunningStandalone() const;

    virtual void bringToForeground();

    virtual const KAboutData *aboutData() const;

    KParts::ReadOnlyPart *part();

    virtual QString tipFile() const;

    virtual void select();

    void aboutToSelect();

    virtual void configUpdated();

    virtual Summary *createSummaryWidget( QWidget *parent );

    virtual bool showInSideBar() const;

    void setShowInSideBar( bool hasPart );

    virtual bool queryClose() const;

    QString registerClient();

    virtual int weight() const;

    void insertNewAction( KAction *action );

    void insertSyncAction( KAction *action );

    QList<KAction*> newActions() const;

    QList<KAction*> syncActions() const;

    virtual QStringList invisibleToolbarActions() const;

    virtual bool canDecodeMimeData( const QMimeData *data ) const;

    virtual void processDropEvent( QDropEvent * );

    virtual void readProperties( const KConfigGroup & );

    virtual void saveProperties( KConfigGroup & );

    Core *core() const;

    void setDisabled( bool value );

    bool disabled() const;

    virtual void shortcutChanged();

  public Q_SLOTS:
    void slotConfigUpdated();

  protected:
    virtual KParts::ReadOnlyPart *createPart() = 0;

    KParts::ReadOnlyPart *loadPart();

    virtual void virtual_hook( int id, void *data );

  private:
    //@cond PRIVATE
    class Private;
    Private *const d;

    Q_PRIVATE_SLOT( d, void partDestroyed() )
    //@endcond
};

}

#endif