Qt 4.8
Public Slots | Public Functions | Protected Functions | List of all members
QSyntaxHighlighter Class Referenceabstract

The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can use the class to query a document's current formatting or user data. More...

#include <qsyntaxhighlighter.h>

Inheritance diagram for QSyntaxHighlighter:
QObject QScriptSyntaxHighlighter

Public Slots

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...
 

Public Functions

QTextDocumentdocument () 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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () 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 >
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 QMetaObjectmetaObject () 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
 
QObjectparent () 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...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 

Protected Functions

QTextBlock currentBlock () const
 Returns the current text block. More...
 
int currentBlockState () const
 Returns the state of the current text block. More...
 
QTextBlockUserDatacurrentBlockUserData () 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...
 
virtual void highlightBlock (const QString &text)=0
 Highlights the given 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...
 
QObjectsender () 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...
 

Additional Inherited Members

- 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< QObjectDatad_ptr
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can use the class to query a document's current formatting or user data.

Note
This class or function is reentrant.
Since
4.1

The QSyntaxHighlighter class is a base class for implementing QTextEdit syntax highlighters. A syntax highligher automatically highlights parts of the text in a QTextEdit, or more generally in a QTextDocument. Syntax highlighters are often used when the user is entering text in a specific format (for example source code) and help the user to read the text and identify syntax errors.

To provide your own syntax highlighting, you must subclass QSyntaxHighlighter and reimplement highlightBlock().

When you create an instance of your QSyntaxHighlighter subclass, pass it the QTextEdit or QTextDocument that you want the syntax highlighting to be applied to. For example:

QTextEdit *editor = new QTextEdit;
MyHighlighter *highlighter = new MyHighlighter(editor->document());

After this your highlightBlock() function will be called automatically whenever necessary. Use your highlightBlock() function to apply formatting (e.g. setting the font and color) to the text that is passed to it. QSyntaxHighlighter provides the setFormat() function which applies a given QTextCharFormat on the current text block. For example:

void MyHighlighter::highlightBlock(const QString &text)
{
QTextCharFormat myClassFormat;
myClassFormat.setFontWeight(QFont::Bold);
QString pattern = "\\bMy[A-Za-z]+\\b";
QRegExp expression(pattern);
int index = text.indexOf(expression);
while (index >= 0) {
int length = expression.matchedLength();
setFormat(index, length, myClassFormat);
index = text.indexOf(expression, index + length);
}
}

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 is deleted.

For example, if you're writing a simple C++ syntax highlighter, you might designate 1 to signify "in comment":

QTextCharFormat multiLineCommentFormat;
multiLineCommentFormat.setForeground(Qt::red);
QRegExp startExpression("/\\*");
QRegExp endExpression("\\*/");
int startIndex = 0;
if (previousBlockState() != 1)
startIndex = text.indexOf(startExpression);
while (startIndex >= 0) {
int endIndex = text.indexOf(endExpression, startIndex);
int commentLength;
if (endIndex == -1) {
commentLength = text.length() - startIndex;
} else {
commentLength = endIndex - startIndex
+ endExpression.matchedLength();
}
setFormat(startIndex, commentLength, multiLineCommentFormat);
startIndex = text.indexOf(startExpression,
startIndex + commentLength);
}

In the example above, we first set the current block state to 0. Then, if the previous block ended within a comment, we higlight from the beginning of the current block ({startIndex = 0}). Otherwise, we search for the given start expression. If the specified end expression cannot be found in the text block, we change the current block state by calling setCurrentBlockState(), and make sure that the rest of the block is higlighted.

In addition you can query the current formatting and user data using the format() and currentBlockUserData() functions respectively. You can also attach user data to the current text block using the setCurrentBlockUserData() function. QTextBlockUserData can be used to store custom settings. In the case of syntax highlighting, it is in particular interesting as cache storage for information that you may figure out while parsing the paragraph's text. For an example, see the setCurrentBlockUserData() documentation.

See also
QTextEdit, {Syntax Highlighter Example}

Definition at line 66 of file qsyntaxhighlighter.h.

Constructors and Destructors

◆ QSyntaxHighlighter() [1/3]

QSyntaxHighlighter::QSyntaxHighlighter ( QObject parent)

Constructs a QSyntaxHighlighter with the given parent.

Definition at line 318 of file qsyntaxhighlighter.cpp.

319  : QObject(*new QSyntaxHighlighterPrivate, parent)
320 {
321 }
Q_INVOKABLE QObject(QObject *parent=0)
Constructs an object with parent object parent.
Definition: qobject.cpp:753

◆ QSyntaxHighlighter() [2/3]

QSyntaxHighlighter::QSyntaxHighlighter ( QTextDocument parent)

Constructs a QSyntaxHighlighter and installs it on parent.

