KateHighlighting Class Reference
List of all members.Detailed Description
Definition at line 103 of file katehighlight.h.
Public Types | |
enum | CSLPos { CSLPosColumn0 = 0, CSLPosAfterWhitespace = 1 } |
Public Member Functions | |
KateHighlighting (const KateSyntaxModeListItem *def) | |
~KateHighlighting () | |
void | doHighlight (KateTextLine *prevLine, KateTextLine *textLine, QMemArray< uint > *foldingList, bool *ctxChanged) |
void | loadWildcards () |
QValueList< QRegExp > & | getRegexpExtensions () |
QStringList & | getPlainExtensions () |
QString | getMimetypes () |
KateHlData * | getData () |
void | setData (KateHlData *) |
void | setKateHlItemDataList (uint schema, KateHlItemDataList &) |
void | getKateHlItemDataListCopy (uint schema, KateHlItemDataList &) |
const QString & | name () const |
const QString & | nameTranslated () const |
const QString & | section () const |
bool | hidden () const |
const QString & | version () const |
const QString & | author () const |
const QString & | license () const |
int | priority () |
const QString & | getIdentifier () const |
void | use () |
void | release () |
bool | isInWord (QChar c, int attrib=0) const |
bool | canBreakAt (QChar c, int attrib=0) const |
bool | canComment (int startAttr, int endAttr) const |
signed char | commentRegion (int attr) const |
QString | getCommentStart (int attrib=0) const |
QString | getCommentEnd (int attrib=0) const |
QString | getCommentSingleLineStart (int attrib=0) const |
CSLPos | getCommentSingleLinePosition (int attrib=0) const |
int | attribute (int context) const |
QString | hlKeyForAttrib (int attrib) const |
void | clearAttributeArrays () |
QMemArray< KateAttribute > * | attributes (uint schema) |
bool | noHighlighting () const |
void | dropDynamicContexts () |
QString | indentation () |
bool | foldingIndentationSensitive () |
bool | allowsFolding () |
Member Enumeration Documentation
This enum is used for storing the information where a single line comment marker should be inserted.
Definition at line 190 of file katehighlight.h.
Member Function Documentation
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::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.
void KateHighlighting::release | ( | ) |
Decrease the usage count, and trigger cleanup if needed.
Definition at line 1769 of file katehighlight.cpp.
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.
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
andendAttr
are members of the same highlight, and there are comment markers of either type in that.
Definition at line 2106 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.
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.
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.
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.
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.
int KateHighlighting::attribute | ( | int | context | ) | const |
- Returns:
- the attribute for
context
.
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.
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.
The documentation for this class was generated from the following files: