Qt 4.8
|
#include <qscriptsyntaxhighlighter_p.h>
Public Functions | |
QScriptSyntaxHighlighter (QTextDocument *document=0) | |
~QScriptSyntaxHighlighter () | |
Public Functions inherited from QSyntaxHighlighter | |
QTextDocument * | document () const |
Returns the QTextDocument on which this syntax highlighter is installed. More... | |
QSyntaxHighlighter (QObject *parent) | |
Constructs a QSyntaxHighlighter with the given parent. More... | |
QSyntaxHighlighter (QTextDocument *parent) | |
Constructs a QSyntaxHighlighter and installs it on parent. More... | |
QSyntaxHighlighter (QTextEdit *parent) | |
Constructs a QSyntaxHighlighter and installs it on parent 's QTextDocument. More... | |
void | setDocument (QTextDocument *doc) |
Installs the syntax highlighter on the given QTextDocument doc. More... | |
virtual | ~QSyntaxHighlighter () |
Destructor. More... | |
Public Functions inherited from QObject | |
bool | blockSignals (bool b) |
If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More... | |
const QObjectList & | children () const |
Returns a list of child objects. More... | |
bool | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
bool | disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0) |
bool | disconnect (const QObject *receiver, const char *member=0) |
void | dumpObjectInfo () |
Dumps information about signal connections, etc. More... | |
void | dumpObjectTree () |
Dumps a tree of children to the debug output. More... | |
QList< QByteArray > | dynamicPropertyNames () const |
Returns the names of all properties that were dynamically added to the object using setProperty(). More... | |
virtual bool | event (QEvent *) |
This virtual function receives events to an object and should return true if the event e was recognized and processed. More... | |
virtual bool | eventFilter (QObject *, QEvent *) |
Filters events if this object has been installed as an event filter for the watched object. More... | |
template<typename T > | |
T | findChild (const QString &aName=QString()) const |
Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More... | |
template<typename T > | |
QList< T > | findChildren (const QString &aName=QString()) const |
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More... | |
template<typename T > | |
QList< T > | findChildren (const QRegExp &re) const |
bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More... | |
void | installEventFilter (QObject *) |
Installs an event filter filterObj on this object. More... | |
bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false. More... | |
void | killTimer (int id) |
Kills the timer with timer identifier, id. More... | |
virtual const QMetaObject * | metaObject () const |
Returns a pointer to the meta-object of this object. More... | |
void | moveToThread (QThread *thread) |
Changes the thread affinity for this object and its children. More... | |
QString | objectName () const |
QObject * | parent () const |
Returns a pointer to the parent object. More... | |
QVariant | property (const char *name) const |
Returns the value of the object's name property. More... | |
Q_INVOKABLE | QObject (QObject *parent=0) |
Constructs an object with parent object parent. More... | |
void | removeEventFilter (QObject *) |
Removes an event filter object obj from this object. More... | |
void | setObjectName (const QString &name) |
void | setParent (QObject *) |
Makes the object a child of parent. More... | |
bool | setProperty (const char *name, const QVariant &value) |
Sets the value of the object's name property to value. More... | |
void | setUserData (uint id, QObjectUserData *data) |
bool | signalsBlocked () const |
Returns true if signals are blocked; otherwise returns false. More... | |
int | startTimer (int interval) |
Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More... | |
QThread * | thread () const |
Returns the thread in which the object lives. More... | |
QObjectUserData * | userData (uint id) const |
virtual | ~QObject () |
Destroys the object, deleting all its child objects. More... | |
Protected Functions | |
void | highlightBlock (const QString &text) |
Highlights the given text block. More... | |
Protected Functions inherited from QSyntaxHighlighter | |
QTextBlock | currentBlock () const |
Returns the current text block. More... | |
int | currentBlockState () const |
Returns the state of the current text block. More... | |
QTextBlockUserData * | currentBlockUserData () const |
Returns the QTextBlockUserData object previously attached to the current text block. More... | |
QTextCharFormat | format (int pos) const |
Returns the format at position inside the syntax highlighter's current text block. More... | |
int | previousBlockState () const |
Returns the end state of the text block previous to the syntax highlighter's current block. More... | |
void | setCurrentBlockState (int newState) |
Sets the state of the current text block to newState. More... | |
void | setCurrentBlockUserData (QTextBlockUserData *data) |
Attaches the given data to the current text block. More... | |
void | setFormat (int start, int count, const QTextCharFormat &format) |
This function is applied to the syntax highlighter's current text block (i.e. More... | |
void | setFormat (int start, int count, const QColor &color) |
The specified color is applied to the current text block from the start position for a length of count characters. More... | |
void | setFormat (int start, int count, const QFont &font) |
The specified font is applied to the current text block from the start position for a length of count characters. More... | |
Protected Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *) |
This event handler can be reimplemented in a subclass to receive child events. More... | |
virtual void | connectNotify (const char *signal) |
This virtual function is called when something has been connected to signal in this object. More... | |
virtual void | customEvent (QEvent *) |
This event handler can be reimplemented in a subclass to receive custom events. More... | |
virtual void | disconnectNotify (const char *signal) |
This virtual function is called when something has been disconnected from signal in this object. More... | |
QObject (QObjectPrivate &dd, QObject *parent=0) | |
int | receivers (const char *signal) const |
Returns the number of receivers connected to the signal. More... | |
QObject * | sender () const |
Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More... | |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *) |
This event handler can be reimplemented in a subclass to receive timer events for the object. More... | |
Private Functions | |
void | highlightWord (int currentPos, const QString &buffer) |
Properties | |
QTextCharFormat | m_formats [NumScriptFormats] |
Additional Inherited Members | |
Public Slots inherited from QSyntaxHighlighter | |
void | rehighlight () |
Reapplies the highlighting to the whole document. More... | |
void | rehighlightBlock (const QTextBlock &block) |
Reapplies the highlighting to the given QTextBlock block. More... | |
Public Slots inherited from QObject | |
void | deleteLater () |
Schedules this object for deletion. More... | |
Signals inherited from QObject | |
void | destroyed (QObject *=0) |
This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More... | |
Static Public Functions inherited from QObject | |
static bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More... | |
static bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
Disconnects signal in object sender from method in object receiver. More... | |
static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
static uint | registerUserData () |
static QString | tr (const char *sourceText, const char *comment=0, int n=-1) |
static QString | trUtf8 (const char *sourceText, const char *comment=0, int n=-1) |
Static Public Variables inherited from QObject | |
static const QMetaObject | staticMetaObject |
This variable stores the meta-object for the class. More... | |
Protected Variables inherited from QObject | |
QScopedPointer< QObjectData > | d_ptr |
Static Protected Variables inherited from QObject | |
static const QMetaObject | staticQtMetaObject |
Related Functions inherited from QObject | |
T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QRegExp ®Exp)() |
T * | qobject_cast (QObject *object) |
QObjectList | |
void * | qt_find_obj_child (QObject *parent, const char *type, const QString &name) |
Returns a pointer to the object named name that inherits type and with a given parent. More... | |
Definition at line 66 of file qscriptsyntaxhighlighter_p.h.
|
private |
Enumerator | |
---|---|
ScriptTextFormat | |
ScriptNumberFormat | |
ScriptStringFormat | |
ScriptTypeFormat | |
ScriptKeywordFormat | |
ScriptPreprocessorFormat | |
ScriptLabelFormat | |
ScriptCommentFormat | |
NumScriptFormats |
Definition at line 78 of file qscriptsyntaxhighlighter_p.h.
QScriptSyntaxHighlighter::QScriptSyntaxHighlighter | ( | QTextDocument * | document = 0 | ) |
Definition at line 151 of file qscriptsyntaxhighlighter.cpp.
QScriptSyntaxHighlighter::~QScriptSyntaxHighlighter | ( | ) |
Definition at line 165 of file qscriptsyntaxhighlighter.cpp.
|
protectedvirtual |
Highlights the given text block.
This function is called when necessary by the rich text engine, i.e. on text blocks which have changed.
To provide your own syntax highlighting, you must subclass QSyntaxHighlighter and reimplement highlightBlock(). In your reimplementation you should parse the block's text and call setFormat() as often as necessary to apply any font and color changes that you require. For example:
Some syntaxes can have constructs that span several text blocks. For example, a C++ syntax highlighter should be able to cope with /
*...*
/
multiline comments. To deal with these cases it is necessary to know the end state of the previous text block (e.g. "in comment").
Inside your highlightBlock() implementation you can query the end state of the previous text block using the previousBlockState() function. After parsing the block you can save the last state using setCurrentBlockState().
The currentBlockState() and previousBlockState() functions return an int value. If no state is set, the returned value is -1. You can designate any other value to identify any given state using the setCurrentBlockState() function. Once the state is set the QTextBlock keeps that value until it is set set again or until the corresponding paragraph of text gets deleted.
For example, if you're writing a simple C++ syntax highlighter, you might designate 1 to signify "in comment". For a text block that ended in the middle of a comment you'd set 1 using setCurrentBlockState, and for other paragraphs you'd set 0. In your parsing code if the return value of previousBlockState() is 1, you would highlight the text as a C++ comment until you reached the closing *
/
.
Implements QSyntaxHighlighter.
Definition at line 169 of file qscriptsyntaxhighlighter.cpp.
|
private |
Definition at line 518 of file qscriptsyntaxhighlighter.cpp.
Referenced by highlightBlock().
|
private |
Definition at line 85 of file qscriptsyntaxhighlighter_p.h.
Referenced by highlightBlock(), highlightWord(), and QScriptSyntaxHighlighter().