KateHighlighting Class Reference

#include <katehighlight.h>

List of all members.

Public Types
enum	CSLPos { CSLPosColumn0 = 0, CSLPosAfterWhitespace = 1 }
Public Member Functions
	KateHighlighting (const KateSyntaxModeListItem *def)
	~KateHighlighting ()
bool	allowsFolding ()
int	attribute (int context) const
bool	attributeRequiresSpellchecking (int attr)
QList < KTextEditor::Attribute::Ptr >	attributes (const QString &schema)
const QString &	author () const
bool	canBreakAt (QChar c, int attrib=0) const
bool	canComment (int startAttr, int endAttr) const
const QHash< QString, QChar > &	characterEncodings (int attrib=0) const
void	clearAttributeArrays ()
signed char	commentRegion (int attr) const
int	defaultStyleForAttribute (int attrib) const
void	doHighlight (Kate::TextLineData *prevLine, Kate::TextLineData *textLine, QVector< int > &foldingList, bool &ctxChanged)
void	dropDynamicContexts ()
QLinkedList< QRegExp >	emptyLines (int attribute=0) const
bool	foldingIndentationSensitive ()
const QHash< QString, QChar > &	getCharacterEncodings (int attrib) const
const KatePrefixStore &	getCharacterEncodingsPrefixStore (int attrib) const
QString	getCommentEnd (int attrib=0) const
CSLPos	getCommentSingleLinePosition (int attrib=0) const
QString	getCommentSingleLineStart (int attrib=0) const
QString	getCommentStart (int attrib=0) const
QStringList	getEmbeddedHighlightingModes () const
int	getEncodedCharactersInsertionPolicy (int attrib) const
const QString &	getIdentifier () const
void	getKateExtendedAttributeList (const QString &schema, QList< KateExtendedAttribute::Ptr > &)
void	getKateExtendedAttributeListCopy (const QString &schema, QList< KateExtendedAttribute::Ptr > &)
const QHash< QChar, QString > &	getReverseCharacterEncodings (int attrib) const
bool	hidden () const
QString	hlKeyForAttrib (int attrib) const
QString	hlKeyForContext (int attrib) const
QString	indentation ()
bool	isInWord (QChar c, int attrib=0) const
const QString &	license () const
const QString &	name () const
const QString &	nameTranslated () const
bool	noHighlighting () const
void	release ()
const QString &	section () const
void	setKateExtendedAttributeList (uint schema, QList< KateExtendedAttribute::Ptr > &)
const QString &	style () const
void	use ()
const QString &	version () const

---

Detailed Description

Definition at line 119 of file katehighlight.h.

---

Member Enumeration Documentation

enum KateHighlighting::CSLPos

This enum is used for storing the information where a single line comment marker should be inserted.

Enumerator:

CSLPosColumn0
CSLPosAfterWhitespace

Definition at line 206 of file katehighlight.h.

---

Constructor & Destructor Documentation

KateHighlighting::KateHighlighting

(

const KateSyntaxModeListItem *

def

)

Definition at line 70 of file katehighlight.cpp.

KateHighlighting::~KateHighlighting

(

)

Definition at line 107 of file katehighlight.cpp.

---

Member Function Documentation

bool KateHighlighting::allowsFolding

(

)

[inline]

Definition at line 386 of file katehighlight.h.

int KateHighlighting::attribute

(

int

context

)

const

Returns:

the attribute for context.

Definition at line 992 of file katehighlight.cpp.

bool KateHighlighting::attributeRequiresSpellchecking

(

int

attr

)

Definition at line 997 of file katehighlight.cpp.

QList< KTextEditor::Attribute::Ptr > KateHighlighting::attributes

(

const QString &

schema

)

Definition at line 2078 of file katehighlight.cpp.

const QString& KateHighlighting::author

(

)

const [inline]

Definition at line 148 of file katehighlight.h.

bool KateHighlighting::canBreakAt	(	QChar	c,
		int	attrib = 0
	)		const

Returns:

true if the character c is a wordwrap deliminator as specified in the general keyword section of the xml file.

Definition at line 1043 of file katehighlight.cpp.

bool KateHighlighting::canComment	(	int	startAttr,
		int	endAttr
	)		const

Returns:

true if beginAttr and endAttr are members of the same highlight, and there are comment markers of either type in that.

Definition at line 1063 of file katehighlight.cpp.

const QHash< QString, QChar > & KateHighlighting::characterEncodings

(

int

attrib = 0

)

const

Definition at line 1091 of file katehighlight.cpp.

void KateHighlighting::clearAttributeArrays

(

)

Definition at line 2046 of file katehighlight.cpp.

signed char KateHighlighting::commentRegion

(

int

attr

)

const

Returns:

0 if highlighting which attr is a member of does not define a comment region, otherwise the region is returned

Definition at line 1058 of file katehighlight.cpp.

int KateHighlighting::defaultStyleForAttribute

(

int

attrib

)

const

void KateHighlighting::doHighlight	(	Kate::TextLineData *	prevLine,
		Kate::TextLineData *	textLine,
		QVector< int > &	foldingList,
		bool &	ctxChanged
	)

Parse the text and fill in the context array and folding list array.

Parameters:

prevLine	The previous line, the context array is picked up from that if present.
textLine	The text line to parse
foldingList	will be filled
ctxChanged	will be set to reflect if the context changed

Definition at line 256 of file katehighlight.cpp.

void KateHighlighting::dropDynamicContexts

(

)

Drop all dynamic contexts.

Shall be called with extreme care, and shall be immediately followed by a full HL invalidation.

Definition at line 237 of file katehighlight.cpp.

QLinkedList< QRegExp > KateHighlighting::emptyLines

(

int

attribute = 0

)

const

Definition at line 1049 of file katehighlight.cpp.

bool KateHighlighting::foldingIndentationSensitive

(

)

[inline]

Definition at line 385 of file katehighlight.h.

const QHash< QString, QChar > & KateHighlighting::getCharacterEncodings

(

int

attrib

)

const

Definition at line 638 of file katehighlight.cpp.

const KatePrefixStore & KateHighlighting::getCharacterEncodingsPrefixStore

(

int

attrib

)

const

Definition at line 643 of file katehighlight.cpp.

QString KateHighlighting::getCommentEnd

(

int

attrib = 0

)

const

Returns:

the muiltiline comment end marker for the highlight corresponding to attrib.

Definition at line 1076 of file katehighlight.cpp.

KateHighlighting::CSLPos KateHighlighting::getCommentSingleLinePosition

(

int

attrib = 0

)

const

Returns:

the single comment marker position for the highlight corresponding to attrib.

Definition at line 1086 of file katehighlight.cpp.

QString KateHighlighting::getCommentSingleLineStart

(

int

attrib = 0

)

const

Returns:

the single comment marker for the highlight corresponding to attrib.

Definition at line 1081 of file katehighlight.cpp.

QString KateHighlighting::getCommentStart

(

int

attrib = 0

)

const

Returns:

the mulitiline comment start marker for the highlight corresponding to attrib.

Definition at line 1071 of file katehighlight.cpp.

QStringList KateHighlighting::getEmbeddedHighlightingModes

(

)

const

Returns a list of names of embedded modes.

Definition at line 2110 of file katehighlight.cpp.

int KateHighlighting::getEncodedCharactersInsertionPolicy

(

int

attrib

)

const

Definition at line 653 of file katehighlight.cpp.

const QString& KateHighlighting::getIdentifier

(

)

const [inline]

Definition at line 150 of file katehighlight.h.

void KateHighlighting::getKateExtendedAttributeList	(	const QString &	schema,
		QList< KateExtendedAttribute::Ptr > &	list
	)

Definition at line 537 of file katehighlight.cpp.

void KateHighlighting::getKateExtendedAttributeListCopy	(	const QString &	schema,
		QList< KateExtendedAttribute::Ptr > &	list
	)

Definition at line 592 of file katehighlight.cpp.

const QHash< QChar, QString > & KateHighlighting::getReverseCharacterEncodings

(

int

attrib

)

const

Definition at line 648 of file katehighlight.cpp.

bool KateHighlighting::hidden

(

)

const [inline]

Definition at line 145 of file katehighlight.h.

QString KateHighlighting::hlKeyForAttrib

(

int

attrib

)

const

map attribute to its highlighting file.

the returned string is used as key for m_additionalData.

Definition at line 1020 of file katehighlight.cpp.

QString KateHighlighting::hlKeyForContext

(

int

attrib

)

const

Definition at line 1006 of file katehighlight.cpp.

QString KateHighlighting::indentation

(

)

[inline]

Definition at line 239 of file katehighlight.h.

bool KateHighlighting::isInWord	(	QChar	c,
		int	attrib = 0
	)		const

Returns:

true if the character c is not a deliminator character for the corresponding highlight.

Definition at line 1036 of file katehighlight.cpp.

const QString& KateHighlighting::license

(

)

const [inline]

Definition at line 149 of file katehighlight.h.

const QString& KateHighlighting::name

(

)

const [inline]

Definition at line 142 of file katehighlight.h.

const QString& KateHighlighting::nameTranslated

(

)

const [inline]

Definition at line 143 of file katehighlight.h.

bool KateHighlighting::noHighlighting

(

)

const [inline]

Definition at line 234 of file katehighlight.h.

void KateHighlighting::release

(

)

Decrease the usage count, and trigger cleanup if needed.

Definition at line 679 of file katehighlight.cpp.

const QString& KateHighlighting::section

(

)

const [inline]

Definition at line 144 of file katehighlight.h.

void KateHighlighting::setKateExtendedAttributeList	(	uint	schema,
		QList< KateExtendedAttribute::Ptr > &	list
	)

Saves the attribute definitions to the config file.

Parameters:

schema	The id of the schema group to save
list	QList<KateExtendedAttribute::Ptr> containing the data to be used

Definition at line 610 of file katehighlight.cpp.

const QString& KateHighlighting::style

(

)

const [inline]

Definition at line 147 of file katehighlight.h.

void KateHighlighting::use

(

)

Increase the usage count, and trigger initialization if needed.

Definition at line 668 of file katehighlight.cpp.

const QString& KateHighlighting::version

(

)

const [inline]

Definition at line 146 of file katehighlight.h.

---

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

• katehighlight.h
• katehighlight.cpp