QScintilla  2.7.1
Public Types | Public Slots | Public Member Functions | Protected Member Functions
QsciLexerBash Class Reference

#include <qscilexerbash.h>

Inherits QsciLexer.

List of all members.

Public Types

Public Slots

Public Member Functions

Protected Member Functions


Detailed Description

The QsciLexerBash class encapsulates the Scintilla Bash lexer.


Member Enumeration Documentation

anonymous enum

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

Enumerator:
Default 

The default.

Error 

An error.

Comment 

A comment.

Number 

A number.

Keyword 

A keyword.

DoubleQuotedString 

A double-quoted string.

SingleQuotedString 

A single-quoted string.

Operator 

An operator.

Identifier 

An identifier.

Scalar 

A scalar.

ParameterExpansion 

Parameter expansion.

Backticks 

Backticks.

HereDocumentDelimiter 

A here document delimiter.

SingleQuotedHereDocument 

A single quoted here document.


Constructor & Destructor Documentation

QsciLexerBash::QsciLexerBash ( QObject *  parent = 0)

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


Member Function Documentation

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

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

Reimplemented from QsciLexer.

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

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

See also:
defaultPaper()

Reimplemented from QsciLexer.

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

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

See also:
defaultColor()

Reimplemented from QsciLexer.

const char* QsciLexerBash::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 QsciLexerBash::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 QsciLexerBash::refreshProperties ( ) [virtual]

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

Reimplemented from QsciLexer.

bool QsciLexerBash::foldComments ( ) const

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

See also:
setFoldComments()
bool QsciLexerBash::foldCompact ( ) const

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

See also:
setFoldCompact()
virtual void QsciLexerBash::setFoldComments ( bool  fold) [virtual, slot]

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

See also:
foldComments()
virtual void QsciLexerBash::setFoldCompact ( bool  fold) [virtual, slot]

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

See also:
foldCompact()
bool QsciLexerBash::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 QsciLexerBash::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.