The specified QTextDocument also becomes the owner of the QSyntaxHighlighter.

Definition at line 328 of file qsyntaxhighlighter.cpp.

329  : QObject(*new QSyntaxHighlighterPrivate, parent)
330 {
331  setDocument(parent);
332 }
Q_INVOKABLE QObject(QObject *parent=0)
Constructs an object with parent object parent.
Definition: qobject.cpp:753
void setDocument(QTextDocument *doc)
Installs the syntax highlighter on the given QTextDocument doc.

◆ QSyntaxHighlighter() [3/3]

QSyntaxHighlighter::QSyntaxHighlighter ( QTextEdit parent)

Constructs a QSyntaxHighlighter and installs it on parent 's QTextDocument.

The specified QTextEdit also becomes the owner of the QSyntaxHighlighter.

Definition at line 339 of file qsyntaxhighlighter.cpp.

340  : QObject(*new QSyntaxHighlighterPrivate, parent)
341 {
342  setDocument(parent->document());
343 }
Q_INVOKABLE QObject(QObject *parent=0)
Constructs an object with parent object parent.
Definition: qobject.cpp:753
QTextDocument * document() const
Returns a pointer to the underlying document.
Definition: qtextedit.cpp:804
void setDocument(QTextDocument *doc)
Installs the syntax highlighter on the given QTextDocument doc.

◆ ~QSyntaxHighlighter()

QSyntaxHighlighter::~QSyntaxHighlighter ( )
virtual

Destructor.

Uninstalls this syntax highlighter from the text document.

Definition at line 348 of file qsyntaxhighlighter.cpp.

349 {
350  setDocument(0);
351 }
void setDocument(QTextDocument *doc)
Installs the syntax highlighter on the given QTextDocument doc.

Functions

◆ currentBlock()

QTextBlock QSyntaxHighlighter::currentBlock ( ) const
protected

Returns the current text block.

Since
4.4

Definition at line 676 of file qsyntaxhighlighter.cpp.

Referenced by QScriptSyntaxHighlighter::highlightBlock().

