KateHighlighting Class Reference

#include <katehighlight.h>

List of all members.

Public Types
enum	CSLPos { CSLPosColumn0 = 0, CSLPosAfterWhitespace = 1 }
Public Member Functions
bool	allowsFolding ()
int	attribute (int context) const
QMemArray< KateAttribute > *	attributes (uint schema)
const QString &	author () const
bool	canBreakAt (QChar c, int attrib=0) const
bool	canComment (int startAttr, int endAttr) const
void	clearAttributeArrays ()
signed char	commentRegion (int attr) const
void	doHighlight (KateTextLine *prevLine, KateTextLine *textLine, QMemArray< uint > *foldingList, bool *ctxChanged)
void	dropDynamicContexts ()
bool	foldingIndentationSensitive ()
QString	getCommentEnd (int attrib=0) const
CSLPos	getCommentSingleLinePosition (int attrib=0) const
QString	getCommentSingleLineStart (int attrib=0) const
QString	getCommentStart (int attrib=0) const
KateHlData *	getData ()
const QString &	getIdentifier () const
void	getKateHlItemDataListCopy (uint schema, KateHlItemDataList &)
QString	getMimetypes ()
QStringList &	getPlainExtensions ()
QValueList< QRegExp > &	getRegexpExtensions ()
bool	hidden () const
QString	hlKeyForAttrib (int attrib) const
QString	indentation ()
bool	isInWord (QChar c, int attrib=0) const
	KateHighlighting (const KateSyntaxModeListItem *def)
const QString &	license () const
void	loadWildcards ()
const QString &	name () const
const QString &	nameTranslated () const
bool	noHighlighting () const
int	priority ()
void	release ()
const QString &	section () const
void	setData (KateHlData *)
void	setKateHlItemDataList (uint schema, KateHlItemDataList &)
void	use ()
const QString &	version () const
	~KateHighlighting ()

---

Detailed Description

Definition at line 103 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 190 of file katehighlight.h.

---

Constructor & Destructor Documentation

KateHighlighting::KateHighlighting

(

const KateSyntaxModeListItem *

def

)

Definition at line 1178 of file katehighlight.cpp.

KateHighlighting::~KateHighlighting

(

)

Definition at line 1220 of file katehighlight.cpp.

---

Member Function Documentation

bool KateHighlighting::allowsFolding

(

)

[inline]

Definition at line 338 of file katehighlight.h.

int KateHighlighting::attribute

(

int

context

)

const

Returns:

the attribute for context.

QMemArray< KateAttribute > * KateHighlighting::attributes

(

uint

schema

)

Definition at line 2899 of file katehighlight.cpp.

const QString& KateHighlighting::author

(

)

const [inline]

Definition at line 137 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 2095 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 2106 of file katehighlight.cpp.

void KateHighlighting::clearAttributeArrays

(

)

Definition at line 2870 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 2101 of file katehighlight.cpp.

void KateHighlighting::doHighlight	(	KateTextLine *	prevLine,
		KateTextLine *	textLine,
		QMemArray< uint > *	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 1339 of file katehighlight.cpp.

void KateHighlighting::dropDynamicContexts

(

)

Drop all dynamic contexts.

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

Definition at line 1320 of file katehighlight.cpp.

bool KateHighlighting::foldingIndentationSensitive

(

)

[inline]

Definition at line 337 of file katehighlight.h.

QString KateHighlighting::getCommentEnd

(

int

attrib = 0

)

const

Returns:

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

Definition at line 2119 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 2129 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 2124 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 2114 of file katehighlight.cpp.

KateHlData * KateHighlighting::getData

(

)

Definition at line 1653 of file katehighlight.cpp.

const QString& KateHighlighting::getIdentifier

(

)

const [inline]

Definition at line 140 of file katehighlight.h.

void KateHighlighting::getKateHlItemDataListCopy	(	uint	schema,
		KateHlItemDataList &	outlist
	)

Definition at line 2941 of file katehighlight.cpp.

QString KateHighlighting::getMimetypes

(

)

Definition at line 1637 of file katehighlight.cpp.

QStringList & KateHighlighting::getPlainExtensions

(

)

Definition at line 1632 of file katehighlight.cpp.

QValueList< QRegExp > & KateHighlighting::getRegexpExtensions

(

)

Definition at line 1627 of file katehighlight.cpp.

bool KateHighlighting::hidden

(

)

const [inline]

Definition at line 135 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 2073 of file katehighlight.cpp.

QString KateHighlighting::indentation

(

)

[inline]

Definition at line 219 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 2089 of file katehighlight.cpp.

const QString& KateHighlighting::license

(

)

const [inline]

Definition at line 138 of file katehighlight.h.

void KateHighlighting::loadWildcards

(

)

Definition at line 1600 of file katehighlight.cpp.

const QString& KateHighlighting::name

(

)

const [inline]

Definition at line 132 of file katehighlight.h.

const QString& KateHighlighting::nameTranslated

(

)

const [inline]

Definition at line 133 of file katehighlight.h.

bool KateHighlighting::noHighlighting

(

)

const [inline]

Definition at line 214 of file katehighlight.h.

int KateHighlighting::priority

(

)

Definition at line 1645 of file katehighlight.cpp.

void KateHighlighting::release

(

)

Decrease the usage count, and trigger cleanup if needed.

Definition at line 1769 of file katehighlight.cpp.

const QString& KateHighlighting::section

(

)

const [inline]

Definition at line 134 of file katehighlight.h.

void KateHighlighting::setData

(

KateHlData *

hlData

)

Definition at line 1667 of file katehighlight.cpp.

void KateHighlighting::setKateHlItemDataList	(	uint	schema,
		KateHlItemDataList &	list
	)

Saves the KateHlData attribute definitions to the config file.

Parameters:

	schema	The id of the schema group to save
	list	KateHlItemDataList containing the data to be used

Definition at line 1730 of file katehighlight.cpp.

void KateHighlighting::use

(

)

Increase the usage count, and trigger initialization if needed.

Definition at line 1758 of file katehighlight.cpp.

const QString& KateHighlighting::version

(

)

const [inline]

Definition at line 136 of file katehighlight.h.

---

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

• katehighlight.h
• katehighlight.cpp