QScintilla: QsciLexerCPP Class Reference - Notepad

| QScintilla 2.12.1 |

Public Types | Public Slots | Public Member Functions | Protected Member Functions | List of all members

QsciLexerCPP Class Reference

#include <qscilexercpp.h>

Inherited by QsciLexerCSharp, QsciLexerIDL, QsciLexerJava, and QsciLexerJavaScript.

Public Types

| | enum | {
Default = 0, InactiveDefault = Default + 64, Comment = 1,
InactiveComment = Comment + 64, CommentLine = 2, InactiveCommentLine = CommentLine + 64,
CommentDoc = 3, InactiveCommentDoc = CommentDoc + 64, Number = 4,
InactiveNumber = Number + 64, Keyword = 5, InactiveKeyword = Keyword + 64,
DoubleQuotedString = 6, InactiveDoubleQuotedString = DoubleQuotedString + 64, SingleQuotedString = 7,
InactiveSingleQuotedString = SingleQuotedString + 64, UUID = 8, InactiveUUID = UUID + 64,
PreProcessor = 9, InactivePreProcessor = PreProcessor + 64, Operator = 10,
InactiveOperator = Operator + 64, Identifier = 11, InactiveIdentifier = Identifier + 64,
UnclosedString = 12, InactiveUnclosedString = UnclosedString + 64, VerbatimString = 13,
InactiveVerbatimString = VerbatimString + 64, Regex = 14, InactiveRegex = Regex + 64,
CommentLineDoc = 15, InactiveCommentLineDoc = CommentLineDoc + 64, KeywordSet2 = 16,
InactiveKeywordSet2 = KeywordSet2 + 64, CommentDocKeyword = 17, InactiveCommentDocKeyword = CommentDocKeyword + 64,
CommentDocKeywordError = 18, InactiveCommentDocKeywordError = CommentDocKeywordError + 64, GlobalClass = 19,
InactiveGlobalClass = GlobalClass + 64, RawString = 20, InactiveRawString = RawString + 64,
TripleQuotedVerbatimString = 21, InactiveTripleQuotedVerbatimString = TripleQuotedVerbatimString + 64, HashQuotedString = 22,
InactiveHashQuotedString = HashQuotedString + 64, PreProcessorComment = 23, InactivePreProcessorComment = PreProcessorComment + 64,
PreProcessorCommentLineDoc = 24, InactivePreProcessorCommentLineDoc = PreProcessorCommentLineDoc + 64, UserLiteral = 25,
InactiveUserLiteral = UserLiteral + 64, TaskMarker = 26, InactiveTaskMarker = TaskMarker + 64,
EscapeSequence = 27, InactiveEscapeSequence = EscapeSequence + 64
} | | |

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

The QsciLexerCPP class encapsulates the Scintilla C++ lexer.

Member Enumeration Documentation

◆anonymous enum

| anonymous enum |

This enum defines the meanings of the different styles used by the C++ lexer.

Enumerator
Default

The default.

| | Comment |

A C comment.

| | CommentLine |

A C++ comment line.

| | CommentDoc |

A JavaDoc/Doxygen style C comment.

| | Number |

A number.

| | Keyword |

A keyword.

| | DoubleQuotedString |

A double-quoted string.

| | SingleQuotedString |

A single-quoted string.

| | UUID |

An IDL UUID.

| | PreProcessor |

A pre-processor block.

| | Operator |

An operator.

| | Identifier |

An identifier.

| | UnclosedString |

The end of a line where a string is not closed.

| | VerbatimString |

A C# verbatim string.

| | Regex |

A JavaScript regular expression.

| | CommentLineDoc |

A JavaDoc/Doxygen style C++ comment line.

| | KeywordSet2 |

A keyword defined in keyword set number 2. The class must be sub-classed and re-implement keywords() to make use of this style.

| | CommentDocKeyword |

A JavaDoc/Doxygen keyword.

| | CommentDocKeywordError |

A JavaDoc/Doxygen keyword error.

| | GlobalClass |

A global class or typedef defined in keyword set number 5. The class must be sub-classed and re-implement keywords() to make use of this style.

| | RawString |

A C++ raw string.

| | TripleQuotedVerbatimString |

A Vala triple-quoted verbatim string.

| | HashQuotedString |

A Pike hash-quoted string.

| | PreProcessorComment |

A pre-processor stream comment.

| | PreProcessorCommentLineDoc |

A JavaDoc/Doxygen style pre-processor comment.

| | UserLiteral |

A user-defined literal.

| | TaskMarker |

A task marker.

| | EscapeSequence |

An escape sequence.

Constructor & Destructor Documentation

◆QsciLexerCPP()

Construct a QsciLexerCPP with parent parent. parent is typically the QsciScintilla instance. caseInsensitiveKeywords is true if the lexer ignores the case of keywords.

Member Function Documentation

◆lexer()

| const char* QsciLexerCPP::lexer | ( | | ) | const |

| virtual |

Returns the name of the lexer. Some lexers support a number of languages.

Reimplemented from QsciLexer.

◆autoCompletionWordSeparators()

| QStringList QsciLexerCPP::autoCompletionWordSeparators | ( | | ) | const |

| virtual |

Returns the list of character sequences that can separate auto-completion words. The first in the list is assumed to be the sequence used to separate words in the lexer's API files.

Reimplemented from QsciLexer.

◆blockEnd()

| const char* QsciLexerCPP::blockEnd | ( | int * | style = 0 | ) | const |

| virtual |

Returns a space separated list of words or characters in a particular style that define the end of a block for auto-indentation. The style is returned via style.

Reimplemented from QsciLexer.

◆blockStart()

| const char* QsciLexerCPP::blockStart | ( | int * | style = 0 | ) | const |

