Back to Notepad

QScintilla: QsciLexerD Class Reference

src/qscint/doc/html/classQsciLexerD.html

latest18.7 KB
Original Source

| QScintilla 2.12.1 |

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

QsciLexerD Class Reference

#include <qscilexerd.h>

Inherits QsciLexer.

|

Public Types

| | enum | {
Default = 0, Comment = 1, CommentLine = 2,
CommentDoc = 3, CommentNested = 4, Number = 5,
Keyword = 6, KeywordSecondary = 7, KeywordDoc = 8,
Typedefs = 9, String = 10, UnclosedString = 11,
Character = 12, Operator = 13, Identifier = 14,
CommentLineDoc = 15, CommentDocKeyword = 16, CommentDocKeywordError = 17,
BackquoteString = 18, RawString = 19, KeywordSet5 = 20,
KeywordSet6 = 21, KeywordSet7 = 22
} | | |

|

Public Slots

| | virtual void | setFoldAtElse (bool fold) | | | | virtual void | setFoldComments (bool fold) | | | | virtual void | setFoldCompact (bool fold) | | | | Public Slots inherited from QsciLexer | | virtual void | setAutoIndentStyle (int autoindentstyle) | | | | virtual void | setColor (const QColor &c, int style=-1) | | | | virtual void | setEolFill (bool eoffill, int style=-1) | | | | virtual void | setFont (const QFont &f, int style=-1) | | | | virtual void | setPaper (const QColor &c, int style=-1) | | |

|

Public Member Functions

| | | QsciLexerD (QObject *parent=0) | | | | virtual | ~QsciLexerD () | | | | const char * | language () const | | | | const char * | lexer () const | | | | QStringList | autoCompletionWordSeparators () const | | | | const char * | blockEnd (int *style=0) const | | | | const char * | blockStart (int *style=0) const | | | | const char * | blockStartKeyword (int *style=0) const | | | | int | braceStyle () const | | | | const char * | wordCharacters () const | | | | QColor | defaultColor (int style) const | | | | bool | defaultEolFill (int style) const | | | | QFont | defaultFont (int style) const | | | | QColor | defaultPaper (int style) const | | | | const char * | keywords (int set) const | | | | QString | description (int style) const | | | | void | refreshProperties () | | | | bool | foldAtElse () const | | | | bool | foldComments () const | | | | bool | foldCompact () const | | | | Public Member Functions inherited from QsciLexer | | | QsciLexer (QObject *parent=0) | | | | virtual | ~QsciLexer () | | | | virtual int | lexerId () const | | | | QsciAbstractAPIs * | apis () const | | | | virtual const char * | autoCompletionFillups () const | | | | int | autoIndentStyle () | | | | virtual int | blockLookback () const | | | | virtual bool | caseSensitive () const | | | | virtual QColor | color (int style) const | | | | virtual bool | eolFill (int style) const | | | | virtual QFont | font (int style) const | | | | virtual int | indentationGuideView () const | | | | virtual int | defaultStyle () const | | | | virtual QColor | paper (int style) const | | | | QColor | defaultColor () const | | | | QFont | defaultFont () const | | | | QColor | defaultPaper () const | | | | QsciScintilla * | editor () const | | | | void | setAPIs (QsciAbstractAPIs *apis) | | | | void | setDefaultColor (const QColor &c) | | | | void | setDefaultFont (const QFont &f) | | | | void | setDefaultPaper (const QColor &c) | | | | virtual void | setEditor (QsciScintilla *editor) | | | | bool | readSettings (QSettings &qs, const char *prefix="/Scintilla") | | | | virtual int | styleBitsNeeded () const | | | | bool | writeSettings (QSettings &qs, const char *prefix="/Scintilla") const | | |

|

Protected Member Functions

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

|

Additional Inherited Members

| | Signals inherited from QsciLexer | | void | colorChanged (const QColor &c, int style) | | | | void | eolFillChanged (bool eolfilled, int style) | | | | void | fontChanged (const QFont &f, int style) | | | | void | paperChanged (const QColor &c, int style) | | | | void | propertyChanged (const char *prop, const char *val) | | |

Detailed Description

The QsciLexerD class encapsulates the Scintilla D lexer.

Member Enumeration Documentation

anonymous enum

| anonymous enum |

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

Enumerator
Default

The default.

| | Comment |

A comment.

| | CommentLine |

A comment line.

| | CommentDoc |

A JavaDoc and Doxygen comment.

| | CommentNested |

A nested comment.

| | Number |

A number.

| | Keyword |

A keyword.

| | KeywordSecondary |

A secondary keyword.

| | KeywordDoc |

A doc keyword.

| | Typedefs |

Typedefs and aliases.

| | String |

A string.

| | UnclosedString |

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

| | Character |

A character.

| | Operator |

An operator.

| | Identifier |

An identifier.

| | CommentLineDoc |

A JavaDoc and Doxygen line.

| | CommentDocKeyword |

A JavaDoc and Doxygen keyword.

| | CommentDocKeywordError |

A JavaDoc and Doxygen keyword error.

| | BackquoteString |

A backquoted string.

| | RawString |

A raw, hexadecimal or delimited string.

| | KeywordSet5 |

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

| | KeywordSet6 |

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

| | KeywordSet7 |

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

|

Constructor & Destructor Documentation

QsciLexerD()

| QsciLexerD::QsciLexerD | ( | QObject * | parent = 0 | ) | |

Construct a QsciLexerD with parent parent. parent is typically the QsciScintilla instance.

Member Function Documentation

lexer()

|

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

| virtual |

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

Reimplemented from QsciLexer.

autoCompletionWordSeparators()

|

| QStringList QsciLexerD::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* QsciLexerD::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* QsciLexerD::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* QsciLexerD::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 QsciLexerD::defaultColor | ( | int | style | ) | const |

| virtual |

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

See alsodefaultPaper()

Reimplemented from QsciLexer.

defaultPaper()

|

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

| virtual |

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

See alsodefaultColor()

Reimplemented from QsciLexer.

keywords()

|

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

| virtual |

Returns the set of keywords for the keyword set set recognised by the lexer as a space separated string.

Reimplemented from QsciLexer.

description()

|

| QString QsciLexerD::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.

refreshProperties()

|

| void QsciLexerD::refreshProperties | ( | | ) | |

| virtual |

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

Reimplemented from QsciLexer.

foldAtElse()

| bool QsciLexerD::foldAtElse | ( | | ) | const |

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

See alsosetFoldAtElse()

foldComments()

| bool QsciLexerD::foldComments | ( | | ) | const |

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

See alsosetFoldComments()

foldCompact()

| bool QsciLexerD::foldCompact | ( | | ) | const |

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

See alsosetFoldCompact()

setFoldAtElse

|

| virtual void QsciLexerD::setFoldAtElse | ( | bool | fold | ) | |

| virtualslot |

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

See alsofoldAtElse()

setFoldComments

|

| virtual void QsciLexerD::setFoldComments | ( | bool | fold | ) | |

| virtualslot |

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

See alsofoldComments()

setFoldCompact

|

| virtual void QsciLexerD::setFoldCompact | ( | bool | fold | ) | |

| virtualslot |

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

See alsofoldCompact()

readProperties()

|

| bool QsciLexerD::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.

See alsowriteProperties()

Reimplemented from QsciLexer.

writeProperties()

|

| bool QsciLexerD::writeProperties | ( | QSettings & | qs, | | | | const QString & | prefix | | | ) | | const |

| 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.

See alsoreadProperties()

Reimplemented from QsciLexer.


Generated by 1.8.20