# QextScintillaLexerPython Class Reference

The QextScintillaLexerPython class encapsulates the Scintilla Python lexer. More...

`#include <qextscintillalexerpython.h>`

Inherits QextScintillaLexer.

List of all members.

## Public Types

- Default = 0
- WhiteSpace = Default
- Comment = 1
- Number = 2
- DoubleQuotedString = 3
- SingleQuotedString = 4
- Keyword = 5
- TripleSingleQuotedString = 6
- TripleDoubleQuotedString = 7
- ClassName = 8
- FunctionMethodName = 9
- Operator = 10
- Identifier = 11
- CommentBlock = 12
- UnclosedString = 13
- HighlightedIdentifier = 14
- Decorator = 15
- NoWarning = 0
- Inconsistent = 1
- TabsAfterSpaces = 2
- Spaces = 3
- Tabs = 4
- enum {
  Default = 0, WhiteSpace = Default, Comment = 1,
  Number = 2, DoubleQuotedString = 3, SingleQuotedString = 4,
  Keyword = 5, TripleSingleQuotedString = 6, TripleDoubleQuotedString = 7,
  ClassName = 8, FunctionMethodName = 9, Operator = 10,
  Identifier = 11, CommentBlock = 12, UnclosedString = 13,
  HighlightedIdentifier = 14, Decorator = 15
  }
- enum IndentationWarning {
  NoWarning = 0, Inconsistent = 1, TabsAfterSpaces = 2,
  Spaces = 3, Tabs = 4
  }

## Public Slots

- virtual void setFoldComments (bool fold)
- virtual void setFoldQuotes (bool fold)
- virtual void setIndentationWarning (IndentationWarning warn)

## Public Member Functions

- QextScintillaLexerPython (QObject *parent=0, const char *name=0)
- virtual ~QextScintillaLexerPython ()
- const char * language () const
- const char * lexer () const
- const char * autoCompletionStartCharacters () const
- int blockLookback () const
- const char * blockStart (int *style=0) const
- int braceStyle () const
- QColor color (int style) const
- bool eolFill (int style) const
- QFont font (int style) const
- const char * keywords (int set) const
- QString description (int style) const
- QColor paper (int style) const
- void refreshProperties ()
- bool foldComments () const
- bool foldQuotes () const
- IndentationWarning indentationWarning () const

## Protected Member Functions

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

## Detailed Description

The QextScintillaLexerPython class encapsulates the Scintilla Python lexer.

## Member Enumeration Documentation

anonymous enum

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

Enumerator:

  Default | The default.

  WhiteSpace

  Deprecated:
    White space.

  Comment | A comment.
  Number | A number.
  DoubleQuotedString | A double-quoted string.
  SingleQuotedString | A single-quoted string.
  Keyword | A keyword.
  TripleSingleQuotedString | A triple single-quoted string.
  TripleDoubleQuotedString | A triple double-quoted string.
  ClassName | The name of a class.
  FunctionMethodName | The name of a function or method.
  Operator | An operator.
  Identifier | An identifier.
  CommentBlock | A comment block.
  UnclosedString | The end of a line where a string is not closed.
  HighlightedIdentifier | A highlighted identifier. These are defined by keyword set 2. Reimplement keywords() to define keyword set 2.
  Decorator | A decorator.

enum QextScintillaLexerPython::IndentationWarning

This enum defines the different conditions that can cause indentations to be displayed as being bad.

Enumerator:

  NoWarning | Bad indentation is not displayed differently.
  Inconsistent | The indentation is inconsistent when compared to the previous line, ie. it is made up of a different combination of tabs and/or spaces.
  TabsAfterSpaces | The indentation is made up of spaces followed by tabs.
  Spaces | The indentation contains spaces.
  Tabs | The indentation contains tabs.

## Constructor & Destructor Documentation

QextScintillaLexerPython::QextScintillaLexerPython | ( | QObject * | parent = `0`,
|  | const char * | name = `0` |
| ) |  |  |

Construct a QextScintillaLexerPython with parent parent and name name. parent is typically the QextScintilla instance.

virtual QextScintillaLexerPython::~QextScintillaLexerPython | ( |  | ) | `[virtual]`

Destroys the QextScintillaLexerPython instance.

## Member Function Documentation

const char* QextScintillaLexerPython::language | ( |  | ) | const`[virtual]`

Returns the name of the language.

Implements QextScintillaLexer.

const char* QextScintillaLexerPython::lexer | ( |  | ) | const`[virtual]`

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

Implements QextScintillaLexer.

QColor QextScintillaLexerPython::color | ( | int | style | ) | const`[virtual]`

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

See also:
  paper()

Reimplemented from QextScintillaLexer.

bool QextScintillaLexerPython::eolFill | ( | int | style | ) | const`[virtual]`

Returns the end-of-line fill for style number style.

Reimplemented from QextScintillaLexer.

QFont QextScintillaLexerPython::font | ( | int | style | ) | const`[virtual]`

Returns the font for style number style.

Reimplemented from QextScintillaLexer.

const char* QextScintillaLexerPython::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 QextScintillaLexer.

QString QextScintillaLexerPython::description | ( | int | style | ) | const`[virtual]`

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

Implements QextScintillaLexer.

QColor QextScintillaLexerPython::paper | ( | int | style | ) | const`[virtual]`

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

See also:
  color()

Reimplemented from QextScintillaLexer.

void QextScintillaLexerPython::refreshProperties | ( |  | ) | `[virtual]`

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

Reimplemented from QextScintillaLexer.

bool QextScintillaLexerPython::foldComments | ( |  | ) | const

Returns TRUE if indented comment blocks can be folded.

See also:
  setFoldComments()

bool QextScintillaLexerPython::foldQuotes | ( |  | ) | const

Returns TRUE if triple quoted strings can be folded.

See also:
  setFoldQuotes()

IndentationWarning QextScintillaLexerPython::indentationWarning | ( |  | ) | const

Returns the condition that will cause bad indentations to be displayed.

See also:
  setIndentationWarning()

virtual void QextScintillaLexerPython::setFoldComments | ( | bool | fold | ) | `[virtual, slot]`

If fold is TRUE then indented comment blocks can be folded. The default is FALSE.

See also:
  foldComments()

virtual void QextScintillaLexerPython::setFoldQuotes | ( | bool | fold | ) | `[virtual, slot]`

If fold is TRUE then triple quoted strings can be folded. The default is FALSE.

See also:
  foldQuotes()

virtual void QextScintillaLexerPython::setIndentationWarning | ( | IndentationWarning | warn | ) | `[virtual, slot]`

Sets the condition that will cause bad indentations to be displayed.

See also:
  indentationWarning()

bool QextScintillaLexerPython::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 from QextScintillaLexer.

bool QextScintillaLexerPython::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 from QextScintillaLexer.