KTextEditor::TemplateInterface2 Class Reference

#include <templateinterface2.h>

Inheritance diagram for KTextEditor::TemplateInterface2:

List of all members.

Public Member Functions
	TemplateInterface2 ()
virtual	~TemplateInterface2 ()
bool	insertTemplateText (const Cursor &insertPosition, const QString &templateString, const QMap< QString, QString > &initialValues, TemplateScript *templateScript)
Protected Member Functions
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

---

Detailed Description

Since:

4.5 This is an interface for inserting template strings with user editable fields into a document and support for scripts. Fold back into base Interface in KDE 5

---

Constructor & Destructor Documentation

TemplateInterface2::TemplateInterface2

(

)

Definition at line 40 of file templateinterface2.cpp.

TemplateInterface2::~TemplateInterface2

(

)

[virtual]

Definition at line 46 of file templateinterface2.cpp.

---

Member Function Documentation

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

See the function description in TemplateInterface, this should be folded into the base Interface in KDE 5.

Parameters:

templateScript

pointer to TemplateScript created by TemplateScriptRegistrar::registerTemplateScript

Definition at line 50 of file templateinterface2.cpp.

virtual bool KTextEditor::TemplateInterface2::insertTemplateTextImplementation	(	const Cursor &	insertPosition,
		const QString &	templateString,
		const QMap< QString, QString > &	initialValues,
		TemplateScript *	templateScript
	)		[protected, pure virtual]

You must implement this, it is called by insertTemplateText, after all default values are inserted.

If you are implementing this interface, this method should work as described in the documentation for insertTemplateText above.

Returns:

true if any text was inserted.

virtual bool KTextEditor::TemplateInterface2::insertTemplateTextImplementation	(	const Cursor &	insertPosition,
		const QString &	templateString,
		const QMap< QString, QString > &	initialValues
	)		[protected, pure virtual]

You must implement this, it is called by insertTemplateText, after all default values are inserted.

If you are implementing this interface, this method should work as described in the documentation for insertTemplateText above.

Returns:

true if any text was inserted.

Deprecated:

Implements KTextEditor::TemplateInterface.

---

The documentation for this class was generated from the following files:

• templateinterface2.h
• templateinterface2.cpp