Back to Notepad

QScintilla: QsciLexerProperties Class Reference

src/qscint/doc/html/classQsciLexerProperties.html

latest13.5 KB
Original Source

| QScintilla 2.12.1 |

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

QsciLexerProperties Class Reference

#include <qscilexerproperties.h>

Inherits QsciLexer.

|

Public Types

| | enum | {
Default = 0, Comment = 1, Section = 2,
Assignment = 3, DefaultValue = 4, Key = 5
} | | |

|

Public Slots

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

| | | QsciLexerProperties (QObject *parent=0) | | | | virtual | ~QsciLexerProperties () | | | | const char * | language () const | | | | const char * | lexer () 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 | | | | QString | description (int style) const | | | | void | refreshProperties () | | | | bool | foldCompact () const | | | | void | setInitialSpaces (bool enable) | | | | bool | initialSpaces () 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 int | braceStyle () 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 const char * | keywords (int set) 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 QsciLexerProperties class encapsulates the Scintilla Properties lexer.

Member Enumeration Documentation

anonymous enum

| anonymous enum |

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

Enumerator
Default

The default.

| | Comment |

A comment.

| | Section |

A section.

| | Assignment |

An assignment operator.

| | DefaultValue |

A default value.

| | Key |

A key.

|

Constructor & Destructor Documentation

QsciLexerProperties()

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

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

Member Function Documentation

lexer()

|

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

| virtual |

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

Reimplemented from QsciLexer.

defaultColor()

|

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

| virtual |

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

See alsodefaultPaper()

Reimplemented from QsciLexer.

defaultPaper()

|

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

| virtual |

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

See alsodefaultColor()

Reimplemented from QsciLexer.

description()

|

| QString QsciLexerProperties::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 QsciLexerProperties::refreshProperties | ( | | ) | |

| virtual |

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

Reimplemented from QsciLexer.

foldCompact()

|

| bool QsciLexerProperties::foldCompact | ( | | ) | const |

| inline |

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

See alsosetFoldCompact()

setInitialSpaces()

| void QsciLexerProperties::setInitialSpaces | ( | bool | enable | ) | |

If enable is true then initial spaces in a line are allowed. The default is true.

See alsoinitialSpaces()

initialSpaces()

|

| bool QsciLexerProperties::initialSpaces | ( | | ) | const |

| inline |

Returns true if initial spaces in a line are allowed.

See alsosetInitialSpaces()

setFoldCompact

|

| virtual void QsciLexerProperties::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 QsciLexerProperties::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 QsciLexerProperties::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