| virtual |

Returns a space separated list of words or characters in a particular style that define the start of a block for auto-indentation. The style is returned via style.

Reimplemented from QsciLexer.

◆blockStartKeyword()

| const char* QsciLexerCPP::blockStartKeyword | ( | int * | style = 0 | ) | const |

| virtual |

Returns a space separated list of keywords in a particular style that define the start of a block for auto-indentation. The style is returned via style.

Reimplemented from QsciLexer.

◆defaultColor()

| QColor QsciLexerCPP::defaultColor | ( | int | style | ) | const |

| virtual |

Returns the foreground colour of the text for style number style.

◆defaultPaper()

| QColor QsciLexerCPP::defaultPaper | ( | int | style | ) | const |

| virtual |

Returns the background colour of the text for style number style.

◆keywords()

| const char* QsciLexerCPP::keywords | ( | int | set | ) | const |

| virtual |

Returns the set of keywords for the keyword set set recognised by the lexer as a space separated string. Set 1 is normally used for primary keywords and identifiers. Set 2 is normally used for secondary keywords and identifiers. Set 3 is normally used for documentation comment keywords. Set 4 is normally used for global classes and typedefs.

Reimplemented from QsciLexer.

Reimplemented in QsciLexerJavaScript, QsciLexerJava, QsciLexerIDL, and QsciLexerCSharp.

◆description()

| QString QsciLexerCPP::description | ( | int | style | ) | const |

| virtual |

Returns the descriptive name for style number style. If the style is invalid for this language then an empty QString is returned. This is intended to be used in user preference dialogs.

Implements QsciLexer.

Reimplemented in QsciLexerJavaScript, QsciLexerIDL, and QsciLexerCSharp.

◆refreshProperties()

| void QsciLexerCPP::refreshProperties | ( | | ) | |

| virtual |

Causes all properties to be refreshed by emitting the propertyChanged() signal as required.

Reimplemented from QsciLexer.

◆foldAtElse()

| bool QsciLexerCPP::foldAtElse | ( | | ) | const |

| inline |

Returns true if "} else {" lines can be folded.

◆foldComments()

| bool QsciLexerCPP::foldComments | ( | | ) | const |

| inline |

Returns true if multi-line comment blocks can be folded.

◆foldCompact()

| bool QsciLexerCPP::foldCompact | ( | | ) | const |

| inline |

Returns true if trailing blank lines are included in a fold block.

◆foldPreprocessor()

| bool QsciLexerCPP::foldPreprocessor | ( | | ) | const |

| inline |

Returns true if preprocessor blocks can be folded.

◆stylePreprocessor()

| bool QsciLexerCPP::stylePreprocessor | ( | | ) | const |

| inline |

Returns true if preprocessor lines (after the preprocessor directive) are styled.

◆setDollarsAllowed()

If allowed is true then '$' characters are allowed in identifier names. The default is true.

◆dollarsAllowed()

| bool QsciLexerCPP::dollarsAllowed | ( | | ) | const |

| inline |

Returns true if '$' characters are allowed in identifier names.

◆setHighlightTripleQuotedStrings()

If enabled is true then triple quoted strings are highlighted. The default is false.

◆highlightTripleQuotedStrings()

| bool QsciLexerCPP::highlightTripleQuotedStrings | ( | | ) | const |

| inline |

Returns true if triple quoted strings should be highlighted.

◆setHighlightHashQuotedStrings()

If enabled is true then hash quoted strings are highlighted. The default is false.

◆highlightHashQuotedStrings()

| bool QsciLexerCPP::highlightHashQuotedStrings | ( | | ) | const |

| inline |

Returns true if hash quoted strings should be highlighted.

◆setHighlightBackQuotedStrings()

If enabled is true then back-quoted raw strings are highlighted. The default is false.

◆highlightBackQuotedStrings()

| bool QsciLexerCPP::highlightBackQuotedStrings | ( | | ) | const |

| inline |

Returns true if back-quoted raw strings should be highlighted.

◆setHighlightEscapeSequences()

If enabled is true then escape sequences in strings are highlighted. The default is false.

◆highlightEscapeSequences()

| bool QsciLexerCPP::highlightEscapeSequences | ( | | ) | const |

| inline |

Returns true if escape sequences in strings should be highlighted.

◆setVerbatimStringEscapeSequencesAllowed()

If allowed is true then escape sequences are allowed in verbatim strings. The default is false.

◆verbatimStringEscapeSequencesAllowed()

| bool QsciLexerCPP::verbatimStringEscapeSequencesAllowed | ( | | ) | const |

| inline |

Returns true if hash quoted strings should be highlighted.

◆setFoldAtElse

| virtualslot |

If fold is true then "} else {" lines can be folded. The default is false.

◆setFoldComments

| virtualslot |

If fold is true then multi-line comment blocks can be folded. The default is false.

◆setFoldCompact

| virtualslot |

If fold is true then trailing blank lines are included in a fold block. The default is true.

◆setFoldPreprocessor

| virtualslot |

If fold is true then preprocessor blocks can be folded. The default is true.

◆setStylePreprocessor

| virtualslot |

If style is true then preprocessor lines (after the preprocessor directive) are styled. The default is false.

◆readProperties()

| bool QsciLexerCPP::readProperties | ( | QSettings & | qs, | | | | const QString & | prefix | | | ) | | |

| protectedvirtual |

The lexer's properties are read from the settings qs. prefix (which has a trailing '/') should be used as a prefix to the key of each setting. true is returned if there is no error.

◆writeProperties()

| protectedvirtual |

The lexer's properties are written to the settings qs. prefix (which has a trailing '/') should be used as a prefix to the key of each setting. true is returned if there is no error.