Struct qt_qml::QQmlDebuggingEnabler

#[repr(C)]pub struct QQmlDebuggingEnabler { /* fields omitted */ }

C++ class: QQmlDebuggingEnabler.

Methods

impl QQmlDebuggingEnabler

pub unsafe fn connect_to_local_debugger_2a(
    socket_file_name: impl CastInto<Ref<QString>>,
    mode: StartMode
) -> bool

Enables debugging for QML engines created after calling this function. The debug connector will connect to a debugger waiting on a local socket at the given socketFileName and block the QML engine until the connection is established if mode is WaitForClient. If mode is not specified it will not block. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

Calls C++ function: static bool QQmlDebuggingEnabler::connectToLocalDebugger(const QString& socketFileName, QQmlDebuggingEnabler::StartMode mode = …).

C++ documentation:

Enables debugging for QML engines created after calling this function. The debug connector will connect to a debugger waiting on a local socket at the given socketFileName and block the QML engine until the connection is established if mode is WaitForClient. If mode is not specified it will not block. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

This function was introduced in Qt 5.6.

pub unsafe fn connect_to_local_debugger_1a(
    socket_file_name: impl CastInto<Ref<QString>>
) -> bool

Enables debugging for QML engines created after calling this function. The debug connector will connect to a debugger waiting on a local socket at the given socketFileName and block the QML engine until the connection is established if mode is WaitForClient. If mode is not specified it will not block. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

Calls C++ function: static bool QQmlDebuggingEnabler::connectToLocalDebugger(const QString& socketFileName).

C++ documentation:

Enables debugging for QML engines created after calling this function. The debug connector will connect to a debugger waiting on a local socket at the given socketFileName and block the QML engine until the connection is established if mode is WaitForClient. If mode is not specified it will not block. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

This function was introduced in Qt 5.6.

pub unsafe fn copy_from(
    &self,
    other: impl CastInto<Ref<QQmlDebuggingEnabler>>
) -> Ref<QQmlDebuggingEnabler>

Calls C++ function: QQmlDebuggingEnabler& QQmlDebuggingEnabler::operator=(const QQmlDebuggingEnabler& other).

pub unsafe fn debugger_services() -> CppBox<QStringList>

Retrieves the plugin keys of the debugger services provided by default. The debugger services enable a debug client to use a Qml/JavaScript debugger, in order to set breakpoints, pause execution, evaluate expressions and similar debugging tasks. Returns List of plugin keys of default debugger services.

Calls C++ function: static QStringList QQmlDebuggingEnabler::debuggerServices().

C++ documentation:

Retrieves the plugin keys of the debugger services provided by default. The debugger services enable a debug client to use a Qml/JavaScript debugger, in order to set breakpoints, pause execution, evaluate expressions and similar debugging tasks. Returns List of plugin keys of default debugger services.

pub unsafe fn inspector_services() -> CppBox<QStringList>

Retrieves the plugin keys of the inspector services provided by default. The inspector services enable a debug client to use a visual inspector tool for Qt Quick. Returns List of plugin keys of default inspector services.

Calls C++ function: static QStringList QQmlDebuggingEnabler::inspectorServices().

C++ documentation:

Retrieves the plugin keys of the inspector services provided by default. The inspector services enable a debug client to use a visual inspector tool for Qt Quick. Returns List of plugin keys of default inspector services.

pub unsafe fn native_debugger_services() -> CppBox<QStringList>

Retrieves the plugin keys of the debug services designed to be used with a native debugger. The native debugger will communicate with these services by directly reading and writing the application's memory. Returns List of plugin keys of debug services designed to be used with a native debugger.

Calls C++ function: static QStringList QQmlDebuggingEnabler::nativeDebuggerServices().

C++ documentation:

Retrieves the plugin keys of the debug services designed to be used with a native debugger. The native debugger will communicate with these services by directly reading and writing the application's memory. Returns List of plugin keys of debug services designed to be used with a native debugger.

pub unsafe fn new_1a(print_warning: bool) -> CppBox<QQmlDebuggingEnabler>

Calls C++ function: [constructor] void QQmlDebuggingEnabler::QQmlDebuggingEnabler(bool printWarning = …).

pub unsafe fn new_0a() -> CppBox<QQmlDebuggingEnabler>

Calls C++ function: [constructor] void QQmlDebuggingEnabler::QQmlDebuggingEnabler().

pub unsafe fn new_copy(
    other: impl CastInto<Ref<QQmlDebuggingEnabler>>
) -> CppBox<QQmlDebuggingEnabler>

Calls C++ function: [constructor] void QQmlDebuggingEnabler::QQmlDebuggingEnabler(const QQmlDebuggingEnabler& other).

pub unsafe fn profiler_services() -> CppBox<QStringList>

Retrieves the names of the profiler services provided by default. The profiler services enable a debug client to use a profiler and track the time taken by various QML and JavaScript constructs, as well as the QtQuick SceneGraph. Returns List of plugin keys of default profiler services.

Calls C++ function: static QStringList QQmlDebuggingEnabler::profilerServices().

C++ documentation:

