KateIndentScript Class Reference

#include <kateindentscript.h>

Inheritance diagram for KateIndentScript:

Public Member Functions
	KateIndentScript (const QString &url, const KateIndentScriptHeader &header)
QPair< int, int >	indent (KTextEditor::ViewPrivate *view, const KTextEditor::Cursor position, QChar typedCharacter, int indentWidth)
const KateIndentScriptHeader &	indentHeader () const
const QString &	triggerCharacters ()
Public Member Functions inherited from KateScript
	KateScript (const QString &urlOrScript, enum InputType inputType=InputURL)
void	clearExceptions ()
void	displayBacktrace (const QJSValue &error, const QString &header=QString())
const QString &	errorMessage ()
QJSValue	evaluate (const QString &program, const FieldMap &env=FieldMap())
QJSValue	function (const QString &name)
KateScriptHeader &	generalHeader ()
QJSValue	global (const QString &name)
bool	load ()
void	setGeneralHeader (const KateScriptHeader &generalHeader)
bool	setView (KTextEditor::ViewPrivate *view)
const QString &	url ()

Additional Inherited Members
Public Types inherited from KateScript
typedef QMap< QString, QJSValue >	FieldMap
enum	InputType { InputURL , InputSCRIPT }
Static Public Member Functions inherited from KateScript
static QString	backtrace (const QJSValue &error, const QString &header=QString())
Protected Member Functions inherited from KateScript
bool	hasException (const QJSValue &object, const QString &file)
Protected Attributes inherited from KateScript
QJSEngine *	m_engine = nullptr

Detailed Description

A specialized class for scripts that are of type ScriptType::Indentation.

Definition at line 101 of file kateindentscript.h.

Constructor & Destructor Documentation

KateIndentScript()

KateIndentScript::KateIndentScript ( const QString & url, const KateIndentScriptHeader & header )

explicit

Definition at line 13 of file kateindentscript.cpp.

Member Function Documentation

indent()

QPair< int, int > KateIndentScript::indent	(	KTextEditor::ViewPrivate *	view,
		const KTextEditor::Cursor	position,
		QChar	typedCharacter,
		int	indentWidth )

Returns a pair where the first value is the indent amount, and the second value is the alignment.

Definition at line 43 of file kateindentscript.cpp.

indentHeader()

const KateIndentScriptHeader & KateIndentScript::indentHeader

(

)

const

Definition at line 19 of file kateindentscript.cpp.

triggerCharacters()

const QString & KateIndentScript::triggerCharacters

(

)

Definition at line 24 of file kateindentscript.cpp.

---

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

• kateindentscript.h
• kateindentscript.cpp