677 {
678  Q_D(const QSyntaxHighlighter);
679  return d->currentBlock;
680 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...

◆ currentBlockState()

int QSyntaxHighlighter::currentBlockState ( ) const
protected

Returns the state of the current text block.

If no value is set, the returned value is -1.

Definition at line 587 of file qsyntaxhighlighter.cpp.

588 {
589  Q_D(const QSyntaxHighlighter);
590  if (!d->currentBlock.isValid())
591  return -1;
592 
593  return d->currentBlock.userState();
594 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...

◆ currentBlockUserData()

QTextBlockUserData * QSyntaxHighlighter::currentBlockUserData ( ) const
protected

Returns the QTextBlockUserData object previously attached to the current text block.

See also
QTextBlock::userData(), setCurrentBlockUserData()

Definition at line 659 of file qsyntaxhighlighter.cpp.

660 {
661  Q_D(const QSyntaxHighlighter);
662  if (!d->currentBlock.isValid())
663  return 0;
664 
665  return d->currentBlock.userData();
666 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...

◆ document()

QTextDocument * QSyntaxHighlighter::document ( ) const

Returns the QTextDocument on which this syntax highlighter is installed.

Definition at line 383 of file qsyntaxhighlighter.cpp.

Referenced by QTextBlock::operator<().

384 {
385  Q_D(const QSyntaxHighlighter);
386  return d->doc;
387 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...

◆ format()

QTextCharFormat QSyntaxHighlighter::format ( int  pos) const
protected

Returns the format at position inside the syntax highlighter's current text block.

Definition at line 555 of file qsyntaxhighlighter.cpp.

Referenced by QScriptSyntaxHighlighter::highlightBlock(), and setFormat().

556 {
557  Q_D(const QSyntaxHighlighter);
558  if (pos < 0 || pos >= d->formatChanges.count())
559  return QTextCharFormat();
560  return d->formatChanges.at(pos);
561 }
double d
Definition: qnumeric_p.h:62
The QTextCharFormat class provides formatting information for characters in a QTextDocument.
Definition: qtextformat.h:372
#define Q_D(Class)
Definition: qglobal.h:2482
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...

◆ highlightBlock()

void QSyntaxHighlighter::highlightBlock ( const QString text)
protectedpure virtual

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:

void MyHighlighter::highlightBlock(const QString &text)
{
QTextCharFormat myClassFormat;
myClassFormat.setFontWeight(QFont::Bold);
QString pattern = "\\bMy[A-Za-z]+\\b";
QRegExp expression(pattern);
int index = text.indexOf(expression);
while (index >= 0) {
int length = expression.matchedLength();
setFormat(index, length, myClassFormat);
index = text.indexOf(expression, index + length);
}
}

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 */.

See also
previousBlockState(), setFormat(), setCurrentBlockState()

Implemented in QScriptSyntaxHighlighter.

◆ previousBlockState()

int QSyntaxHighlighter::previousBlockState ( ) const
protected

Returns the end state of the text block previous to the syntax highlighter's current block.

If no value was previously set, the returned value is -1.

See also
highlightBlock(), setCurrentBlockState()

Definition at line 570 of file qsyntaxhighlighter.cpp.

Referenced by QScriptSyntaxHighlighter::highlightBlock().

571 {
572  Q_D(const QSyntaxHighlighter);
573  if (!d->currentBlock.isValid())
574  return -1;
575 
576  const QTextBlock previous = d->currentBlock.previous();
577  if (!previous.isValid())
578  return -1;
579 
580  return previous.userState();
581 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBlock class provides a container for text fragments in a QTextDocument.
Definition: qtextobject.h:199
int userState() const
Returns the integer value previously set with setUserState() or -1.
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...
bool isValid() const
Returns true if this text block is valid; otherwise returns false.
Definition: qtextobject.h:208

◆ rehighlight

void QSyntaxHighlighter::rehighlight ( )
slot

Reapplies the highlighting to the whole document.

Since
4.2
See also
rehighlightBlock()

Definition at line 399 of file qsyntaxhighlighter.cpp.

400 {
402  if (!d->doc)
403  return;
404 
405  QTextCursor cursor(d->doc);
406  d->rehighlight(cursor, QTextCursor::End);
407 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextCursor class offers an API to access and modify QTextDocuments.
Definition: qtextcursor.h:70
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...

◆ rehighlightBlock

void QSyntaxHighlighter::rehighlightBlock ( const QTextBlock block)
slot

Reapplies the highlighting to the given QTextBlock block.

Since
4.6
See also
rehighlight()

Definition at line 419 of file qsyntaxhighlighter.cpp.

420 {
422  if (!d->doc || !block.isValid() || block.document() != d->doc)
423  return;
424 
425  const bool rehighlightPending = d->rehighlightPending;
426 
427  QTextCursor cursor(block);
428  d->rehighlight(cursor, QTextCursor::EndOfBlock);
429 
430  if (rehighlightPending)
431  d->rehighlightPending = rehighlightPending;
432 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextCursor class offers an API to access and modify QTextDocuments.
Definition: qtextcursor.h:70
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...
bool isValid() const
Returns true if this text block is valid; otherwise returns false.
Definition: qtextobject.h:208
const QTextDocument * document() const
Returns the text document this text block belongs to, or 0 if the text block does not belong to any d...

◆ setCurrentBlockState()

void QSyntaxHighlighter::setCurrentBlockState ( int  newState)
protected

Sets the state of the current text block to newState.

See also
highlightBlock()

Definition at line 601 of file qsyntaxhighlighter.cpp.

Referenced by QScriptSyntaxHighlighter::highlightBlock().

602 {
604  if (!d->currentBlock.isValid())
605  return;
606 
607  d->currentBlock.setUserState(newState);
608 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...

◆ setCurrentBlockUserData()

void QSyntaxHighlighter::setCurrentBlockUserData ( QTextBlockUserData data)
protected

Attaches the given data to the current text block.

The ownership is passed to the underlying text document, i.e. the provided QTextBlockUserData object will be deleted if the corresponding text block gets deleted.

QTextBlockUserData can be used to store custom settings. In the case of syntax highlighting, it is in particular interesting as cache storage for information that you may figure out while parsing the paragraph's text.

For example while parsing the text, you can keep track of parenthesis characters that you encounter ('{[(' and the like), and store their relative position and the actual QChar in a simple class derived from QTextBlockUserData:

struct ParenthesisInfo
{
QChar char;
int position;
};
struct BlockData : public QTextBlockUserData
{
};

During cursor navigation in the associated editor, you can ask the current QTextBlock (retrieved using the QTextCursor::block() function) if it has a user data object set and cast it to your BlockData object. Then you can check if the current cursor position matches with a previously recorded parenthesis position, and, depending on the type of parenthesis (opening or closing), find the next opening or closing parenthesis on the same level.

In this way you can do a visual parenthesis matching and highlight from the current cursor position to the matching parenthesis. That makes it easier to spot a missing parenthesis in your code and to find where a corresponding opening/closing parenthesis is when editing parenthesis intensive code.

See also
QTextBlock::setUserData()

Definition at line 644 of file qsyntaxhighlighter.cpp.

645 {
647  if (!d->currentBlock.isValid())
648  return;
649 
650  d->currentBlock.setUserData(data);
651 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...

◆ setDocument()

void QSyntaxHighlighter::setDocument ( QTextDocument doc)

Installs the syntax highlighter on the given QTextDocument doc.

A QSyntaxHighlighter can only be used with one document at a time.

Definition at line 357 of file qsyntaxhighlighter.cpp.

Referenced by QSyntaxHighlighter(), and ~QSyntaxHighlighter().

358 {
360  if (d->doc) {
361  disconnect(d->doc, SIGNAL(contentsChange(int,int,int)),
362  this, SLOT(_q_reformatBlocks(int,int,int)));
363 
364  QTextCursor cursor(d->doc);
365  cursor.beginEditBlock();
366  for (QTextBlock blk = d->doc->begin(); blk.isValid(); blk = blk.next())
367  blk.layout()->clearAdditionalFormats();
368  cursor.endEditBlock();
369  }
370  d->doc = doc;
371  if (d->doc) {
372  connect(d->doc, SIGNAL(contentsChange(int,int,int)),
373  this, SLOT(_q_reformatBlocks(int,int,int)));
374  d->rehighlightPending = true;
375  QTimer::singleShot(0, this, SLOT(_q_delayedRehighlight()));
376  }
377 }
double d
Definition: qnumeric_p.h:62
#define SLOT(a)
Definition: qobjectdefs.h:226
#define Q_D(Class)
Definition: qglobal.h:2482
#define SIGNAL(a)
Definition: qobjectdefs.h:227
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 rece...
Definition: qobject.cpp:2580
The QTextCursor class offers an API to access and modify QTextDocuments.
Definition: qtextcursor.h:70
The QTextBlock class provides a container for text fragments in a QTextDocument.
Definition: qtextobject.h:199
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.
Definition: qobject.cpp:2895
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...
bool singleShot
This static function calls a slot after a given time interval.
Definition: qtimer.h:59

◆ setFormat() [1/3]

void QSyntaxHighlighter::setFormat ( int  start,
int  count,
const QTextCharFormat format 
)
protected

This function is applied to the syntax highlighter's current text block (i.e.

the text that is passed to the highlightBlock() function).

The specified format is applied to the text from the start position for a length of count characters (if count is 0, nothing is done). The formatting properties set in format are merged at display time with the formatting information stored directly in the document, for example as previously set with QTextCursor's functions. Note that the document itself remains unmodified by the format set through this function.

See also
format(), highlightBlock()

Definition at line 493 of file qsyntaxhighlighter.cpp.

Referenced by QScriptSyntaxHighlighter::highlightBlock(), QScriptSyntaxHighlighter::highlightWord(), and setFormat().

494 {
496  if (start < 0 || start >= d->formatChanges.count())
497  return;
498 
499  const int end = qMin(start + count, d->formatChanges.count());
500  for (int i = start; i < end; ++i)
501  d->formatChanges[i] = format;
502 }
double d
Definition: qnumeric_p.h:62
Q_DECL_CONSTEXPR const T & qMin(const T &a, const T &b)
Definition: qglobal.h:1215
#define Q_D(Class)
Definition: qglobal.h:2482
The QSyntaxHighlighter class allows you to define syntax highlighting rules, and in addition you can ...
static const KeyPair *const end

◆ setFormat() [2/3]

void QSyntaxHighlighter::setFormat ( int  start,
int  count,
const QColor color 
)
protected

The specified color is applied to the current text block from the start position for a length of count characters.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

The other attributes of the current text block, e.g. the font and background color, are reset to default values.

See also
format(), highlightBlock()

Definition at line 518 of file qsyntaxhighlighter.cpp.

519 {
521  format.setForeground(color);
522  setFormat(start, count, format);
523 }
The QTextCharFormat class provides formatting information for characters in a QTextDocument.
Definition: qtextformat.h:372
void setFormat(int start, int count, const QTextCharFormat &format)
This function is applied to the syntax highlighter&#39;s current text block (i.e.
void setForeground(const QBrush &brush)
Sets the foreground brush to the specified brush.
Definition: qtextformat.h:350
QTextCharFormat format(int pos) const
Returns the format at position inside the syntax highlighter&#39;s current text block.

◆ setFormat() [3/3]

void QSyntaxHighlighter::setFormat ( int  start,
int  count,
const QFont font 
)
protected

The specified font is applied to the current text block from the start position for a length of count characters.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

The other attributes of the current text block, e.g. the font and background color, are reset to default values.

See also
format(), highlightBlock()

Definition at line 539 of file qsyntaxhighlighter.cpp.

540 {
542  format.setFont(font);
543  setFormat(start, count, format);
544 }
The QTextCharFormat class provides formatting information for characters in a QTextDocument.
Definition: qtextformat.h:372
void setFont(const QFont &font)
Sets the text format&#39;s font.
void setFormat(int start, int count, const QTextCharFormat &format)
This function is applied to the syntax highlighter&#39;s current text block (i.e.
QTextCharFormat format(int pos) const
Returns the format at position inside the syntax highlighter&#39;s current text block.

The documentation for this class was generated from the following files: