#include <qscilexer.h>
Inherited by QsciLexerBash, QsciLexerBatch, QsciLexerCMake, QsciLexerCPP, QsciLexerCSS, QsciLexerD, QsciLexerDiff, QsciLexerHTML, QsciLexerLua, QsciLexerMakefile, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerRuby, QsciLexerSQL, QsciLexerTeX, and QsciLexerVHDL.
A Scintilla lexer scans the text breaking it up into separate language objects, e.g. keywords, strings, operators. The lexer then uses a different style to draw each object. A style is identified by a style number and has a number of attributes, including colour and font. A specific language lexer will implement appropriate default styles which can be overriden by an application by further sub-classing the specific language lexer.
A specific language lexer may provide one or more sets of words to be recognised as keywords. Most lexers only provide one set, but some may support languages embedded in other languages and provide several sets.
QsciLexer provides convenience methods for saving and restoring user preferences for fonts and colours. Note that QSciLexer is not a means to writing new lexers - you must do that by adding a new lexer to the underlying Scintilla code.
| QsciLexer::QsciLexer | ( | QObject * | parent = 0 |
) |
Construct a QsciLexer with parent parent. parent is typically the QsciScintilla instance.
| virtual QsciLexer::~QsciLexer | ( | ) | [virtual] |
Destroy the QSciLexer.
| virtual const char* QsciLexer::language | ( | ) | const [pure virtual] |
Returns the name of the language. It must be re-implemented by a sub-class.
Implemented in QsciLexerBash, QsciLexerBatch, QsciLexerCMake, QsciLexerCPP, QsciLexerCSharp, QsciLexerCSS, QsciLexerD, QsciLexerDiff, QsciLexerHTML, QsciLexerIDL, QsciLexerJava, QsciLexerJavaScript, QsciLexerLua, QsciLexerMakefile, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerRuby, QsciLexerSQL, QsciLexerTeX, and QsciLexerVHDL.
| virtual const char* QsciLexer::lexer | ( | ) | const [pure virtual] |
Returns the name of the lexer. Some lexers support a number of languages. It must be re-implemented by a sub-class.
Implemented in QsciLexerBash, QsciLexerBatch, QsciLexerCMake, QsciLexerCPP, QsciLexerCSS, QsciLexerD, QsciLexerDiff, QsciLexerHTML, QsciLexerLua, QsciLexerMakefile, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerRuby, QsciLexerSQL, QsciLexerTeX, and QsciLexerVHDL.
| QsciAPIs* QsciLexer::apis | ( | ) | const |
| int QsciLexer::autoIndentStyle | ( | ) |
Returns the auto-indentation style. The default is 0 if the language is block structured, or QsciScintilla::AiMaintain if not.
| virtual QColor QsciLexer::color | ( | int | style | ) | const [virtual] |
Returns the foreground colour of the text for style number style. The default colour is that returned by defaultColor().
| virtual bool QsciLexer::eolFill | ( | int | style | ) | const [virtual] |
Returns the end-of-line for style number style. The default is false.
| virtual QFont QsciLexer::font | ( | int | style | ) | const [virtual] |
Returns the font for style number style. The default font is that returned by defaultFont().
| virtual const char* QsciLexer::keywords | ( | int | set | ) | const [virtual] |
Returns the set of keywords for the keyword set set recognised by the lexer as a space separated string. 0 is returned if there is no such set.
Reimplemented in QsciLexerBash, QsciLexerBatch, QsciLexerCMake, QsciLexerCPP, QsciLexerCSharp, QsciLexerCSS, QsciLexerD, QsciLexerHTML, QsciLexerIDL, QsciLexerJava, QsciLexerJavaScript, QsciLexerLua, QsciLexerPerl, QsciLexerPOV, QsciLexerPython, QsciLexerRuby, QsciLexerSQL, QsciLexerTeX, and QsciLexerVHDL.
| virtual QString QsciLexer::description | ( | int | style | ) | const [pure 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.
Implemented in QsciLexerBash, QsciLexerBatch, QsciLexerCMake, QsciLexerCPP, QsciLexerCSharp, QsciLexerCSS, QsciLexerD, QsciLexerDiff, QsciLexerHTML, QsciLexerIDL, QsciLexerJavaScript, QsciLexerLua, QsciLexerMakefile, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerRuby, QsciLexerSQL, QsciLexerTeX, and QsciLexerVHDL.
| virtual QColor QsciLexer::paper | ( | int | style | ) | const [virtual] |
| QColor QsciLexer::defaultColor | ( | ) | const |
| virtual QColor QsciLexer::defaultColor | ( | int | style | ) | const [virtual] |
Returns the default text colour for style number style.
Reimplemented in QsciLexerBash, QsciLexerBatch, QsciLexerCMake, QsciLexerCPP, QsciLexerCSharp, QsciLexerCSS, QsciLexerD, QsciLexerDiff, QsciLexerHTML, QsciLexerIDL, QsciLexerJavaScript, QsciLexerLua, QsciLexerMakefile, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerRuby, QsciLexerSQL, QsciLexerTeX, and QsciLexerVHDL.
| virtual bool QsciLexer::defaultEolFill | ( | int | style | ) | const [virtual] |
Returns the default end-of-line for style number style. The default is false.
Reimplemented in QsciLexerBash, QsciLexerBatch, QsciLexerCPP, QsciLexerCSharp, QsciLexerD, QsciLexerHTML, QsciLexerJavaScript, QsciLexerLua, QsciLexerMakefile, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerRuby, QsciLexerSQL, and QsciLexerVHDL.
| QFont QsciLexer::defaultFont | ( | ) | const |
| virtual QFont QsciLexer::defaultFont | ( | int | style | ) | const [virtual] |
Returns the default font for style number style.
Reimplemented in QsciLexerBash, QsciLexerBatch, QsciLexerCMake, QsciLexerCPP, QsciLexerCSharp, QsciLexerCSS, QsciLexerD, QsciLexerHTML, QsciLexerJavaScript, QsciLexerLua, QsciLexerMakefile, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerRuby, QsciLexerSQL, and QsciLexerVHDL.
| QColor QsciLexer::defaultPaper | ( | ) | const |
| virtual QColor QsciLexer::defaultPaper | ( | int | style | ) | const [virtual] |
Returns the default paper colour for style number style.
Reimplemented in QsciLexerBash, QsciLexerBatch, QsciLexerCMake, QsciLexerCPP, QsciLexerCSharp, QsciLexerD, QsciLexerHTML, QsciLexerJavaScript, QsciLexerLua, QsciLexerMakefile, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerRuby, QsciLexerSQL, and QsciLexerVHDL.
| void QsciLexer::setAPIs | ( | QsciAPIs * | apis | ) |
The current set of APIs is set to apis. If apis is 0 then any existing APIs for this lexer are removed.
| void QsciLexer::setDefaultColor | ( | const QColor & | c | ) |
| void QsciLexer::setDefaultFont | ( | const QFont & | f | ) |
| void QsciLexer::setDefaultPaper | ( | const QColor & | c | ) |
| bool QsciLexer::readSettings | ( | QSettings & | qs, | |
| const char * | prefix = "/Scintilla" | |||
| ) |
The colour, paper, font and end-of-line for each style number, and all lexer specific properties are read from the settings qs. prefix is prepended to the key of each entry. true is returned if there was no error.
| virtual void QsciLexer::refreshProperties | ( | ) | [virtual] |
Causes all properties to be refreshed by emitting the propertyChanged() signal as required.
Reimplemented in QsciLexerBash, QsciLexerCMake, QsciLexerCPP, QsciLexerCSS, QsciLexerD, QsciLexerHTML, QsciLexerLua, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerSQL, and QsciLexerVHDL.
| bool QsciLexer::writeSettings | ( | QSettings & | qs, | |
| const char * | prefix = "/Scintilla" | |||
| ) | const |
The colour, paper, font and end-of-line for each style number, and all lexer specific properties are written to the settings qs. prefix is prepended to the key of each entry. true is returned if there was no error.
| virtual void QsciLexer::setAutoIndentStyle | ( | int | autoindentstyle | ) | [virtual, slot] |
The auto-indentation style is set to autoindentstyle.
| virtual void QsciLexer::setColor | ( | const QColor & | c, | |
| int | style = -1 | |||
| ) | [virtual, slot] |
The foreground colour for style number style is set to c. If style is -1 then the colour is set for all styles.
| virtual void QsciLexer::setEolFill | ( | bool | eoffill, | |
| int | style = -1 | |||
| ) | [virtual, slot] |
The end-of-line fill for style number style is set to eoffill. If style is -1 then the fill is set for all styles.
| virtual void QsciLexer::setFont | ( | const QFont & | f, | |
| int | style = -1 | |||
| ) | [virtual, slot] |
The font for style number style is set to f. If style is -1 then the font is set for all styles.
| virtual void QsciLexer::setPaper | ( | const QColor & | c, | |
| int | style = -1 | |||
| ) | [virtual, slot] |
The background colour for style number style is set to c. If style is -1 then the colour is set for all styles.
| void QsciLexer::colorChanged | ( | const QColor & | c, | |
| int | style | |||
| ) | [signal] |
This signal is emitted when the foreground colour of style number style has changed. The new colour is c.
| void QsciLexer::eolFillChanged | ( | bool | eolfilled, | |
| int | style | |||
| ) | [signal] |
This signal is emitted when the end-of-file fill of style number style has changed. The new fill is eolfilled.
| void QsciLexer::fontChanged | ( | const QFont & | f, | |
| int | style | |||
| ) | [signal] |
This signal is emitted when the font of style number style has changed. The new font is f.
| void QsciLexer::paperChanged | ( | const QColor & | c, | |
| int | style | |||
| ) | [signal] |
This signal is emitted when the background colour of style number style has changed. The new colour is c.
| void QsciLexer::propertyChanged | ( | const char * | prop, | |
| const char * | val | |||
| ) | [signal] |
This signal is emitted when the value of the lexer property prop needs to be changed. The new value is val.
| virtual bool QsciLexer::readProperties | ( | QSettings & | qs, | |
| const QString & | prefix | |||
| ) | [protected, virtual] |
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.
Reimplemented in QsciLexerBash, QsciLexerCMake, QsciLexerCPP, QsciLexerCSS, QsciLexerD, QsciLexerHTML, QsciLexerLua, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerSQL, and QsciLexerVHDL.
| virtual bool QsciLexer::writeProperties | ( | QSettings & | qs, | |
| const QString & | prefix | |||
| ) | const [protected, virtual] |
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.
Reimplemented in QsciLexerBash, QsciLexerCMake, QsciLexerCPP, QsciLexerCSS, QsciLexerD, QsciLexerHTML, QsciLexerLua, QsciLexerPerl, QsciLexerPOV, QsciLexerProperties, QsciLexerPython, QsciLexerSQL, and QsciLexerVHDL.
1.4.7