Kate
KateHighlighting Class Reference
#include <katehighlight.h>
Public Types | |
enum | CSLPos { CSLPosColumn0 = 0, CSLPosAfterWhitespace = 1 } |
Public Member Functions | |
bool | allowsFolding () |
int | attribute (int context) const |
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 |
void | clearAttributeArrays () |
signed char | commentRegion (int attr) const |
int | defaultStyleForAttribute (int attrib) const |
void | doHighlight (KateTextLine *prevLine, KateTextLine *textLine, QVector< int > &foldingList, bool &ctxChanged) |
void | dropDynamicContexts () |
QLinkedList< QRegExp > | emptyLines (int attribute=0) const |
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 |
const QString & | getIdentifier () const |
void | getKateExtendedAttributeList (const QString &schema, QList< KateExtendedAttribute::Ptr > &) |
void | getKateExtendedAttributeListCopy (const QString &schema, QList< KateExtendedAttribute::Ptr > &) |
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 |
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 |
~KateHighlighting () |
Detailed Description
Definition at line 118 of file katehighlight.h.
Member Enumeration Documentation
This enum is used for storing the information where a single line comment marker should be inserted.
Definition at line 203 of file katehighlight.h.
Constructor & Destructor Documentation
KateHighlighting::KateHighlighting | ( | const KateSyntaxModeListItem * | def | ) |
Definition at line 66 of file katehighlight.cpp.
KateHighlighting::~KateHighlighting | ( | ) |
Definition at line 102 of file katehighlight.cpp.
Member Function Documentation
bool KateHighlighting::allowsFolding | ( | ) | [inline] |
Definition at line 354 of file katehighlight.h.
int KateHighlighting::attribute | ( | int | context | ) | const |
- Returns:
- the attribute for
context
.
Definition at line 1810 of file katehighlight.cpp.
const QString& KateHighlighting::author | ( | ) | const [inline] |
Definition at line 147 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 931 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 948 of file katehighlight.cpp.
void KateHighlighting::clearAttributeArrays | ( | ) |
Definition at line 1778 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 943 of file katehighlight.cpp.
int KateHighlighting::defaultStyleForAttribute | ( | int | attrib | ) | const |
void KateHighlighting::doHighlight | ( | KateTextLine * | prevLine, | |
KateTextLine * | 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 246 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 227 of file katehighlight.cpp.
QLinkedList< QRegExp > KateHighlighting::emptyLines | ( | int | attribute = 0 |
) | const |
Definition at line 937 of file katehighlight.cpp.
bool KateHighlighting::foldingIndentationSensitive | ( | ) | [inline] |
Definition at line 353 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 961 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 971 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 966 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 956 of file katehighlight.cpp.
const QString& KateHighlighting::getIdentifier | ( | ) | const [inline] |
Definition at line 149 of file katehighlight.h.
void KateHighlighting::getKateExtendedAttributeList | ( | const QString & | schema, | |
QList< KateExtendedAttribute::Ptr > & | list | |||
) |
Definition at line 501 of file katehighlight.cpp.
void KateHighlighting::getKateExtendedAttributeListCopy | ( | const QString & | schema, | |
QList< KateExtendedAttribute::Ptr > & | list | |||
) |
Definition at line 550 of file katehighlight.cpp.
bool KateHighlighting::hidden | ( | ) | const [inline] |
Definition at line 144 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 908 of file katehighlight.cpp.
QString KateHighlighting::indentation | ( | ) | [inline] |
Definition at line 233 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 924 of file katehighlight.cpp.
const QString& KateHighlighting::license | ( | ) | const [inline] |
Definition at line 148 of file katehighlight.h.
const QString& KateHighlighting::name | ( | ) | const [inline] |
Definition at line 141 of file katehighlight.h.
const QString& KateHighlighting::nameTranslated | ( | ) | const [inline] |
Definition at line 142 of file katehighlight.h.
bool KateHighlighting::noHighlighting | ( | ) | const [inline] |
Definition at line 228 of file katehighlight.h.
void KateHighlighting::release | ( | ) |
Decrease the usage count, and trigger cleanup if needed.
Definition at line 609 of file katehighlight.cpp.
const QString& KateHighlighting::section | ( | ) | const [inline] |
Definition at line 143 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 568 of file katehighlight.cpp.
const QString& KateHighlighting::style | ( | ) | const [inline] |
Definition at line 146 of file katehighlight.h.
void KateHighlighting::use | ( | ) |
Increase the usage count, and trigger initialization if needed.
Definition at line 598 of file katehighlight.cpp.
const QString& KateHighlighting::version | ( | ) | const [inline] |
Definition at line 145 of file katehighlight.h.
The documentation for this class was generated from the following files: