QScintilla  2.7.1
Public Types | Public Member Functions | Protected Member Functions
QsciLexerRuby Class Reference

#include <qscilexerruby.h>

Inherits QsciLexer.

List of all members.

Public Types

Public Member Functions

Protected Member Functions


Detailed Description

The QsciLexerRuby class encapsulates the Scintilla Ruby lexer.


Member Enumeration Documentation

anonymous enum

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

Enumerator:
Default 

The default.

Error 

An error.

Comment 

A comment.

POD 

A POD.

Number 

A number.

Keyword 

A keyword.

DoubleQuotedString 

A double-quoted string.

SingleQuotedString 

A single-quoted string.

ClassName 

The name of a class.

FunctionMethodName 

The name of a function or method.

Operator 

An operator.

Identifier 

An identifier.

Regex 

A regular expression.

Global 

A global.

Symbol 

A symbol.

ModuleName 

The name of a module.

InstanceVariable 

An instance variable.

ClassVariable 

A class variable.

Backticks 

Backticks.

DataSection 

A data section.

HereDocumentDelimiter 

A here document delimiter.

HereDocument 

A here document.

PercentStringq 

A q string.

PercentStringQ 

A Q string.

PercentStringx 

A x string.

PercentStringr 

A r string.

PercentStringw 

A w string.

DemotedKeyword 

A demoted keyword.

Stdin 

stdin.

Stdout 

stdout.

Stderr 

stderr.


Constructor & Destructor Documentation

QsciLexerRuby::QsciLexerRuby ( QObject *  parent = 0)

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


Member Function Documentation

const char* QsciLexerRuby::lexer ( ) const [virtual]

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

Reimplemented from QsciLexer.

QColor QsciLexerRuby::defaultColor ( int  style) const [virtual]

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

See also:
defaultpaper()

Reimplemented from QsciLexer.

QColor QsciLexerRuby::defaultPaper ( int  style) const [virtual]

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

See also:
defaultColor()

Reimplemented from QsciLexer.

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

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

void QsciLexerRuby::refreshProperties ( ) [virtual]

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

Reimplemented from QsciLexer.

void QsciLexerRuby::setFoldComments ( bool  fold)

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

See also:
foldComments()
bool QsciLexerRuby::foldComments ( ) const [inline]

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

See also:
setFoldComments()
void QsciLexerRuby::setFoldCompact ( bool  fold)

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

See also:
foldCompact()
bool QsciLexerRuby::foldCompact ( ) const [inline]

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

See also:
setFoldCompact()
bool QsciLexerRuby::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 QsciLexer.

bool QsciLexerRuby::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 QsciLexer.