plugin.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org>
   Copyright (C) 2005 Dominik Haumann (dhdev@gmx.de) (documentation)

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

#include <QtCore/QObject>

#include <ktexteditor/ktexteditor_export.h>
#include <kservice.h>

class KConfig;

namespace KTextEditor
{

class Document;
class View;

class KTEXTEDITOR_EXPORT Plugin : public QObject
{
  Q_OBJECT

  public:
    Plugin ( QObject *parent );

    virtual ~Plugin ();

  /*
   * Following methodes allow the plugin to react on view and document
   * creation.
   */
  public:
    virtual void addDocument (Document *document) { Q_UNUSED(document); }

    virtual void removeDocument (Document *document) { Q_UNUSED(document); }

    virtual void addView (View *view) { Q_UNUSED(view); }

    virtual void removeView (View *view) { Q_UNUSED(view); }

  private:
    class PluginPrivate* const d;
};

#ifndef KDE_NO_DEPRECATED
KTEXTEDITOR_EXPORT_DEPRECATED Plugin *createPlugin ( KService::Ptr service, QObject *parent );
#endif

}

#endif

// kate: space-indent on; indent-width 2; replace-tabs on;