API reference - Class QSyntaxHighlighter

Notation used in Ruby API documentation

Description: Binding of QSyntaxHighlighter

Class hierarchy: QSyntaxHighlighter » QObject

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Detailed description

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QSyntaxHighlighter::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

[const] QTextBlock currentBlock

Description: Method QTextBlock QSyntaxHighlighter::currentBlock()

This method is protected and can only be called from inside a derived class.

[const] int currentBlockState

Description: Method int QSyntaxHighlighter::currentBlockState()

This method is protected and can only be called from inside a derived class.

[const] QTextBlockUserData ptr currentBlockUserData

Description: Method QTextBlockUserData * QSyntaxHighlighter::currentBlockUserData()

This method is protected and can only be called from inside a derived class.

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QSyntaxHighlighter::customEvent(QEvent *)

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QSyntaxHighlighter::destroyed(QObject *)

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QSyntaxHighlighter::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[const] QTextDocument ptr document

Description: Method QTextDocument * QSyntaxHighlighter::document()

void document=(QTextDocument ptr doc)

Description: Method void QSyntaxHighlighter::setDocument(QTextDocument *doc)

[virtual] bool event(QEvent ptr arg1)

Description: Virtual method bool QSyntaxHighlighter::event(QEvent *)

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QSyntaxHighlighter::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[const] QTextCharFormat format(int pos)

Description: Method QTextCharFormat QSyntaxHighlighter::format(int pos)

This method is protected and can only be called from inside a derived class.

[virtual] void highlightBlock(string text)

Description: Virtual method void QSyntaxHighlighter::highlightBlock(const QString &text)

This method can be reimplemented in a derived class.

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[static] new QSyntaxHighlighter new(QObject ptr parent)

Description: Constructor QSyntaxHighlighter::QSyntaxHighlighter(QObject *parent)

This method creates an object of class QSyntaxHighlighter.

[static] new QSyntaxHighlighter new(QTextEdit ptr parent)

Description: Constructor QSyntaxHighlighter::QSyntaxHighlighter(QTextEdit *parent)

This method creates an object of class QSyntaxHighlighter.

[static] new QSyntaxHighlighter new(QTextDocument ptr parent)

Description: Constructor QSyntaxHighlighter::QSyntaxHighlighter(QTextDocument *parent)

This method creates an object of class QSyntaxHighlighter.

[const] int previousBlockState

Description: Method int QSyntaxHighlighter::previousBlockState()

This method is protected and can only be called from inside a derived class.

[const] int receivers(string signal)

Description: Method int QSyntaxHighlighter::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

void rehighlight

Description: Method void QSyntaxHighlighter::rehighlight()

void rehighlightBlock(const QTextBlock block)

Description: Method void QSyntaxHighlighter::rehighlightBlock(const QTextBlock &block)

[const] QObject ptr sender

Description: Method QObject * QSyntaxHighlighter::sender()

This method is protected and can only be called from inside a derived class.

void setCurrentBlockState(int newState)

Description: Method void QSyntaxHighlighter::setCurrentBlockState(int newState)

This method is protected and can only be called from inside a derived class.

void setCurrentBlockUserData(QTextBlockUserData ptr data)

Description: Method void QSyntaxHighlighter::setCurrentBlockUserData(QTextBlockUserData *data)

This method is protected and can only be called from inside a derived class.

void setDocument(QTextDocument ptr doc)

Description: Method void QSyntaxHighlighter::setDocument(QTextDocument *doc)

void setFormat(int start,int count,const QFont font)

Description: Method void QSyntaxHighlighter::setFormat(int start, int count, const QFont &font)

This method is protected and can only be called from inside a derived class.

void setFormat(int start,int count,const QColor color)

Description: Method void QSyntaxHighlighter::setFormat(int start, int count, const QColor &color)

This method is protected and can only be called from inside a derived class.

void setFormat(int start,int count,const QTextCharFormat format)

Description: Method void QSyntaxHighlighter::setFormat(int start, int count, const QTextCharFormat &format)

This method is protected and can only be called from inside a derived class.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QSyntaxHighlighter::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[static] string tr(string s)

Description: Static method QString QSyntaxHighlighter::tr(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string tr(string s,string c)

Description: Static method QString QSyntaxHighlighter::tr(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string tr(string s,string c,int n)

Description: Static method QString QSyntaxHighlighter::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[static] string trUtf8(string s)

Description: Static method QString QSyntaxHighlighter::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c)

Description: Static method QString QSyntaxHighlighter::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c,int n)

Description: Static method QString QSyntaxHighlighter::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.