plugin.h

/*
   This file is part of KDE Kontact.
 
   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 KONTACT_PLUGIN_H
#define KONTACT_PLUGIN_H
 
#include <tqobject.h>
#include <kxmlguiclient.h>
#include <tdemacros.h>
#include <tqptrlist.h>
 
class TQStringList;
class DCOPClient;
class DCOPObject;
class TDEAboutData;
class TDEAction;
class TDEConfig;
class TQWidget;
namespace KParts { class ReadOnlyPart; }

#define KONTACT_PLUGIN_VERSION 6
 
namespace Kontact
{
 
class Core;
class Summary;

class TDE_EXPORT Plugin : public TQObject, virtual public KXMLGUIClient
{
  TQ_OBJECT
 
  public:
    Plugin( Core *core, TQObject *parent, const char *name );
 
    virtual ~Plugin();

    void setIdentifier( const TQString &identifier );

    TQString identifier() const;

    void setTitle( const TQString &title );

    TQString title() const;

    void setIcon( const TQString &icon );

    TQString icon() const;

    void setExecutableName( const TQString &bin );

    TQString executableName() const;

    void setPartLibraryName( const TQCString & );

    virtual bool createDCOPInterface( const TQString& /*serviceType*/ ) { return false; }

    virtual bool isRunningStandalone() { return false; }

    virtual void bringToForeground();

    virtual const TDEAboutData *aboutData();

    KParts::ReadOnlyPart *part();

    virtual TQString tipFile() const;

    virtual void select();

    virtual void configUpdated();

    virtual Summary *createSummaryWidget( TQWidget * /*parent*/ ) { return 0; }

    virtual bool showInSideBar() const;

    void setShowInSideBar( bool hasPart );

    virtual bool queryClose() const { return true; }

    DCOPClient *dcopClient() const;

    virtual int weight() const { return 0; }

    void insertNewAction( TDEAction *action );

    void insertSyncAction( TDEAction *action );

    TQPtrList<TDEAction>* newActions() const;

    TQPtrList<TDEAction>* syncActions() const;

    virtual TQStringList invisibleToolbarActions() const { return TQStringList(); }

    virtual bool canDecodeDrag( TQMimeSource * ) { return false; }

    virtual void processDropEvent( TQDropEvent * ) {}
 
    virtual void loadProfile( const TQString& directoryPath );
 
    virtual void saveToProfile( const TQString& directoryPath ) const;

    virtual void readProperties( TDEConfig * ) {}

    virtual void saveProperties( TDEConfig * ) {}
 
    Core *core() const;
 
    bool disabled() const;
    void setDisabled( bool v );
 
  public slots:
    void slotConfigUpdated();
 
  protected:
    virtual KParts::ReadOnlyPart *createPart() = 0;
 
    KParts::ReadOnlyPart *loadPart();
 
    virtual void virtual_hook(  int id, void* data );
 
  private slots:
    void partDestroyed();
 
  private:
    class Private;
    Private *d;
};
 
}
 
#endif