QScintilla 2.14.1
QsciLexerVHDL Class Reference

#include <qscilexervhdl.h>

Inherits QsciLexer.

Public Types

enum  {
  Default = 0 , Comment = 1 , CommentLine = 2 ,
  Number = 3 , String = 4 , Operator = 5 ,
  Identifier = 6 , UnclosedString = 7 , Keyword = 8 ,
  StandardOperator = 9 , Attribute = 10 , StandardFunction = 11 ,
  StandardPackage = 12 , StandardType = 13 , KeywordSet7 = 14 ,
  CommentBlock = 15
}

Public Slots

virtual void setFoldComments (bool fold)
virtual void setFoldCompact (bool fold)
virtual void setFoldAtElse (bool fold)
virtual void setFoldAtBegin (bool fold)
virtual void setFoldAtParenthesis (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

 QsciLexerVHDL (QObject *parent=0)
virtual ~QsciLexerVHDL ()
const char * language () const
const char * lexer () const
int braceStyle () const
QColor defaultColor (int style) const
bool defaultEolFill (int style) const
QFont defaultFont (int style) const
QColor defaultPaper (int style) const
const char * keywords (int set) const
QString description (int style) const
void refreshProperties ()
bool foldComments () const
bool foldCompact () const
bool foldAtElse () const
bool foldAtBegin () const
bool foldAtParenthesis () const
Public Member Functions inherited from QsciLexer
 QsciLexer (QObject *parent=0)
virtual ~QsciLexer ()
virtual int lexerId () const
QsciAbstractAPIsapis () 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
QFont defaultFont () const
QColor defaultPaper () const
QsciScintillaeditor () 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
virtual const char * wordCharacters () 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
Protected Member Functions inherited from QsciLexer
QByteArray textAsBytes (const QString &text) const
QString bytesAsText (const char *bytes, int size) 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 QsciLexerVHDL class encapsulates the Scintilla VHDL lexer.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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

Enumerator
Default 

The default.

Comment 

A comment.

CommentLine 

A comment line.

Number 

A number.

String 

A string.

Operator 

An operator.

Identifier 

An identifier.

UnclosedString 

The end of a line where a string is not closed.

Keyword 

A keyword.

StandardOperator 

A standard operator.

Attribute 

An attribute.

StandardFunction 

A standard function.

StandardPackage 

A standard package.

StandardType 

A standard type.

KeywordSet7 

A keyword defined in keyword set number 7. The class must be sub-classed and re-implement keywords() to make use of this style.

CommentBlock 

A comment block.

Constructor & Destructor Documentation

◆ QsciLexerVHDL()

QsciLexerVHDL::QsciLexerVHDL ( QObject * parent = 0)

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

Referenced by writeProperties().

Member Function Documentation

◆ language()

const char * QsciLexerVHDL::language ( ) const
virtual

Returns the name of the language.

Implements QsciLexer.

◆ lexer()

const char * QsciLexerVHDL::lexer ( ) const
virtual

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

Reimplemented from QsciLexer.

◆ braceStyle()

int QsciLexerVHDL::braceStyle ( ) const
virtual

Returns the style used for braces for brace matching.

Reimplemented from QsciLexer.

◆ defaultColor()

QColor QsciLexerVHDL::defaultColor ( int style) const
virtual

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

See also
defaultPaper()

Reimplemented from QsciLexer.

◆ defaultEolFill()

bool QsciLexerVHDL::defaultEolFill ( int style) const
virtual

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

Reimplemented from QsciLexer.

◆ defaultFont()

QFont QsciLexerVHDL::defaultFont ( int style) const
virtual

Returns the font for style number style.

Reimplemented from QsciLexer.

◆ defaultPaper()

QColor QsciLexerVHDL::defaultPaper ( int style) const
virtual

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

See also
defaultColor()

Reimplemented from QsciLexer.

◆ keywords()

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

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

Reimplemented from QsciLexer.

◆ foldComments()

bool QsciLexerVHDL::foldComments ( ) const

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

See also
setFoldComments()

◆ foldCompact()

bool QsciLexerVHDL::foldCompact ( ) const

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

See also
setFoldCompact()

◆ foldAtElse()

bool QsciLexerVHDL::foldAtElse ( ) const

Returns true if else blocks can be folded.

See also
setFoldAtElse()

◆ foldAtBegin()

bool QsciLexerVHDL::foldAtBegin ( ) const

Returns true if begin blocks can be folded.

See also
setFoldAtBegin()

◆ foldAtParenthesis()

bool QsciLexerVHDL::foldAtParenthesis ( ) const

Returns true if blocks can be folded at a parenthesis.

See also
setFoldAtParenthesis()

◆ setFoldComments

virtual void QsciLexerVHDL::setFoldComments ( bool fold)
virtualslot

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

See also
foldComments()

◆ setFoldCompact

virtual void QsciLexerVHDL::setFoldCompact ( bool fold)
virtualslot

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

See also
foldCompact()

◆ setFoldAtElse

virtual void QsciLexerVHDL::setFoldAtElse ( bool fold)
virtualslot

If fold is true then else blocks can be folded. The default is true.

See also
foldAtElse()

◆ setFoldAtBegin

virtual void QsciLexerVHDL::setFoldAtBegin ( bool fold)
virtualslot

If fold is true then begin blocks can be folded. The default is true.

See also
foldAtBegin()

◆ setFoldAtParenthesis

virtual void QsciLexerVHDL::setFoldAtParenthesis ( bool fold)
virtualslot

If fold is true then blocks can be folded at a parenthesis. The default is true.

See also
foldAtParenthesis()

◆ readProperties()

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

References QsciLexerVHDL().