KateIndentScript

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 QStringtriggerCharacters ()
 
- Public Member Functions inherited from KateScript
 KateScript (const QString &urlOrScript, enum InputType inputType=InputURL)
 
QString backtrace (const QJSValue &error, const QString &header=QString())
 
void clearExceptions ()
 
void displayBacktrace (const QJSValue &error, const QString &header=QString())
 
const QStringerrorMessage ()
 
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 QStringurl ()
 

Additional Inherited Members

- Public Types inherited from KateScript
typedef QMap< QString, QJSValueFieldMap
 
enum  InputType { InputURL, InputSCRIPT }
 
- Protected Member Functions inherited from KateScript
bool hasException (const QJSValue &object, const QString &file)
 
- Protected Attributes inherited from KateScript
QJSEnginem_engine = nullptr
 

Detailed Description

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

Definition at line 109 of file kateindentscript.h.

Member Function Documentation

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 60 of file kateindentscript.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Jul 7 2020 22:56:00 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.