• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KTextEditor

  • interfaces
  • ktexteditor
templateinterface2.h
Go to the documentation of this file.
1/* This file is part of the KDE libraries
2 Copyright (C) 2010 Joseph Wenninger <jowenn@kde.org>
3
4 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public
6 License version 2 as published by the Free Software Foundation.
7
8 This library is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 Library General Public License for more details.
12
13 You should have received a copy of the GNU Library General Public License
14 along with this library; see the file COPYING.LIB. If not, write to
15 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
16 Boston, MA 02110-1301, USA.
17*/
18
19#ifndef KDELIBS_KTEXTEDITOR_TEMPLATEINTERFACE2_H
20#define KDELIBS_KTEXTEDITOR_TEMPLATEINTERFACE2_H
21
22#include <QtCore/QString>
23#include <QtCore/QMap>
24#include <QtGui/QImage>
25
26#include <ktexteditor/ktexteditor_export.h>
27#include <ktexteditor/cursor.h>
28#include <ktexteditor/templateinterface.h>
29
30namespace KTextEditor
31{
32
33class Cursor;
34
35class KTEXTEDITOR_EXPORT TemplateScript
36{
37 public:
38 virtual ~TemplateScript();
39};
40
47class KTEXTEDITOR_EXPORT TemplateInterface2: public TemplateInterface
48{
49 public:
50 TemplateInterface2();
51 virtual ~TemplateInterface2();
52
53 public:
54
59 bool insertTemplateText ( const Cursor &insertPosition,
60 const QString &templateString,
61 const QMap<QString,QString> &initialValues,
62 TemplateScript* templateScript);
63
64
65protected:
73 virtual bool insertTemplateTextImplementation ( const Cursor &insertPosition,
74 const QString &templateString,
75 const QMap<QString,QString> &initialValues,
76 TemplateScript* templateScript) = 0;
77
78
79 virtual bool insertTemplateTextImplementation ( const Cursor &insertPosition,
80 const QString &templateString,
81 const QMap<QString,QString> &initialValues) = 0;
82
83 private:
84 class TemplateInterfacePrivate2* const d;
85};
86
89class KTEXTEDITOR_EXPORT TemplateScriptRegistrar {
90
91public:
92 TemplateScriptRegistrar();
93 virtual ~TemplateScriptRegistrar();
94
106 virtual TemplateScript* registerTemplateScript(QObject *owner, const QString& script) = 0;
107
111 virtual void unregisterTemplateScript(TemplateScript* templateScript) = 0;
112
113};
114
115}
116
117Q_DECLARE_INTERFACE(KTextEditor::TemplateInterface2,
118"org.kde.KTextEditor.TemplateInterface2")
119
120Q_DECLARE_INTERFACE(KTextEditor::TemplateScriptRegistrar,
121"org.kde.KTextEditor.TemplateScriptRegistrar")
122
123
124
125#endif
KTextEditor::Cursor
An object which represents a position in a Document.
Definition: cursor.h:62
KTextEditor::TemplateInterface2
Definition: templateinterface2.h:48
KTextEditor::TemplateInterface2::insertTemplateTextImplementation
virtual bool insertTemplateTextImplementation(const Cursor &insertPosition, const QString &templateString, const QMap< QString, QString > &initialValues)=0
You must implement this, it is called by insertTemplateText, after all default values are inserted.
KTextEditor::TemplateInterface2::insertTemplateTextImplementation
virtual bool insertTemplateTextImplementation(const Cursor &insertPosition, const QString &templateString, const QMap< QString, QString > &initialValues, TemplateScript *templateScript)=0
You must implement this, it is called by insertTemplateText, after all default values are inserted.
KTextEditor::TemplateInterface
This is an interface for inserting template strings with user editable fields into a document.
Definition: templateinterface.h:40
KTextEditor::TemplateScriptRegistrar
This is an extension for KTextEditor::Editor.
Definition: templateinterface2.h:89
KTextEditor::TemplateScriptRegistrar::unregisterTemplateScript
virtual void unregisterTemplateScript(TemplateScript *templateScript)=0
This frees the template script which is identified by the token.
KTextEditor::TemplateScriptRegistrar::registerTemplateScript
virtual TemplateScript * registerTemplateScript(QObject *owner, const QString &script)=0
This registeres the script, which is contained in.
KTextEditor::TemplateScript
Definition: templateinterface2.h:36
QMap
QObject
cursor.h
ktexteditor_export.h
KTextEditor
Namespace for the KDE Text Editor Interfaces.
Definition: annotationinterface.h:31
org
templateinterface.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KTextEditor

Skip menu "KTextEditor"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal