templateinterface2.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2010 Joseph Wenninger <jowenn@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 version 2 as published by the Free Software Foundation.

   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_TEMPLATEINTERFACE2_H
#define KDELIBS_KTEXTEDITOR_TEMPLATEINTERFACE2_H

#include <QtCore/QString>
#include <QtCore/QMap>
#include <QtGui/QImage>

#include <ktexteditor/ktexteditor_export.h>
#include <ktexteditor/cursor.h>
#include <ktexteditor/templateinterface.h>

namespace KTextEditor
{

class Cursor;

class KTEXTEDITOR_EXPORT TemplateScript
{
  public:
    virtual ~TemplateScript();
};

class KTEXTEDITOR_EXPORT TemplateInterface2: public TemplateInterface
{
  public:
    TemplateInterface2();
    virtual ~TemplateInterface2();

  public:

    bool insertTemplateText ( const Cursor &insertPosition,
                              const QString &templateString,
                              const QMap<QString,QString> &initialValues,
                              TemplateScript* templateScript);


protected:
    virtual bool insertTemplateTextImplementation ( const Cursor &insertPosition,
                                                    const QString &templateString,
                                                    const QMap<QString,QString> &initialValues,
                                                    TemplateScript* templateScript) = 0;


    virtual bool insertTemplateTextImplementation ( const Cursor &insertPosition,
                                                    const QString &templateString,
                                                    const QMap<QString,QString> &initialValues) = 0;

  private:
    class TemplateInterfacePrivate2* const d;
};

class KTEXTEDITOR_EXPORT TemplateScriptRegistrar {

public:
    TemplateScriptRegistrar();
    virtual ~TemplateScriptRegistrar();

    virtual TemplateScript* registerTemplateScript(QObject *owner, const QString& script) = 0;

    virtual void unregisterTemplateScript(TemplateScript* templateScript) = 0;

};

}

Q_DECLARE_INTERFACE(KTextEditor::TemplateInterface2,
"org.kde.KTextEditor.TemplateInterface2")

Q_DECLARE_INTERFACE(KTextEditor::TemplateScriptRegistrar,
"org.kde.KTextEditor.TemplateScriptRegistrar")



#endif