Back to Notepad

QScintilla: QsciLexerAVS Class Reference

src/qscint/doc/html/classQsciLexerAVS.html

latest14.5 KB
Original Source

| QScintilla 2.12.1 |

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

QsciLexerAVS Class Reference

#include <qscilexeravs.h>

Inherits QsciLexer.

|

Public Types

| | enum | {
Default = 0, BlockComment = 1, NestedBlockComment = 2,
LineComment = 3, Number = 4, Operator = 5,
Identifier = 6, String = 7, TripleString = 8,
Keyword = 9, Filter = 10, Plugin = 11,
Function = 12, ClipProperty = 13, KeywordSet6 = 14
} | | |

|

Public Slots

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

| | | QsciLexerAVS (QObject *parent=0) | | | | virtual | ~QsciLexerAVS () | | | | const char * | language () const | | | | const char * | lexer () const | | | | int | braceStyle () const | | | | const char * | wordCharacters () const | | | | QColor | defaultColor (int style) const | | | | QFont | defaultFont (int style) const | | | | const char * | keywords (int set) const | | | | QString | description (int style) const | | | | void | refreshProperties () | | | | 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 | | | | virtual QStringList | autoCompletionWordSeparators () const | | | | int | autoIndentStyle () | | | | virtual const char * | blockEnd (int *style=0) const | | | | virtual int | blockLookback () const | | | | virtual const char * | blockStart (int *style=0) const | | | | virtual const char * | blockStartKeyword (int *style=0) 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 | | | | virtual bool | defaultEolFill (int style) const | | | | QFont | defaultFont () const | | | | QColor | defaultPaper () const | | | | virtual QColor | defaultPaper (int style) 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 QsciLexerAVS class encapsulates the Scintilla AVS lexer.

Member Enumeration Documentation

anonymous enum

| anonymous enum |

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

Enumerator
Default

The default.

| | BlockComment |

A block comment.

| | NestedBlockComment |

A nested block comment.

| | LineComment |

A line comment.

| | Number |

A number.

| | Operator |

An operator.

| | Identifier |

An identifier.

| | String |

A string.

| | TripleString |

A triple quoted string.

| | Keyword |

A keyword (as defined by keyword set number 1)..

| | Filter |

A filter (as defined by keyword set number 2).

| | Plugin |

A plugin (as defined by keyword set number 3).

| | Function |

A function (as defined by keyword set number 4).

| | ClipProperty |

A clip property (as defined by keyword set number 5).

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

|

Constructor & Destructor Documentation

QsciLexerAVS()

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

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

Member Function Documentation

lexer()

|

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

| virtual |

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

Reimplemented from QsciLexer.

defaultColor()

|

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

| virtual |

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

See alsodefaultPaper()

Reimplemented from QsciLexer.

keywords()

|

| const char* QsciLexerAVS::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 QsciLexerAVS::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 QsciLexerAVS::refreshProperties | ( | | ) | |

| virtual |

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

Reimplemented from QsciLexer.

foldComments()

| bool QsciLexerAVS::foldComments | ( | | ) | const |

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

See alsosetFoldComments()

foldCompact()

| bool QsciLexerAVS::foldCompact | ( | | ) | const |

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

See alsosetFoldCompact()

setFoldComments

|

| virtual void QsciLexerAVS::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 QsciLexerAVS::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 QsciLexerAVS::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.

Reimplemented from QsciLexer.

writeProperties()

|

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

Reimplemented from QsciLexer.


Generated by 1.8.20