Retrieves the names of the profiler services provided by default. The profiler services enable a debug client to use a profiler and track the time taken by various QML and JavaScript constructs, as well as the QtQuick SceneGraph. Returns List of plugin keys of default profiler services.

pub unsafe fn set_services(services: impl CastInto<Ref<QStringList>>)

Restricts the services available from the debug connector. The connector will scan plugins in the "qmltooling" subdirectory of the default plugin path. If this function is not called before the debug connector is enabled, all services found that way will be available to any client. If this function is called, only the services with plugin keys given in services will be available.

Calls C++ function: static void QQmlDebuggingEnabler::setServices(const QStringList& services).

C++ documentation:

Restricts the services available from the debug connector. The connector will scan plugins in the "qmltooling" subdirectory of the default plugin path. If this function is not called before the debug connector is enabled, all services found that way will be available to any client. If this function is called, only the services with plugin keys given in services will be available.

Use this method to disable debugger and inspector services when profiling to get better performance and more realistic profiles. The debugger service will put any JavaScript engine it connects to into interpreted mode, disabling the JIT compiler.

See also debuggerServices(), profilerServices(), and inspectorServices().

pub unsafe fn start_debug_connector_2a(
    plugin_name: impl CastInto<Ref<QString>>,
    configuration: impl CastInto<Ref<QHashOfQStringQVariant>>
) -> bool

Enables debugging for QML engines created after calling this function. A debug connector plugin specified by pluginName will be loaded and started using the given configuration. Supported configuration entries and their semantics depend on the plugin being loaded. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

Calls C++ function: static bool QQmlDebuggingEnabler::startDebugConnector(const QString& pluginName, const QHash<QString, QVariant>& configuration = …).

C++ documentation:

Enables debugging for QML engines created after calling this function. A debug connector plugin specified by pluginName will be loaded and started using the given configuration. Supported configuration entries and their semantics depend on the plugin being loaded. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

This function was introduced in Qt 5.7.

pub unsafe fn start_debug_connector_1a(
    plugin_name: impl CastInto<Ref<QString>>
) -> bool

Enables debugging for QML engines created after calling this function. A debug connector plugin specified by pluginName will be loaded and started using the given configuration. Supported configuration entries and their semantics depend on the plugin being loaded. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

Calls C++ function: static bool QQmlDebuggingEnabler::startDebugConnector(const QString& pluginName).

C++ documentation:

Enables debugging for QML engines created after calling this function. A debug connector plugin specified by pluginName will be loaded and started using the given configuration. Supported configuration entries and their semantics depend on the plugin being loaded. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

This function was introduced in Qt 5.7.

pub unsafe fn start_tcp_debug_server_3a(
    port: c_int,
    mode: StartMode,
    host_name: impl CastInto<Ref<QString>>
) -> bool

Enables debugging for QML engines created after calling this function. The debug connector will listen on port at hostName and block the QML engine until it receives a connection if mode is WaitForClient. If mode is not specified it won't block and if hostName is not specified it will listen on all available interfaces. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

Calls C++ function: static bool QQmlDebuggingEnabler::startTcpDebugServer(int port, QQmlDebuggingEnabler::StartMode mode = …, const QString& hostName = …).

C++ documentation:

Enables debugging for QML engines created after calling this function. The debug connector will listen on port at hostName and block the QML engine until it receives a connection if mode is WaitForClient. If mode is not specified it won't block and if hostName is not specified it will listen on all available interfaces. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

pub unsafe fn start_tcp_debug_server_2a(port: c_int, mode: StartMode) -> bool

Enables debugging for QML engines created after calling this function. The debug connector will listen on port at hostName and block the QML engine until it receives a connection if mode is WaitForClient. If mode is not specified it won't block and if hostName is not specified it will listen on all available interfaces. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

Calls C++ function: static bool QQmlDebuggingEnabler::startTcpDebugServer(int port, QQmlDebuggingEnabler::StartMode mode = …).

C++ documentation:

Enables debugging for QML engines created after calling this function. The debug connector will listen on port at hostName and block the QML engine until it receives a connection if mode is WaitForClient. If mode is not specified it won't block and if hostName is not specified it will listen on all available interfaces. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

pub unsafe fn start_tcp_debug_server_1a(port: c_int) -> bool

Enables debugging for QML engines created after calling this function. The debug connector will listen on port at hostName and block the QML engine until it receives a connection if mode is WaitForClient. If mode is not specified it won't block and if hostName is not specified it will listen on all available interfaces. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

Calls C++ function: static bool QQmlDebuggingEnabler::startTcpDebugServer(int port).

C++ documentation:

Enables debugging for QML engines created after calling this function. The debug connector will listen on port at hostName and block the QML engine until it receives a connection if mode is WaitForClient. If mode is not specified it won't block and if hostName is not specified it will listen on all available interfaces. You can only start one debug connector at a time. A debug connector may have already been started if the -qmljsdebugger= command line argument was given. This method returns true if a new debug connector was successfully started, or false otherwise.

Trait Implementations

impl CppDeletable for QQmlDebuggingEnabler

unsafe fn delete(&self)

Calls C++ function: [destructor] void QQmlDebuggingEnabler::~QQmlDebuggingEnabler().