QQmlDebuggingEnabler Struct
La clase QQmlDebuggingEnabler proporciona métodos para habilitar la depuración o la creación de perfiles. Más información...
| Encabezado: | #include <QQmlDebuggingEnabler> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Qml) target_link_libraries(mytarget PRIVATE Qt6::Qml) |
| qmake: | QT += qml |
Tipos públicos
| enum | StartMode { DoNotWaitForClient, WaitForClient } |
Miembros públicos estáticos
| bool | connectToLocalDebugger(const QString &socketFileName, QQmlDebuggingEnabler::StartMode mode = DoNotWaitForClient) |
| QStringList | debuggerServices() |
| void | enableDebugging(bool printWarning) |
| QStringList | inspectorServices() |
| QStringList | nativeDebuggerServices() |
| QStringList | profilerServices() |
| void | setServices(const QStringList &services) |
| bool | startDebugConnector(const QString &pluginName, const QVariantHash &configuration = QVariantHash()) |
| bool | startTcpDebugServer(int port, QQmlDebuggingEnabler::StartMode mode = DoNotWaitForClient, const QString &hostName = QString()) |
Descripción detallada
Normalmente, la depuración y el perfilado de QML se activan pasando ` QT_ENABLE_QML_DEBUG ` a través de CMake o ` CONFIG+=qml_debug ` a través de qmake al compilar la aplicación. En tiempo de ejecución, la aplicación suele analizar cualquier argumento de la línea de comandos ` -qmljsdebugger ` para iniciar realmente la depuración o el perfilado.
En su lugar, puedes gestionar estas tareas manualmente utilizando los métodos de esta clase.
Documentación de los tipos de miembros
enum QQmlDebuggingEnabler::StartMode
Define el comportamiento de inicio del conector de depuración. Puedes interrumpir el inicio de los motores QML mientras un cliente de depuración se está conectando, con el fin de establecer puntos de interrupción o perfilar el código de inicio.
| Constante | Valor | Descripción |
|---|---|---|
QQmlDebuggingEnabler::DoNotWaitForClient | 0 | Ejecuta cualquier motor QML como de costumbre mientras los servicios de depuración se están conectando. |
QQmlDebuggingEnabler::WaitForClient | 1 | Si se inicia un motor QML mientras los servicios de depuración se están conectando, interrumpirlo hasta que hayan terminado. |
Documentación de la función miembro
[static] bool QQmlDebuggingEnabler::connectToLocalDebugger(const QString &socketFileName, QQmlDebuggingEnabler::StartMode mode = DoNotWaitForClient)
Habilita la depuración para los motores QML creados tras llamar a esta función. El conector de depuración se conectará a un depurador que esté a la espera en un socket local en la dirección socketFileName y bloqueará el motor QML hasta que se establezca la conexión, siempre que mode sea WaitForClient. Si no se especifica mode, no se producirá ningún bloqueo. Solo se puede iniciar un conector de depuración a la vez. Es posible que ya se haya iniciado un conector de depuración si se ha especificado el argumento de línea de comandos -qmljsdebugger=. Este método devuelve true si se ha iniciado correctamente un nuevo conector de depuración, o false en caso contrario.
[static] QStringList QQmlDebuggingEnabler::debuggerServices()
Recupera las claves de los complementos de los servicios de depuración proporcionados por defecto. Los servicios de depuración permiten a un cliente de depuración utilizar un depurador de Qml/JavaScript para establecer puntos de interrupción, pausar la ejecución, evaluar expresiones y realizar otras tareas de depuración similares. Devuelve una lista con las claves de los complementos de los servicios de depuración predeterminados.
[static] void QQmlDebuggingEnabler::enableDebugging(bool printWarning)
Habilitar la depuración o la creación de perfiles. Si printWarning es true, mostrar la siguiente advertencia en stderr:
QML debugging is enabled. Only use this in a safe environment.Este método se invoca automáticamente al inicio si se pasa QT_ENABLE_QML_DEBUG o CONFIG+=qml_debug en el momento de la compilación.
Este método debe invocarse de una forma u otra antes de iniciar cualquier tipo de conector de depuración. De lo contrario, el conector se negará a iniciarse.
Véanse también startTcpDebugServer(), connectToLocalDebugger() y startDebugConnector().
[static] QStringList QQmlDebuggingEnabler::inspectorServices()
Recupera las claves de los complementos de los servicios de inspección proporcionados por defecto. Los servicios de inspección permiten a un cliente de depuración utilizar una herramienta de inspección visual para Qt Quick. Devuelve una lista de las claves de los complementos de los servicios de inspección por defecto.
[static] QStringList QQmlDebuggingEnabler::nativeDebuggerServices()
Recupera las claves de los complementos de los servicios de depuración diseñados para utilizarse con un depurador nativo. El depurador nativo se comunicará con estos servicios leyendo y escribiendo directamente en la memoria de la aplicación. Devuelve una lista de las claves de los complementos de los servicios de depuración diseñados para utilizarse con un depurador nativo.
[static] QStringList QQmlDebuggingEnabler::profilerServices()
Recupera los nombres de los servicios de perfilado que se proporcionan de forma predeterminada. Los servicios de perfilado permiten a un cliente de depuración utilizar un perfilador y realizar un seguimiento del tiempo que tardan diversas construcciones de QML y JavaScript, así como del SceneGraph de QtQuick. Devuelve una lista de claves de complementos de los servicios de perfilado predeterminados.
[static] void QQmlDebuggingEnabler::setServices(const QStringList &services)
Limita los servicios disponibles desde el conector de depuración. El conector buscará los complementos en el subdirectorio «qmltooling» de la ruta predeterminada de complementos. Si no se invoca esta función antes de habilitar el conector de depuración, todos los servicios encontrados de esta forma estarán disponibles para cualquier cliente. Si se invoca esta función, solo estarán disponibles los servicios con las claves de complemento especificadas en services.
Utiliza este método para desactivar los servicios del depurador y del inspector al realizar perfiles, con el fin de obtener un mejor rendimiento y perfiles más realistas. El servicio del depurador pondrá cualquier motor de JavaScript al que se conecte en modo interpretado, desactivando el compilador JIT.
Véase también debuggerServices(), profilerServices() y inspectorServices().
[static] bool QQmlDebuggingEnabler::startDebugConnector(const QString &pluginName, const QVariantHash &configuration = QVariantHash())
Habilita la depuración para los motores QML creados tras llamar a esta función. Se cargará y se iniciará un complemento de conector de depuración especificado mediante ` pluginName `, utilizando el ` configuration` indicado. Las entradas de configuración admitidas y su significado dependen del complemento que se esté cargando. Solo se puede iniciar un conector de depuración a la vez. Es posible que ya se haya iniciado un conector de depuración si se ha especificado el argumento de línea de comandos -qmljsdebugger=. Este método devuelve true si se ha iniciado correctamente un nuevo conector de depuración, o false en caso contrario.
[static] bool QQmlDebuggingEnabler::startTcpDebugServer(int port, QQmlDebuggingEnabler::StartMode mode = DoNotWaitForClient, const QString &hostName = QString())
Habilita la depuración para los motores QML creados tras llamar a esta función. El conector de depuración escuchará en port en hostName y bloqueará el motor QML hasta que reciba una conexión si mode es WaitForClient. Si no se especifica mode, no se bloqueará, y si no se especifica hostName, escuchará en todas las interfaces disponibles. Solo se puede iniciar un conector de depuración a la vez. Es posible que ya se haya iniciado un conector de depuración si se ha proporcionado el argumento de línea de comandos -qmljsdebugger=. Este método devuelve true si se ha iniciado correctamente un nuevo conector de depuración, o false en caso contrario.
© 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.