QSyntaxHighlighter Class
La clase QSyntaxHighlighter te permite definir reglas de resaltado de sintaxis y, además, puedes utilizarla para consultar el formato actual de un documento o los datos del usuario. Más información...
| Encabezado: | #include <QSyntaxHighlighter> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Heredado de: | QObject |
- Lista de todos los miembros, incluidos los heredados
- QSyntaxHighlighter forma parte de las API de procesamiento de texto enriquecido.
Nota: Todas las funciones de esta clase son reentrantes.
Funciones públicas
| QSyntaxHighlighter(QObject *parent) | |
| QSyntaxHighlighter(QTextDocument *parent) | |
| virtual | ~QSyntaxHighlighter() |
| QTextDocument * | document() const |
| void | setDocument(QTextDocument *doc) |
Ranuras públicas
| void | rehighlight() |
| void | rehighlightBlock(const QTextBlock &block) |
Funciones protegidas
| QTextBlock | currentBlock() const |
| int | currentBlockState() const |
| QTextBlockUserData * | currentBlockUserData() const |
| QTextCharFormat | format(int position) const |
| virtual void | highlightBlock(const QString &text) = 0 |
| int | previousBlockState() const |
| void | setCurrentBlockState(int newState) |
| void | setCurrentBlockUserData(QTextBlockUserData *data) |
| void | setFormat(int start, int count, const QTextCharFormat &format) |
| void | setFormat(int start, int count, const QColor &color) |
| void | setFormat(int start, int count, const QFont &font) |
Descripción detallada
La clase QSyntaxHighlighter es una clase base para implementar resaltadores de sintaxis de tipo « QTextDocument ». Un resaltador de sintaxis resalta automáticamente partes del texto en un QTextDocument. Los resaltadores de sintaxis se utilizan a menudo cuando el usuario introduce texto en un formato específico (por ejemplo, código fuente) y ayudan al usuario a leer el texto e identificar errores de sintaxis.
Para proporcionar tu propio resaltado de sintaxis, debes crear una subclase de QSyntaxHighlighter y reimplementar el método highlightBlock().
Al crear una instancia de tu subclase de QSyntaxHighlighter, pásale el objeto ` QTextDocument ` al que deseas aplicar el resaltado de sintaxis. Por ejemplo:
QTextEdit *editor = new QTextEdit;
MyHighlighter *highlighter = new MyHighlighter(editor->document());A partir de ese momento, tu función ` highlightBlock()` se llamará automáticamente siempre que sea necesario. Utiliza tu función ` highlightBlock()` para aplicar el formato (por ejemplo, establecer la fuente y el color) al texto que se le pase. QSyntaxHighlighter proporciona la función ` setFormat()`, que aplica una regla de formato determinada (` QTextCharFormat `) al bloque de texto actual. Por ejemplo:
void MyHighlighter::highlightBlock(const QString &text)
{
QTextCharFormat myClassFormat;
myClassFormat.setFontWeight(QFont::Bold);
myClassFormat.setForeground(Qt::darkMagenta);
QRegularExpression expression("\\bMy[A-Za-z]+\\b");
QRegularExpressionMatchIterator i = expression.globalMatch(text);
while (i.hasNext()) {
QRegularExpressionMatch match = i.next();
setFormat(match.capturedStart(), match.capturedLength(), myClassFormat);
}
}Algunas sintaxis pueden tener construcciones que abarquen varios bloques de texto. Por ejemplo, un resaltador de sintaxis de C++ debería ser capaz de gestionar /*...* / comentarios multilínea. Para hacer frente a estos casos, es necesario conocer el estado final del bloque de texto anterior (por ejemplo, «en comentario»).
Dentro de tu implementación de highlightBlock(), puedes consultar el estado final del bloque de texto anterior utilizando la función previousBlockState(). Tras analizar el bloque, puedes guardar el último estado utilizando setCurrentBlockState().
Las funciones ` currentBlockState()` y ` previousBlockState()` devuelven un valor de tipo `int`. Si no se ha establecido ningún estado, el valor devuelto es -1. Puedes asignar cualquier otro valor para identificar un estado determinado mediante la función ` setCurrentBlockState()`. Una vez establecido el estado, el ` QTextBlock ` mantiene ese valor hasta que se vuelva a establecer o hasta que se elimine el párrafo de texto correspondiente.
Por ejemplo, si estás escribiendo un sencillo resaltador de sintaxis de C++, podrías asignar el valor 1 para indicar «en comentario»:
QTextCharFormat multiLineCommentFormat;
multiLineCommentFormat.setForeground(Qt::red);
QRegularExpression startExpression("/\\*");
QRegularExpression endExpression("\\*/");
setCurrentBlockState(0);
int startIndex = 0;
if (previousBlockState() != 1)
startIndex = text.indexOf(startExpression);
while (startIndex >= 0) {
QRegularExpressionMatch endMatch;
int endIndex = text.indexOf(endExpression, startIndex, &endMatch);
int commentLength;
if (endIndex == -1) {
setCurrentBlockState(1);
commentLength = text.length() - startIndex;
} else {
commentLength = endIndex - startIndex
+ endMatch.capturedLength();
}
setFormat(startIndex, commentLength, multiLineCommentFormat);
startIndex = text.indexOf(startExpression,
startIndex + commentLength);
}En el ejemplo anterior, primero establecemos el estado del bloque actual en 0. A continuación, si el bloque anterior terminaba dentro de un comentario, resaltamos desde el principio del bloque actual (startIndex = 0). De lo contrario, buscamos la expresión de inicio dada. Si la expresión de fin especificada no se encuentra en el bloque de texto, cambiamos el estado del bloque actual llamando a ` setCurrentBlockState()` y nos aseguramos de que el resto del bloque quede resaltado.
Además, puedes consultar el formato actual y los datos de usuario utilizando las funciones format() y currentBlockUserData(), respectivamente. También puede adjuntar datos de usuario al bloque de texto actual mediante la función setCurrentBlockUserData(). QTextBlockUserData puede utilizarse para almacenar configuraciones personalizadas. En el caso del resaltado de sintaxis, resulta especialmente interesante como almacenamiento en caché de la información que se pueda obtener al analizar el texto del párrafo. Para ver un ejemplo, consulte la documentación de setCurrentBlockUserData().
Véase también QTextDocument y el ejemplo de resaltador de sintaxis.
Documentación de funciones de miembro
[explicit] QSyntaxHighlighter::QSyntaxHighlighter(QObject *parent)
Crea un objeto QSyntaxHighlighter con el parent especificado.
Si el documento padre es un ` QTextEdit`, instala el resaltador de sintaxis en el documento padre. El ` QTextEdit ` especificado también se convierte en el propietario del `QSyntaxHighlighter`.
[explicit] QSyntaxHighlighter::QSyntaxHighlighter(QTextDocument *parent)
Crea un objeto `QSyntaxHighlighter` y lo instala en ` parent`. El objeto ` QTextDocument ` especificado pasa a ser también el propietario del `QSyntaxHighlighter`.
[virtual noexcept] QSyntaxHighlighter::~QSyntaxHighlighter()
Destructor. Desinstala este resaltador de sintaxis del documento de texto.
[protected] QTextBlock QSyntaxHighlighter::currentBlock() const
Devuelve el bloque de texto actual.
[protected] int QSyntaxHighlighter::currentBlockState() const
Devuelve el estado del bloque de texto actual. Si no se ha establecido ningún valor, el valor devuelto es -1.
Véase también setCurrentBlockState().
[protected] QTextBlockUserData *QSyntaxHighlighter::currentBlockUserData() const
Devuelve el objeto ` QTextBlockUserData ` asociado previamente al bloque de texto actual.
Véase también QTextBlock::userData() y setCurrentBlockUserData().
QTextDocument *QSyntaxHighlighter::document() const
Devuelve el archivo « QTextDocument » en el que está instalado este resaltador de sintaxis.
Véase también setDocument().
[protected] QTextCharFormat QSyntaxHighlighter::format(int position) const
Devuelve el formato que aparece en position dentro del bloque de texto actual del resaltador de sintaxis.
Véase también setFormat().
[pure virtual protected] void QSyntaxHighlighter::highlightBlock(const QString &text)
Resalta el bloque de texto indicado. El motor de texto enriquecido invoca esta función cuando es necesario, es decir, en los bloques de texto que han sufrido cambios.
Para implementar tu propio resaltado de sintaxis, debes crear una subclase de ` QSyntaxHighlighter ` y reimplementar el método `highlightBlock()`. En tu reimplementación, debes analizar el ` text ` del bloque y llamar a ` setFormat()` tantas veces como sea necesario para aplicar los cambios de fuente y color que necesites. Por ejemplo:
void MyHighlighter::highlightBlock(const QString &text)
{
QTextCharFormat myClassFormat;
myClassFormat.setFontWeight(QFont::Bold);
myClassFormat.setForeground(Qt::darkMagenta);
QRegularExpression expression("\\bMy[A-Za-z]+\\b");
QRegularExpressionMatchIterator i = expression.globalMatch(text);
while (i.hasNext()) {
QRegularExpressionMatch match = i.next();
setFormat(match.capturedStart(), match.capturedLength(), myClassFormat);
}
}Consulte la clase ` Detailed Description ` para ver ejemplos del uso de ` setCurrentBlockState()`, ` currentBlockState()` y ` previousBlockState()` para gestionar sintaxis con construcciones que abarcan varios bloques de texto
Véanse también previousBlockState(), setFormat() y setCurrentBlockState().
[protected] int QSyntaxHighlighter::previousBlockState() const
Devuelve el estado final del bloque de texto anterior al bloque actual del resaltador de sintaxis. Si no se había establecido ningún valor anteriormente, el valor devuelto es -1.
Véase también highlightBlock() y setCurrentBlockState().
[slot] void QSyntaxHighlighter::rehighlight()
Vuelve a aplicar el resaltado a todo el documento.
Véase también rehighlightBlock().
[slot] void QSyntaxHighlighter::rehighlightBlock(const QTextBlock &block)
Vuelve a aplicar el resaltado a la página QTextBlock block .
Véase también rehighlight().
[protected] void QSyntaxHighlighter::setCurrentBlockState(int newState)
Establece el estado del bloque de texto actual en « newState ».
Véase también currentBlockState() y highlightBlock().
[protected] void QSyntaxHighlighter::setCurrentBlockUserData(QTextBlockUserData *data)
Asigna el objeto ` data ` indicado al bloque de texto actual. La propiedad se transfiere al documento de texto subyacente; es decir, el objeto ` QTextBlockUserData ` proporcionado se eliminará si se elimina el bloque de texto correspondiente.
QTextBlockUserData Se puede utilizar para almacenar configuraciones personalizadas. En el caso del resaltado de sintaxis, resulta especialmente interesante como almacenamiento en caché de información que puedas obtener al analizar el texto del párrafo.
Por ejemplo, al analizar el texto, puedes llevar un registro de los caracteres de paréntesis que encuentres («{[(» y similares), y almacenar su posición relativa y el QChar real en una clase sencilla derivada de QTextBlockUserData:
struct ParenthesisInfo
{
QChar character;
int position;
};
struct BlockData : public QTextBlockUserData
{
QList<ParenthesisInfo> parentheses;
};Durante la navegación del cursor en el editor asociado, puedes consultar si el « QTextBlock » actual (obtenido mediante la función ` QTextCursor::block()`) tiene un objeto de datos de usuario definido y convertirlo a tu objeto ` BlockData `. A continuación, puede comprobar si la posición actual del cursor coincide con una posición de paréntesis registrada previamente y, dependiendo del tipo de paréntesis (de apertura o de cierre), encontrar el siguiente paréntesis de apertura o de cierre en el mismo nivel.
De esta forma, puedes realizar una coincidencia visual de paréntesis y resaltar desde la posición actual del cursor hasta el paréntesis coincidente. Esto facilita la detección de un paréntesis que falta en tu código y la localización del paréntesis de apertura o cierre correspondiente al editar código con un uso intensivo de paréntesis.
Véase también currentBlockUserData() y QTextBlock::setUserData().
void QSyntaxHighlighter::setDocument(QTextDocument *doc)
Instala el resaltador de sintaxis en el archivo especificado QTextDocument doc . Un QSyntaxHighlighter solo se puede utilizar con un documento a la vez.
Véase también document().
[protected] void QSyntaxHighlighter::setFormat(int start, int count, const QTextCharFormat &format)
Esta función se aplica al bloque de texto actual del resaltador de sintaxis (es decir, el texto que se pasa a la función highlightBlock()).
El ` format ` especificado se aplica al texto a partir de la posición ` start ` durante una longitud de ` count ` caracteres (si ` count ` es 0, no se realiza ninguna acción). Las propiedades de formato establecidas en ` format ` se fusionan en el momento de la visualización con la información de formato almacenada directamente en el documento, por ejemplo, tal y como se ha establecido previamente con las funciones de ` QTextCursor`. Ten en cuenta que el documento en sí no se ve modificado por el formato establecido a través de esta función.
Véase también format() y highlightBlock().
[protected] void QSyntaxHighlighter::setFormat(int start, int count, const QColor &color)
El estilo « color » especificado se aplica al bloque de texto actual a partir de la posición « start » en una longitud de « count » caracteres.
Los demás atributos del bloque de texto actual, como el tipo de letra y el color de fondo, se restablecen a sus valores por defecto.
Esta es una función sobrecargada.
Véanse también format() y highlightBlock().
[protected] void QSyntaxHighlighter::setFormat(int start, int count, const QFont &font)
El estilo « font » especificado se aplica al bloque de texto actual a partir de la posición « start » y con una longitud de « count » caracteres.
Los demás atributos del bloque de texto actual, como el tipo de letra y el color de fondo, se restablecen a sus valores predeterminados.
Esta es una función sobrecargada.
Véase también format() y highlightBlock().
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.