QTextBrowser Class
La clase QTextBrowser ofrece un navegador de texto enriquecido con navegación hipertextual. Más información...
| Encabezado: | #include <QTextBrowser> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Widgets) target_link_libraries(mytarget PRIVATE Qt6::Widgets) |
| qmake: | QT += widgets |
| Heredado de: | QTextEdit |
- Lista de todos los miembros, incluidos los heredados
- QTextBrowser forma parte de las API de procesamiento de texto enriquecido.
Propiedades
|
|
Funciones públicas
| QTextBrowser(QWidget *parent = nullptr) | |
| int | backwardHistoryCount() const |
| void | clearHistory() |
| int | forwardHistoryCount() const |
| QString | historyTitle(int i) const |
| QUrl | historyUrl(int i) const |
| bool | isBackwardAvailable() const |
| bool | isForwardAvailable() const |
| bool | openExternalLinks() const |
| bool | openLinks() const |
| QStringList | searchPaths() const |
| void | setOpenExternalLinks(bool open) |
| void | setOpenLinks(bool open) |
| void | setSearchPaths(const QStringList &paths) |
| QUrl | source() const |
| QTextDocument::ResourceType | sourceType() const |
Funciones públicas reimplementadas
| virtual QVariant | loadResource(int type, const QUrl &name) override |
Ranuras públicas
| virtual void | backward() |
| virtual void | forward() |
| virtual void | home() |
| virtual void | reload() |
| void | setSource(const QUrl &url, QTextDocument::ResourceType type = QTextDocument::UnknownResource) |
Señales
| void | anchorClicked(const QUrl &link) |
| void | backwardAvailable(bool available) |
| void | forwardAvailable(bool available) |
| void | highlighted(const QUrl &link) |
| void | historyChanged() |
| void | sourceChanged(const QUrl &src) |
Funciones protegidas
| virtual void | doSetSource(const QUrl &url, QTextDocument::ResourceType type = QTextDocument::UnknownResource) |
Funciones protegidas reimplementadas
| virtual bool | event(QEvent *e) override |
| virtual bool | focusNextPrevChild(bool next) override |
| virtual void | focusOutEvent(QFocusEvent *ev) override |
| virtual void | keyPressEvent(QKeyEvent *ev) override |
| virtual void | mouseMoveEvent(QMouseEvent *e) override |
| virtual void | mousePressEvent(QMouseEvent *e) override |
| virtual void | mouseReleaseEvent(QMouseEvent *e) override |
| virtual void | paintEvent(QPaintEvent *e) override |
Descripción detallada
Esta clase extiende QTextEdit (en modo de solo lectura), añadiendo algunas funciones de navegación para que los usuarios puedan seguir enlaces en documentos de hipertexto.
Si deseas proporcionar a tus usuarios un editor de texto enriquecido editable, utiliza QTextEdit. Si deseas un navegador de texto sin navegación por hipertexto, utiliza QTextEdit, y utiliza QTextEdit::setReadOnly() para desactivar la edición. Si solo necesitas mostrar un pequeño fragmento de texto enriquecido, utiliza QLabel.
Fuente y contenido del documento
El contenido de QTextEdit se establece con setHtml() o setPlainText(), pero QTextBrowser también implementa la función setSource(), lo que permite utilizar un documento con nombre como texto de origen. El nombre se busca en una lista de rutas de búsqueda y en el directorio de la fábrica de documentos actual.
Si el nombre de un documento termina con un ancla (por ejemplo, «#anchor"), el navegador de texto se desplaza automáticamente a esa posición (utilizando scrollToAnchor()). Cuando el usuario hace clic en un hipervínculo, el navegador llama él mismo a setSource() con el valor href del enlace como argumento. Se puede realizar un seguimiento de la fuente actual conectándose a la señal sourceChanged().
Navegación
QTextBrowser proporciona las ranuras backward() y forward(), que puedes utilizar para implementar los botones Atrás y Adelante. La ranura home() establece el texto en el primer documento mostrado. La señal anchorClicked() se emite cuando el usuario hace clic en un enlace. Para anular el comportamiento de navegación predeterminado del navegador, llama a la función setSource() para proporcionar un nuevo texto de documento en una ranura conectada a esta señal.
Si desea cargar documentos almacenados en el sistema de recursos de Qt, utilice qrc como esquema en la URL que se va a cargar. Por ejemplo, para la ruta del recurso de documento :/docs/index.html, utilice qrc:/docs/index.html como URL con setSource().
Véase también QTextEdit y QTextDocument.
Documentación de propiedades
[read-only] modified : bool
Esta propiedad se mantiene independientemente de si se ha modificado el contenido del navegador de texto.
openExternalLinks : bool
Especifica si QTextBrowser debe abrir automáticamente los enlaces a fuentes externas utilizando QDesktopServices::openUrl() en lugar de emitir la señal anchorClicked. Los enlaces se consideran externos si su esquema no es ni «file» ni «qrc».
El valor por defecto es «false».
Funciones de acceso:
| bool | openExternalLinks() const |
| void | setOpenExternalLinks(bool open) |
openLinks : bool
Esta propiedad especifica si QTextBrowser debe abrir automáticamente los enlaces que el usuario intente activar con el ratón o el teclado.
Independientemente del valor de esta propiedad, siempre se emite la señal « anchorClicked ».
El valor por defecto es «true».
Funciones de acceso:
| bool | openLinks() const |
| void | setOpenLinks(bool open) |
readOnly : bool
Esta propiedad indica si el navegador de texto es de solo lectura
Por defecto, esta propiedad tiene el valor « true ».
searchPaths : QStringList
Esta propiedad contiene las rutas de búsqueda que utiliza el navegador de texto para encontrar contenido complementario
QTextBrowser utiliza esta lista para localizar imágenes y documentos.
Por defecto, esta propiedad contiene una lista de cadenas vacía.
Funciones de acceso:
| QStringList | searchPaths() const |
| void | setSearchPaths(const QStringList &paths) |
source : QUrl
Esta propiedad contiene el nombre del documento que se muestra.
Se trata de una URL no válida si no se muestra ningún documento o si se desconoce la fuente.
Al configurar esta propiedad, QTextBrowser intenta buscar un documento con el nombre especificado en las rutas de la propiedad searchPaths y en el directorio de la fuente actual, a menos que el valor sea una ruta de archivo absoluta. También comprueba si hay anclajes opcionales y desplaza el documento en consecuencia
Si la primera etiqueta del documento es <qt type=detail>, el documento se muestra como una ventana emergente en lugar de como un nuevo documento en la propia ventana del navegador. De lo contrario, el documento se muestra normalmente en el navegador de texto con el texto establecido en el contenido del documento nombrado mediante QTextDocument::setHtml() o QTextDocument::setMarkdown(), dependiendo de si el nombre del archivo termina con alguna de las extensiones de archivo Markdown conocidas.
Si deseas evitar la detección automática del tipo y especificarlo explícitamente, llama a ` setSource()` en lugar de establecer esta propiedad.
Por defecto, esta propiedad contiene una URL vacía.
Funciones de acceso:
| QUrl | source() const |
| void | setSource(const QUrl &url, QTextDocument::ResourceType type = QTextDocument::UnknownResource) |
[read-only] sourceType : QTextDocument::ResourceType
Esta propiedad contiene el tipo del documento mostrado
Es de tip QTextDocument::UnknownResource si no se muestra ningún documento o si se desconoce el tipo de la fuente. En caso contrario, contiene el tipo que se ha detectado o el tipo que se especificó al llamar a setSource().
Funciones de acceso:
| QTextDocument::ResourceType | sourceType() const |
undoRedoEnabled : bool
Esta propiedad indica si el navegador de texto admite operaciones de deshacer y rehacer
Por defecto, esta propiedad tiene el valor « false ».
Documentación de las funciones de miembro
[explicit] QTextBrowser::QTextBrowser(QWidget *parent = nullptr)
Crea un objeto QTextBrowser vacío cuyo padre sea parent.
[signal] void QTextBrowser::anchorClicked(const QUrl &link)
Esta señal se emite cuando el usuario hace clic en un enlace. La URL a la que hace referencia el enlace se pasa en ` link`.
Ten en cuenta que el navegador se encargará automáticamente de la navegación a la ubicación especificada por link, a menos que la propiedad openLinks esté establecida en false o que llames a setSource() en un slot conectado. Este mecanismo se utiliza para anular las funciones de navegación predeterminadas del navegador.
[virtual slot] void QTextBrowser::backward()
Cambia el documento mostrado por el documento anterior de la lista de documentos generada al navegar por los enlaces. No realiza ninguna acción si no hay ningún documento anterior.
Véase también forward() y backwardAvailable().
[signal] void QTextBrowser::backwardAvailable(bool available)
Esta señal se emite cuando cambia la disponibilidad de backward(). available es falso cuando el usuario se encuentra en home(); en caso contrario, es verdadero.
int QTextBrowser::backwardHistoryCount() const
Devuelve el número de entradas anteriores en el historial.
void QTextBrowser::clearHistory()
Borra el historial de documentos visitados y desactiva la navegación hacia adelante y hacia atrás.
Véase también backward() y forward().
[virtual protected] void QTextBrowser::doSetSource(const QUrl &url, QTextDocument::ResourceType type = QTextDocument::UnknownResource)
Intenta cargar el documento en la dirección url con el type especificado.
setSource() llama a doSetSource. En Qt 5, setSource(const QUrl &url) era virtual. En Qt 6, doSetSource() es virtual, de modo que puede sobrescribirse en las subclases.
[override virtual protected] bool QTextBrowser::event(QEvent *e)
Reimplementa: QAbstractScrollArea::event(QEvent *event).
[override virtual protected] bool QTextBrowser::focusNextPrevChild(bool next)
Reimplementa: ` QTextEdit::focusNextPrevChild` (bool next).
[override virtual protected] void QTextBrowser::focusOutEvent(QFocusEvent *ev)
Reimplementa: QTextEdit::focusOutEvent(QFocusEvent *e).
[virtual slot] void QTextBrowser::forward()
Cambia el documento mostrado por el siguiente documento de la lista de documentos generada al navegar por los enlaces. No realiza ninguna acción si no hay ningún documento siguiente.
Véase también backward() y forwardAvailable().
[signal] void QTextBrowser::forwardAvailable(bool available)
Esta señal se emite cuando cambia la disponibilidad de forward(). available es «true» después de que el usuario acceda a backward() y «false» cuando el usuario acceda o salga de forward().
int QTextBrowser::forwardHistoryCount() const
Devuelve el número de entradas hacia adelante en el historial.
[signal] void QTextBrowser::highlighted(const QUrl &link)
Esta señal se emite cuando el usuario ha seleccionado un enlace interno del documento, pero aún no lo ha activado. La URL a la que remite el enlace interno se pasa en « link ».
[signal] void QTextBrowser::historyChanged()
Esta señal se emite cuando cambia el historial.
Véase también historyTitle() y historyUrl().
QString QTextBrowser::historyTitle(int i) const
Devuelve el método « documentTitle()» del HistoryItem.
| Entrada | Valor devuelto |
|---|---|
| i < 0 | backward() historial |
| i == 0 | actual, véase QTextBrowser::source() |
| i > 0 | forward() historial |
backaction.setToolTip(browser.historyTitle(-1));
forwardaction.setToolTip(browser.historyTitle(+1));QUrl QTextBrowser::historyUrl(int i) const
Devuelve la URL del HistoryItem.
| Entrada | Valor devuelto |
|---|---|
| i < 0 | backward() historial |
| i == 0 | actual, ver QTextBrowser::source() |
| i > 0 | forward() historial |
[virtual slot] void QTextBrowser::home()
Cambia el documento que se muestra por el primer documento del historial.
bool QTextBrowser::isBackwardAvailable() const
Devuelve ` true ` si el navegador de texto puede retroceder en el historial del documento mediante ` backward()`.
Véase también backwardAvailable() y backward().
bool QTextBrowser::isForwardAvailable() const
Devuelve ` true ` si el navegador de texto puede avanzar en el historial del documento mediante la función ` forward()`.
Véanse también forwardAvailable() y forward().
[override virtual protected] void QTextBrowser::keyPressEvent(QKeyEvent *ev)
Reimplementa: ` QTextEdit::keyPressEvent` (`QKeyEvent *e`).
El evento ` ev ` se utiliza para proporcionar los siguientes atajos de teclado:
| Pulsación de tecla | Acción |
|---|---|
| Alt + Flecha izquierda | backward() |
| Alt + Flecha derecha | forward() |
| Alt + Flecha arriba | home() |
[override virtual] QVariant QTextBrowser::loadResource(int type, const QUrl &name)
Reimplementa: ` QTextEdit::loadResource` (int type, const QUrl &name).
Esta función se invoca cuando se carga el documento y para cada imagen del mismo. El parámetro ` type ` indica el tipo de recurso que se va a cargar. Si no se puede cargar el recurso, se devuelve un ` QVariant ` no válido.
La implementación por defecto ignora ` type ` e intenta localizar los recursos interpretando ` name ` como un nombre de archivo. Si no se trata de una ruta absoluta, intenta encontrar el archivo en las rutas de la propiedad ` searchPaths ` y en el mismo directorio que la fuente actual. Si la búsqueda tiene éxito, el resultado es un ` QVariant ` que almacena un ` QByteArray ` con el contenido del archivo.
Si reimplementas esta función, puedes devolver otros tipos de « QVariant ». La tabla siguiente muestra qué tipos de variantes son compatibles en función del tipo de recurso:
[override virtual protected] void QTextBrowser::mouseMoveEvent(QMouseEvent *e)
Reimplementa: QTextEdit::mouseMoveEvent(QMouseEvent *e).
[override virtual protected] void QTextBrowser::mousePressEvent(QMouseEvent *e)
Reimplementa: QTextEdit::mousePressEvent(QMouseEvent *e).
[override virtual protected] void QTextBrowser::mouseReleaseEvent(QMouseEvent *e)
Reimplementa: QTextEdit::mouseReleaseEvent(QMouseEvent *e).
[override virtual protected] void QTextBrowser::paintEvent(QPaintEvent *e)
Reimplementa: ` QTextEdit::paintEvent` (`QPaintEvent *event)`.
[virtual slot] void QTextBrowser::reload()
Vuelve a cargar la fuente seleccionada actualmente.
[slot] void QTextBrowser::setSource(const QUrl &url, QTextDocument::ResourceType type = QTextDocument::UnknownResource)
Intenta cargar el documento en la dirección url con el tipo de documento especificado type.
Si type es UnknownResource (el valor por defecto), se detectará el tipo de documento: es decir, si la URL termina con una extensión de tipo .md, .mkd o .markdown, el documento se cargará mediante QTextDocument::setMarkdown(); en caso contrario, se cargará mediante QTextDocument::setHtml(). Esta detección puede omitirse especificando explícitamente la type.
Nota: Funciónde asignación para la propiedad source.
Véase también source().
[signal] void QTextBrowser::sourceChanged(const QUrl &src)
Esta señal se emite cuando la fuente ha cambiado, siendo src la nueva fuente.
Los cambios de fuente se producen tanto mediante código al llamar a setSource(), forward(), backward() o home(), como cuando el usuario hace clic en enlaces o pulsa las secuencias de teclas equivalentes.
© 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.