WebEngineView QML Type

Una WebEngineView renderiza contenido web dentro de una aplicación QML. Más...

• Lista de todos los miembros, incluidos los heredados
• Miembros obsoletos

Propiedades

• ErrorDomain : enumeration
• FindFlags : enumeration
• JavaScriptConsoleMessageLevel : enumeration
• LifecycleState : enumeration (since QtWebEngine 1.10)
• LoadStatus : enumeration
• PrintedPageOrientation : enumeration (since QtWebEngine 1.3)
• PrintedPageSizeId : enumeration (since QtWebEngine 1.3)
• RenderProcessTerminationStatus : enumeration (since QtWebEngine 1.2)
• WebAction : enumeration (since QtWebEngine 1.2)
• activeFocusOnPress : bool (since QtWebEngine 1.2)
• audioMuted : bool (since QtWebEngine 1.3)
• backgroundColor : color (since QtWebEngine 1.2)
• canGoBack : bool
• canGoForward : bool
• contentsSize : size (since QtWebEngine 1.3)
• devToolsId : WebEngineView (since QtWebEngine 6.6)
• devToolsView : WebEngineView (since QtWebEngine 1.7)
• history : WebEngineHistory (since QtWebEngine 1.1)
• icon : url
• inspectedView : WebEngineView (since QtWebEngine 1.7)
• isFullScreen : bool (since QtWebEngine 1.1)
• lifecycleState : LifecycleState (since QtWebEngine 1.10)
• loadProgress : int
• loading : bool
• mainFrame : webEngineFrame (since QtWebEngine 6.8)
• profile : WebEngineProfile (since QtWebEngine 1.1)
• recentlyAudible : bool (since QtWebEngine 1.3)
• recommendedState : LifecycleState (since QtWebEngine 1.10)
• renderProcessPid : qint64 (since QtWebEngine 1.11)
• scrollPosition : point (since QtWebEngine 1.3)
• settings : WebEngineSettings (since QtWebEngine 1.1)
• title : string
• touchHandleDelegate : Component (since QtWebEngine 6.4)
• url : url
• userScripts : WebEngineScriptCollection (since QtWebEngine 1.1)
• webChannel : QQmlWebChannel (since QtWebEngine 1.1)
• webChannelWorld : int (since QtWebEngine 1.3)
• zoomFactor : real (since QtWebEngine 1.1)

Señales

• activeFocusOnPressChanged(bool activeFocusOnPress) (since QtWebEngine 1.2)
• audioMutedChanged(bool muted) (since QtWebEngine 1.3)
• authenticationDialogRequested(AuthenticationDialogRequest request) (since QtWebEngine 1.4)
• backgroundColorChanged() (since QtWebEngine 1.2)
• certificateError(WebEngineCertificateError error) (since QtWebEngine 1.1)
• colorDialogRequested(ColorDialogRequest request) (since QtWebEngine 1.4)
• contextMenuRequested(ContextMenuRequest request) (since QtWebEngine 1.4)
• desktopMediaRequested(webEngineDesktopMediaRequest request) (since QtWebEngine 6.7)
• fileDialogRequested(FileDialogRequest request) (since QtWebEngine 1.4)
• findTextFinished(findTextResult result) (since QtWebEngine 1.10)
• fullScreenRequested(FullScreenRequest request) (since QtWebEngine 1.1)
• geometryChangeRequested(rect geometry, rect frameGeometry) (since QtWebEngine 1.7)
• javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, string message, int lineNumber, string sourceID)
• javaScriptDialogRequested(JavaScriptDialogRequest request) (since QtWebEngine 1.4)
• linkHovered(url hoveredUrl)
• loadingChanged(WebEngineLoadingInfo loadingInfo)
• navigationRequested(WebEngineNavigationRequest request)
• newWindowRequested(WebEngineNewWindowRequest request) (since QtWebEngine 2.0)
• pdfPrintingFinished(string filePath, bool success) (since QtWebEngine 1.5)
• permissionRequested(webEnginePermission permission) (since QtWebEngine 6.8)
• printRequested() (since QtWebEngine 1.8)
• printRequestedByFrame(webEngineFrame frame) (since QtWebEngine 6.8)
• recentlyAudibleChanged(bool recentlyAudible) (since QtWebEngine 1.3)
• registerProtocolHandlerRequested(registerProtocolHandlerRequest request) (since QtWebEngine 1.7)
• renderProcessPidChanged(qint64 pid) (since QtWebEngine 1.11)
• renderProcessTerminated(RenderProcessTerminationStatus terminationStatus, int exitCode) (since QtWebEngine 1.2)
• selectClientCertificate(WebEngineClientCertificateSelection clientCertificateSelection) (since QtWebEngine 1.9)
• tooltipRequested(TooltipRequest request) (since QtWebEngine 1.10)
• touchSelectionMenuRequested(TouchSelectionMenuRequest request) (since QtWebEngine 6.3)
• wasRecentlyAudibleChanged(bool wasRecentlyAudible) (since QtWebEngine 1.3)
• webAuthUxRequested(WebEngineWebAuthUxRequest request) (since QtWebEngine 6.7)
• windowCloseRequested() (since QtWebEngine 1.2)
• zoomFactorChanged(qreal factor) (since QtWebEngine 6.8)

Métodos

• void acceptAsNewWindow(WebEngineNewWindowRequest request) (since QtWebEngine 2.0)
• WebEngineAction action(WebAction action)
• webEngineFrame findFrameByName(string name) (since QtWebEngine 6.8)
• void findText(string subString) (since QtWebEngine 1.1)
• void findText(string subString, FindFlags options) (since QtWebEngine 1.1)
• void findText(string subString, FindFlags options, variant resultCallback) (since QtWebEngine 1.1)
• void fullScreenCancelled() (since QtWebEngine 1.1)
• void goBack()
• void goBackOrForward(int offset) (since QtWebEngine 1.1)
• void goForward()
• void loadHtml(string html, url baseUrl)
• void printToPdf(const string filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation) (since QtWebEngine 1.3)
• void printToPdf(variant resultCallback, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation) (since QtWebEngine 1.3)
• void reload()
• void reloadAndBypassCache() (since QtWebEngine 1.1)
• void replaceMisspelledWord(const string replacement) (since QtWebEngine 1.3)
• void runJavaScript(string script, variant callback)
• void runJavaScript(string script, int worldId, variant callback)
• void save(string filePath, WebEngineDownloadRequest.SavePageFormat format) (since QtWebEngine 6.6)
• void setActiveFocusOnPress(bool arg) (since QtWebEngine 1.2)
• void stop()
• void triggerWebAction(WebAction action) (since QtWebEngine 1.2)

Descripción detallada

El tipo WebEngineView permite a las aplicaciones QML renderizar regiones de contenido web dinámico. Puede compartir la pantalla con otros tipos QML, como un TabView, o llenar la pantalla, según se especifique dentro de la aplicación QML.

Inicialización del motor web

Para renderizar la vista del motor web, éste debe inicializarse utilizando QtWebEngineQuick::initialize en el archivo fuente principal de la aplicación, como se ilustra en el siguiente fragmento de código:

int main(int argc, char *argv[])
{
    QCoreApplication::setAttribute(Qt::AA_ShareOpenGLContexts);
    QtWebEngineQuick::initialize();
    QGuiApplication app(argc, argv);
    QQmlApplicationEngine engine;
    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
    return app.exec();
}

Carga de páginas web

Una aplicación puede cargar páginas en la WebEngineView utilizando la propiedad url o el método loadHtml. El método GET se utiliza siempre para cargar URLs.

El historial está representado por un modelo de datos WebEngineHistory que se mantiene mediante la propiedad history.

El siguiente ejemplo de aplicación QML carga una página web utilizando la propiedad url:

import QtQuick
import QtQuick.Window
import QtWebEngine

Window {
    width: 1024
    height: 750
    visible: true
    WebEngineView {
        anchors.fill: parent
        url: "https://www.qt.io"
    }
}

La propiedad loading mantiene si una página HTML se está cargando actualmente. La señal loadingChanged() se emite cuando la carga de la página comienza, termina o falla.

Se puede acceder al título de una página HTML con la propiedad title. Además, una página web puede especificar un icono, al que se puede acceder mediante la propiedad icon. La propiedad zoomFactor permite ampliar el contenido de la página web mediante un factor de escala.

Si se produce un error de certificado al cargar una página web, se emite la señal certificateError(). Los errores de certificado se gestionan mediante los métodos del tipo WebEngineCertificateError.

Interacción

Por defecto, los enlaces a diferentes páginas se cargan dentro del mismo objeto WebEngineView, pero los sitios web pueden solicitar que se abran como una nueva pestaña, ventana o cuadro de diálogo. La señal newWindowRequested() se emite cuando se solicita cargar la página en una vista separada del motor web. La propiedad NewViewDestination describe cómo debe abrirse la nueva vista. Además, el tipo de utilidad WebEngineNewWindowRequest puede utilizarse para cargar páginas web en vistas separadas del motor web.

El método findText() puede utilizarse para buscar una cadena en una página web, utilizando las opciones descritas en FindFlags.

El método setActiveFocusOnPress() se puede utilizar para crear un elemento de interfaz de usuario que no debe obtener el foco al pulsar. Esto puede ser útil en una interfaz de usuario híbrida.

La opción focusOnNavigationEnabled se puede utilizar para hacer que la vista reciba automáticamente el foco cuando se produce una operación de navegación (como cargar o recargar una página, o navegar por el historial).

La señal linkHovered() se emite cuando el puntero del ratón pasa sobre un enlace y, por tanto, corresponde al evento DOM mouseover.

Se pueden realizar acciones, como seleccionar y editar contenido, en una página web utilizando el método triggerWebAction(). Las acciones disponibles se describen mediante la propiedad WebAction.

La señal backgroundColorChanged() se emite cuando cambia el color de fondo de la página web.

Scripts de usuario

Durante la carga de una página, los llamados scripts de usuario pueden inyectarse en el motor JavaScript en diferentes puntos. Los objetos script adjuntos a la vista del motor web se mantienen mediante la propiedad userScripts y se inyectan utilizando el tipo WebEngineScript. Los scripts también pueden ejecutarse utilizando el método runJavaScript() en el mismo mundo que otros scripts que forman parte del sitio cargado.

La propiedad webChannel puede utilizarse para exponer una instancia WebChannel en el contexto JavaScript de la página que está renderizando como qt.webChannelTransport.

Modo de pantalla completa

Una página web puede solicitar a través de la API de JavaScript que se cargue en modo de pantalla completa. La señal fullScreenRequested() se emite cuando la página web emite la solicitud. El tipo de utilidad FullScreenRequest puede utilizarse para alternar las solicitudes de pantalla completa. El método fullScreenCancelled puede utilizarse para notificar al motor del navegador cuando el sistema de ventanas obliga a la aplicación a abandonar el modo de pantalla completa.

Perfiles

Las vistas del motor web pueden aislarse unas de otras utilizando el tipo WebEngineProfile. Un perfil contiene configuraciones, scripts y la lista de enlaces visitados compartidos por todas las vistas que pertenecen al perfil. Por ejemplo, puede crearse un perfil específico para un modo de navegación privado. El perfil actual para la vista se mantiene mediante la propiedad profile y la configuración actual se mantiene mediante la propiedad settings. Los ajustes se especifican utilizando el tipo WebEngineSettings.

Características de la plataforma

Las páginas web pueden solicitar acceso a características de la plataforma como la geolocalización o los dispositivos de captura de audio y vídeo. La señal permissionRequested() se emite cuando una página web solicita hacer uso de un recurso. Las funciones de plataforma admitidas se describen en la propiedad WebEnginePermission::Feature.

Renderizado a una superficie OpenGL

Cuando se utiliza QQuickRenderControl para renderizar una interfaz de usuario Qt Quick en una superficie OpenGL, el tipo WebEngineView no se renderiza correctamente. La vista de motor web intenta utilizar un contexto OpenGL global creado por QtWebEngineQuick::initialize, pero no existe una API pública para acceder a ese contexto con el fin de compartirlo con el contexto QQuickRenderControl.

Para que la vista del motor web se renderice correctamente, es posible crear manualmente un nuevo contexto fuera de pantalla que se comparta con el contexto QQuickRenderControl y llamar a la función no pública qt_gl_set_global_share_context(), en lugar de llamar a initialize(). Si se llama a initialize() después de establecer un contexto global, no hará nada.

Documentación de propiedades

ErrorDomain : enumeration

Describe varios tipos de error de alto nivel:

FindFlags : enumeration

Describe las opciones disponibles para la función findText(). Las opciones pueden ser OR-ed juntos de la siguiente lista:

Véase también findText().

JavaScriptConsoleMessageLevel : enumeration

Indica la gravedad de un mensaje de consola JavaScript:

LifecycleState : enumeration [since QtWebEngine 1.10]

Este enum describe el estado del ciclo de vida de la página:

Esta propiedad fue introducida en QtWebEngine 1.10.

Véase también lifecycleState, API del ciclo de vida de la página y Ejemplo de ciclo de vida de WebEngine.

LoadStatus : enumeration

Refleja el estado de carga de una página:

PrintedPageOrientation : enumeration [since QtWebEngine 1.3]

Describe la orientación de un documento PDF que se crea a partir del contenido de WebEngineView. Los valores de la enumeración se asignan desde y deben coincidir con QPageLayout::Orientation.

Esta propiedad se introdujo en QtWebEngine 1.3.

Véase también WebEngineView::printToPdf().

PrintedPageSizeId : enumeration [since QtWebEngine 1.3]

Este tipo de enumeración enumera los tamaños de página disponibles según se definen en el estándar PPD de Postscript.

Los valores de la enumeración se asignan desde y deben coincidir con QPageSize::PageSizeId. También están duplicados en QPagedPaintDevice y QPrinter.

Los tamaños definidos son:

Esta propiedad se introdujo en QtWebEngine 1.3.

Véase también WebEngineView::printToPdf().

RenderProcessTerminationStatus : enumeration [since QtWebEngine 1.2]

Describe el estado con el que finalizó el proceso de renderizado:

Esta propiedad fue introducida en QtWebEngine 1.2.

WebAction : enumeration [since QtWebEngine 1.2]

Describe los tipos de acción que pueden realizarse en una página web:

Esta propiedad se introdujo en QtWebEngine 1.2.

activeFocusOnPress : bool [since QtWebEngine 1.2]

Especifica si la vista debe obtener el foco activo cuando se pulsa. El valor por defecto es true.

Esta propiedad se introdujo en QtWebEngine 1.2.

audioMuted : bool [since QtWebEngine 1.3]

El estado de si el audio de la página actual está silenciado.

Esta propiedad se introdujo en QtWebEngine 1.3.

Véase también recentlyAudible.

backgroundColor : color [since QtWebEngine 1.2]

Cambia el color del fondo de WebEngineView, detrás del cuerpo del documento. Puede establecerse en "transparent" o en un color translúcido para ver a través del documento o para que coincida con el contenido web en una aplicación híbrida para evitar los destellos blancos que pueden aparecer durante la carga.

El valor por defecto es blanco.

Esta propiedad se introdujo en QtWebEngine 1.2.

canGoBack : bool [read-only]

Devuelve true si hay entradas en el historial de sesiones anteriores, false en caso contrario.

canGoForward : bool [read-only]

Devuelve true si hay entradas posteriores en el historial de sesiones, false en caso contrario.

contentsSize : size [read-only, since QtWebEngine 1.3]

El tamaño del contenido completo de la página, medido en píxeles lógicos. En dispositivos con un factor de escala distinto del 100%, no se corresponderá con el tamaño en pantalla, sino con el tamaño antes de aplicar el escalado. En estos casos, el tamaño puede contener valores fraccionarios.

Esta propiedad se introdujo en QtWebEngine 1.3.

devToolsId : WebEngineView [read-only, since QtWebEngine 6.6]

Id. del host de herramientas de desarrollo asociado a esta página.

Si la depuración remota está activada (consulte Qt WebEngine Developer Tools), el id se puede utilizar para construir la URL para conectarse al websocket de la herramienta de desarrollo: ws://localhost:<debugging-port>/devtools/page/<id>). El websocket puede usarse para interactuar con la página usando el protocolo DevTools.

Esta propiedad se introdujo en QtWebEngine 6.6.

devToolsView : WebEngineView [since QtWebEngine 1.7]

La vista que aloja actualmente las herramientas de desarrollo para esta vista. Establecerla a una nueva vista navegará esa vista a una URL interna con las herramientas de desarrollo, y la enlazará a esta vista.

Esta propiedad se introdujo en QtWebEngine 1.7.

Véase también inspectedView.

history : WebEngineHistory [read-only, since QtWebEngine 1.1]

El historial de navegación de la vista actual.

Esta propiedad se introdujo en QtWebEngine 1.1.

Véase también WebEngineHistory.

icon : url [read-only]

Una URL interna para acceder al icono del sitio web mostrado actualmente, también conocido como favicon o icono de acceso directo. Esta URL de sólo lectura corresponde a la imagen utilizada dentro de una aplicación de navegador móvil para representar una página marcada en la pantalla de inicio del dispositivo.

El siguiente fragmento de código utiliza la propiedad icon para construir un componente Image:

Image {
    id: appIcon
    sourceSize: Qt.size(32, 32)
    source: webView.icon != "" ? webView.icon : "fallbackFavicon.png";
    // ...
}

La especificación de la propiedad Image::sourceSize informa al proveedor de favicon Qt WebEngine's sobre el tamaño solicitado y redimensiona el icono a él. Si no se especifica la propiedad Image::sourceSize, el proveedor proporciona el icono con la mayor resolución disponible.

inspectedView : WebEngineView [since QtWebEngine 1.7]

La vista que esta vista está inspeccionando actualmente, si existe. Si se establece, se navegará a una URL interna con las herramientas de desarrollo de la vista establecida.

Se recomienda deshabilitar esta propiedad cuando las herramientas de desarrollo no estén visibles; de lo contrario, podría aparecer alguna información de depuración en la vista inspeccionada WebEngineView.

Esta propiedad se introdujo en QtWebEngine 1.7.

Véase también devToolsView.

isFullScreen : bool [read-only, since QtWebEngine 1.1]

Devuelve true si la vista web está en modo de pantalla completa, false en caso contrario.

Esta propiedad se introdujo en QtWebEngine 1.1.

Véase también fullScreenRequested() y fullScreenCancelled().

lifecycleState : LifecycleState [since QtWebEngine 1.10]

Estado actual del ciclo de vida de la página.

El definidor impone las siguientes restricciones:

• Una página visible debe permanecer en el estado Active.
• Si la página está siendo inspeccionada por un devToolsView entonces ambas páginas deben permanecer en los estados Active.
• Una página en el estado Discarded sólo puede pasar al estado Active. Esto provocará una recarga de la página.

Estos son los únicos límites fijos en el estado del ciclo de vida, pero véase también recommendedState para los límites blandos recomendados.

Esta propiedad fue introducida en QtWebEngine 1.10.

Vea también recommendedState, Page Lifecycle API, y WebEngine Lifecycle Example.

loadProgress : int [read-only]

La cantidad de datos de la página que se ha cargado, expresada como un porcentaje entero en el rango de 0 a 100.

loading : bool [read-only]

Devuelve true si la página HTML se está cargando actualmente, false en caso contrario.

mainFrame : webEngineFrame [read-only, since QtWebEngine 6.8]

El marco principal de la página. Todos los demás marcos de esta página son accesibles como hijos del marco principal.

Esta propiedad se introdujo en QtWebEngine 6.8.

profile : WebEngineProfile [since QtWebEngine 1.1]

El perfil actual utilizado para la vista.

Esta propiedad se introdujo en QtWebEngine 1.1.

Véase también WebEngineProfile.

recentlyAudible : bool [read-only, since QtWebEngine 1.3]

Devuelve el estado audible de la página actual (el audio fue reproducido recientemente, o no).

Esta propiedad se introdujo en QtWebEngine 1.3.

Véase también audioMuted y recentlyAudibleChanged.

recommendedState : LifecycleState [read-only, since QtWebEngine 1.10]

El límite recomendado para el estado del ciclo de vida de la página.

Establecer el estado del ciclo de vida a un estado de uso de recursos inferior al recomendado puede causar efectos secundarios como la detención de la reproducción de audio en segundo plano o la pérdida de la entrada de formularios HTML. Establecer el estado del ciclo de vida a un estado de uso de recursos superior es, sin embargo, completamente seguro.

Esta propiedad se introdujo en QtWebEngine 1.10.

Véase también lifecycleState, API del ciclo de vida de la página y Ejemplo de ciclo de vida de WebEngine.

renderProcessPid : qint64 [read-only, since QtWebEngine 1.11]

Devuelve el ID de proceso (PID) del proceso de renderizado asignado al marco principal de la página actual.

Si aún no hay ningún proceso de renderizado disponible, se devuelve 0.

Esta propiedad fue introducida en QtWebEngine 1.11.

Véase también renderProcessPidChanged.

scrollPosition : point [read-only, since QtWebEngine 1.3]

Posición de desplazamiento del contenido de la página.

Esta propiedad se introdujo en QtWebEngine 1.3.

settings : WebEngineSettings [read-only, since QtWebEngine 1.1]

Configuración utilizada por esta vista.

Esta propiedad se introdujo en QtWebEngine 1.1.

Véase también WebEngineSettings.

title : string [read-only]

El título de la página HTML mostrada actualmente. Se trata de un valor de sólo lectura que refleja el contenido de la etiqueta <title>.

touchHandleDelegate : Component [since QtWebEngine 6.4]

touchHandleDelegate proporciona una plantilla que define los manejadores táctiles visuales instanciados por la vista siempre que se requiera el manejo de la selección táctil.

La posición, opacidad y visibilidad del manejador se actualizan automáticamente. El delegado debe ser un elemento QML o cualquier tipo QML que lo herede.

El siguiente código utiliza un delegado personalizado:

WebEngineView {
// ...
    touchHandleDelegate: Rectangle {
        color: "red"
    }
    // ...
}

Los manejadores táctiles también se pueden cambiar dinámicamente:

 Component {
    id: circleTouchHandle
    Rectangle {
        color: "blue"
        radius: 50
    }
}
function showDefaultHandle(isDefault) {
    if (isDefault)
        webEngineView.touchHandleDelegate = circleTouchHandle
    else
        webEngineView.touchHandleDelegate = null
}

Esta propiedad se introdujo en QtWebEngine 6.4.

url : url

La ubicación de la página HTML mostrada actualmente. Esta propiedad con permisos de escritura ofrece la interfaz principal para cargar una página en una vista web. Funciona igual que la propiedad DOM window.location.

Véase también loadHtml().

userScripts : WebEngineScriptCollection [read-only, since QtWebEngine 1.1]

La colección de scripts de usuario asociada a la vista.

Esta propiedad se introdujo en QtWebEngine 1.1.

Véase también WebEngineScriptCollection.

webChannel : QQmlWebChannel [since QtWebEngine 1.1]

La instancia del canal web utilizado por esta vista. Este canal utiliza automáticamente el mecanismo de transporte interno QtWebEngine sobre Chromium IPC, y se expone en el contexto javascript de la página que está renderizando como qt.webChannelTransport. Este objeto de transporte se utiliza al instanciar la contraparte JavaScript de QWebChannel utilizando la API JavaScriptQt WebChannel .

Esta propiedad se introdujo en QtWebEngine 1.1.

webChannelWorld : int [since QtWebEngine 1.3]

Mundo JavaScript en el que está instalada la instancia del canal web utilizado por esta vista. El mundo debe ser un número entre 0 y 256.

Esta propiedad se introdujo en QtWebEngine 1.3.

zoomFactor : real [since QtWebEngine 1.1]

Factor de zoom para la vista. Los valores válidos están dentro del rango de 0.25 a 5.0. El factor por defecto es 1.0.

Esta propiedad se introdujo en QtWebEngine 1.1.

Documentación sobre señales

[since QtWebEngine 1.2] activeFocusOnPressChanged(bool activeFocusOnPress)

Esta señal se emite cuando cambia el valor de activeFocusOnPress. Especifica si la vista debe obtener el foco activo cuando se pulsa.

Esta señal se introdujo en QtWebEngine 1.2.

Véase también activeFocusOnPress y setActiveFocusOnPress().

[since QtWebEngine 1.3] audioMutedChanged(bool muted)

Esta señal se emite cuando cambia el valor de muted. El valor se especifica mediante la propiedad audioMuted.

Esta señal se introdujo en QtWebEngine 1.3.

Véase también audioMuted y recentlyAudibleChanged.

[since QtWebEngine 1.4] authenticationDialogRequested(AuthenticationDialogRequest request)

Esta señal se emite cuando se solicita un diálogo de autenticación.

El request puede ser manejado utilizando los métodos del tipo AuthenticationDialogRequest.

Esta señal se introdujo en QtWebEngine 1.4.

[since QtWebEngine 1.2] backgroundColorChanged()

Esta señal se emite cuando cambia el color de fondo de la vista del motor web.

Esta señal se introdujo en QtWebEngine 1.2.

[since QtWebEngine 1.1] certificateError(WebEngineCertificateError error)

Esta señal se emite cuando se produce un error de certificado no válido, error, al cargar una solicitud determinada.

El error de certificado puede gestionarse utilizando los métodos del tipo WebEngineCertificateError.

Esta señal se introdujo en QtWebEngine 1.1.

[since QtWebEngine 1.4] colorDialogRequested(ColorDialogRequest request)

Esta señal se emite cuando se solicita un diálogo de selección de color.

El request puede ser manejado utilizando los métodos del tipo ColorDialogRequest.

Esta señal se introdujo en QtWebEngine 1.4.

[since QtWebEngine 1.4] contextMenuRequested(ContextMenuRequest request)

Esta señal se emite cuando se solicita un menú contextual.

La señal request puede manejarse utilizando las propiedades del tipo ContextMenuRequest.

Esta señal se introdujo en QtWebEngine 1.4.

[since QtWebEngine 6.7] desktopMediaRequested(webEngineDesktopMediaRequest request)

Esta señal se emite cuando una aplicación web solicita acceso al contenido de una pantalla.

El argumento request contiene referencias a modelos de datos de ventanas y pantallas disponibles para su captura. Para aceptar la solicitud, el controlador de la señal puede llamar a webEngineDesktopMediaRequest::selectScreen() o a webEngineDesktopMediaRequest::selectWindow().

Esta señal se introdujo en QtWebEngine 6.7.

[since QtWebEngine 1.4] fileDialogRequested(FileDialogRequest request)

Esta señal se emite cuando se solicita un diálogo de selección de archivos.

La señal request puede manejarse utilizando los métodos del tipo FileDialogRequest.

Esta señal se introdujo en QtWebEngine 1.4.

[since QtWebEngine 1.10] findTextFinished(findTextResult result)

Esta señal se emite cuando finaliza una búsqueda de cadenas en una página. result es el resultado de la búsqueda de cadenas.

Esta señal se introdujo en QtWebEngine 1.10.

Véase también findText() y findTextResult.

[since QtWebEngine 1.1] fullScreenRequested(FullScreenRequest request)

Esta señal se emite cuando la página web emite el request para el modo de pantalla completa a través de la API de JavaScript.

Esta señal se introdujo en QtWebEngine 1.1.

Véase también isFullScreen.

[since QtWebEngine 1.7] geometryChangeRequested(rect geometry, rect frameGeometry)

Esta señal se emite cada vez que el documento desea cambiar la posición y el tamaño de la página a frameGeometry. Esto puede ocurrir, por ejemplo, a través de JavaScript.

Mientras que frameGeometry incluye, geometry excluye el tamaño de los márgenes del marco.

onGeometryChangeRequested: {
    window.x = geometry.x
    window.y = geometry.y
    window.width = geometry.width
    window.height = geometry.height
}

Esta señal se introdujo en QtWebEngine 1.7.

javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, string message, int lineNumber, string sourceID)

Esta señal se emite cuando un programa JavaScript intenta imprimir un message en la consola del navegador web.

Por ejemplo, en caso de errores de evaluación, se puede proporcionar la URL de origen en sourceID, así como el lineNumber.

level indica la gravedad del evento que desencadenó el mensaje, es decir, si fue provocado por un error o por un evento menos grave.

Si no se especifica ningún manejador, la vista registrará los mensajes en un js logging category .

Véase también Registro en consola.

[since QtWebEngine 1.4] javaScriptDialogRequested(JavaScriptDialogRequest request)

Esta señal se emite cuando se solicita un diálogo JavaScript.

El request puede ser manejado utilizando los métodos del tipo JavaScriptDialogRequest.

Esta señal se introdujo en QtWebEngine 1.4.

linkHovered(url hoveredUrl)

Dentro de una interfaz controlada por el ratón, esta señal se emite cuando el puntero del ratón pasa por encima de un enlace, lo que corresponde al evento DOM mouseover. Este evento también puede producirse en interfaces táctiles para eventos mouseover que no se cancelan con preventDefault(). hoveredUrl proporciona la ubicación del enlace.

loadingChanged(WebEngineLoadingInfo loadingInfo)

Esta señal se emite cuando comienza, finaliza o falla la carga de una página.

Cuando se maneja la señal con onLoadingChanged, varios parámetros de sólo lectura están disponibles en el WebEngineLoadingInfo especificado por loadingInfo.

Véase también loading, LoadStatus, y ErrorDomain.

navigationRequested(WebEngineNavigationRequest request)

Esta señal se emite cuando se emite la petición de navegación request.

[since QtWebEngine 2.0] newWindowRequested(WebEngineNewWindowRequest request)

Esta señal se emite cuando se emite request para cargar una página en una vista independiente del motor web. Esto puede deberse a que la página actual lo haya solicitado explícitamente a través de una llamada JavaScript a window.open, o a que el usuario haya hecho clic en un enlace mientras mantenía pulsada la tecla Shift, Cmd/Ctrl, o una combinación incorporada que active la apertura de la página en una nueva ventana.

La señal se gestiona llamando a acceptAsNewWindow() en la vista de destino. Si no se gestiona esta señal, la carga solicitada fallará.

Un ejemplo de implementación:

QtObject {
    id: windowParent
    // Create the initial browsing windows and open the startup page.
    Component.onCompleted: {
        var firstWindow = windowComponent.createObject(windowParent);
        firstWindow.webView.loadHtml('<input type="button" value="Click!" onclick="window.open(&quot;http://qt.io&quot;)">');
    }

    property Component windowComponent: Window {
        // Destroy on close to release the Window's QML resources.
        // Because it was created with a parent, it won't be garbage-collected.
        onClosing: destroy()
        visible: true

        property WebEngineView webView: webView_
        WebEngineView {
            id: webView_
            anchors.fill: parent

            // Handle the signal. Dynamically create the window and
            // use its WebEngineView as the destination of our request.
            onNewWindowRequested: function(request) {
                var newWindow = windowComponent.createObject(windowParent);
                newWindow.webView.acceptAsNewWindow(request);
            }
        }
    }
}

Esta señal se introdujo en QtWebEngine 2.0.

Véase también WebEngineNewWindowRequest y WebEngine Quick Nano Browser.

[since QtWebEngine 1.5] pdfPrintingFinished(string filePath, bool success)

Esta señal se emite cuando ha finalizado la impresión de la página web en un archivo PDF. filePath contendrá la ruta en la que se solicitó la creación del archivo, y success será true si el archivo se creó correctamente y false en caso contrario.

Esta señal se introdujo en QtWebEngine 1.5.

Véase también printToPdf().

[since QtWebEngine 6.8] permissionRequested(webEnginePermission permission)

Esta señal se emite cuando un sitio web lanza una solicitud de permiso (por ejemplo, acceso de geolocalización, permiso para enviar notificaciones). El objeto permission puede consultar la URL solicitante y el WebEnginePermission.PermissionType que está pidiendo, así como conceder o denegar el permiso.

Esta señal se introdujo en QtWebEngine 6.8.

[since QtWebEngine 1.8] printRequested()

Esta señal se emite cuando se llama al método JavaScript window.print() en el marco principal, o cuando el usuario pulsa el botón de impresión del complemento del visor de PDF. Normalmente, el controlador de la señal puede simplemente llamar a printToPdf().

Desde QtWebEngine 6.8, esta señal sólo se emite para el marco principal, en lugar de emitirse para cualquier marco que solicite la impresión.

Esta señal se introdujo en QtWebEngine 1.8.

Véase también printToPdf.

[since QtWebEngine 6.8] printRequestedByFrame(webEngineFrame frame)

Esta señal se emite cuando se llama al método JavaScript window.print() en frame. Si el marco es el marco principal, se emite printRequested en su lugar.

Esta señal se introdujo en QtWebEngine 6.8.

Véase también printRequested.

[since QtWebEngine 1.3] recentlyAudibleChanged(bool recentlyAudible)

Esta señal se emite cuando el estado audible de la página, especificado por recentlyAudible, cambia debido a la reproducción o detención del audio.

Si una página web contiene dos vídeos que se inician en secuencia, esta señal se emite sólo una vez, para que el primer vídeo genere sonido. Una vez detenidos ambos vídeos, la señal se emite al generarse el último sonido. Esto significa que la señal se emite tanto cuando se genera cualquier sonido, como cuando todo queda completamente en silencio, independientemente del número de secuencias de audio.

También pueden producirse emisiones espurias de señal. Por ejemplo, cuando el sonido se detiene, esta señal se emite primero con un valor de true, y después con un valor de false. Además, cuando el audio comienza a reproducirse, la señal se emite dos veces con un valor de true.

Esta señal se introdujo en QtWebEngine 1.3.

Véase también recentlyAudible.

[since QtWebEngine 1.7] registerProtocolHandlerRequested(registerProtocolHandlerRequest request)

Esta señal se emite cuando la página web intenta registrar un protocolo personalizado emitiendo un registerProtocolHandler request.

Esta señal se introdujo en QtWebEngine 1.7.

Véase también registerProtocolHandlerRequest.

[since QtWebEngine 1.11] renderProcessPidChanged(qint64 pid)

Si todavía no hay ningún proceso de renderizado disponible, se devuelve 0. Esta señal se emite cuando pid (ID de proceso) del proceso de renderizado subyacente de la página cambia.

Esta señal se introdujo en QtWebEngine 1.11.

Véase también renderProcessPid.

[since QtWebEngine 1.2] renderProcessTerminated(RenderProcessTerminationStatus terminationStatus, int exitCode)

Esta señal se emite cuando el proceso de renderizado finaliza con un estado de salida distinto de cero. terminationStatus es el estado de finalización del proceso y exitCode es el código de estado con el que finalizó el proceso.

Esta señal se introdujo en QtWebEngine 1.2.

Véase también RenderProcessTerminationStatus.

[since QtWebEngine 1.9] selectClientCertificate(WebEngineClientCertificateSelection clientCertificateSelection)

Esta señal se emite cuando un sitio web solicita un certificado SSL de cliente, y se han encontrado uno o más en el almacén de certificados de cliente del sistema.

El manejo de la señal es asíncrono, y la carga esperará hasta que se seleccione un certificado, o se destruya la última copia de clientCertificateSelection.

Si no se gestiona la señal, clientCertificateSelection se destruye automáticamente y la carga continuará sin un certificado de cliente.

Esta señal se introdujo en QtWebEngine 1.9.

Véase también WebEngineClientCertificateSelection.

[since QtWebEngine 1.10] tooltipRequested(TooltipRequest request)

Esta señal se emite cuando la página web envía un request para mostrar un tooltip en una posición especificada.

Esta señal se introdujo en QtWebEngine 1.10.

Véase también TooltipRequest.

[since QtWebEngine 6.3] touchSelectionMenuRequested(TouchSelectionMenuRequest request)

Esta señal se emite cuando se solicita un menú de selección táctil en una posición determinada.

La señal request puede manejarse utilizando los métodos del tipo TouchSelectionMenuRequest.

Esta señal se introdujo en QtWebEngine 6.3.

Véase también TouchSelectionMenuRequest.

[since QtWebEngine 1.3] wasRecentlyAudibleChanged(bool wasRecentlyAudible)

Esta señal se emite cuando el estado audible de la página, especificado por wasRecentlyAudible, cambia debido a la reproducción o detención del audio.

Esta señal se introdujo en QtWebEngine 1.3.

[since QtWebEngine 6.7] webAuthUxRequested(WebEngineWebAuthUxRequest request)

Esta señal se emite cuando un autenticador WebAuth requiere la interacción del usuario durante el proceso de autenticación. Estas solicitudes se gestionan mostrando un cuadro de diálogo al usuario.

El objeto request contiene la información y la API necesarias para completar la solicitud WebAuth UX.

Esta señal se introdujo en QtWebEngine 6.7.

Véase también WebEngineWebAuthUxRequest.

[since QtWebEngine 1.2] windowCloseRequested()

Esta señal se emite siempre que la página solicita que se cierre la ventana del navegador web, por ejemplo a través de la llamada a JavaScript window.close().

Esta señal se introdujo en QtWebEngine 1.2.

[since QtWebEngine 6.8] zoomFactorChanged(qreal factor)

Esta señal se emite cada vez que cambia el zoom factor de la página.

Esta señal se introdujo en QtWebEngine 6.8.

Véase también zoomFactor.

Documentación del método

[since QtWebEngine 2.0] void acceptAsNewWindow(WebEngineNewWindowRequest request)

Maneja la señal newWindowRequested abriendo el request en esta vista.

Este método se introdujo en QtWebEngine 2.0.

Véase también newWindowRequested.

WebEngineAction action(WebAction action)

Devuelve un WebEngineAction para el WebAction especificado action. WebEngineView también se encarga de implementar la acción, de modo que al activarse se realiza la acción correspondiente en la vista.

var copyAction = webEngineView.action(WebEngineView.Copy);

Véase también WebEngineAction.

[since QtWebEngine 6.8] webEngineFrame findFrameByName(string name)

Devuelve el marco con el nombre name. Si hay varios marcos con el mismo nombre, el que se devuelva es arbitrario. Si no se encuentra ningún marco, devuelve un marco invalid.

Este método se introdujo en QtWebEngine 6.8.

[since QtWebEngine 1.1] void findText(string subString)

Busca la cadena especificada, subString, en la página. La señal findTextFinished() se emite cuando finaliza la búsqueda de una cadena.

Para borrar el resalte de búsqueda, basta con pasar una cadena vacía.

Este método se introdujo en QtWebEngine 1.1.

Véase también findTextFinished().

[since QtWebEngine 1.1] void findText(string subString, FindFlags options)

Busca la cadena especificada, subString, en la página, utilizando la dirección options. La señal findTextFinished() se emite cuando se completa una búsqueda de cadena.

Para borrar el resaltado de búsqueda, basta con pasar una cadena vacía.

findText("Qt", WebEngineView.FindBackward | WebEngineView.FindCaseSensitively);

Este método se introdujo en QtWebEngine 1.1.

Véase también findTextFinished().

[since QtWebEngine 1.1] void findText(string subString, FindFlags options, variant resultCallback)

Busca la cadena especificada, subString, en la página, utilizando la dirección options. La señal findTextFinished() se emite cuando se completa una búsqueda de cadena.

Para borrar el resalte de búsqueda, basta con pasar una cadena vacía.

resultCallback debe recibir un parámetro entero. Se llamará con el número de apariciones encontradas de subString.

findText("Qt", WebEngineView.FindCaseSensitively, function(matchCount) {
    if (matchCount > 0)
        console.log("'Qt' tokens found:", matchCount);
});

Este método se introdujo en QtWebEngine 1.1.

Véase también findTextFinished().

[since QtWebEngine 1.1] void fullScreenCancelled()

Establece inmediatamente la propiedad isFullScreen a false. Puede utilizarse para notificar al motor del navegador cuando el sistema de ventanas fuerza a la aplicación a abandonar el modo de pantalla completa.

ApplicationWindow {
    onVisibilityChanged: {
        if (webEngineView.isFullScreen && visibility != Window.FullScreen)
            webEngineView.fullScreenCancelled()
    }

    WebEngineView {
        id: webEngineView
        // ...
    }
}

Este método se introdujo en QtWebEngine 1.1.

Véase también isFullScreen y fullScreenRequested().

void goBack()

Retrocede en el historial de sesiones del navegador, si es posible. Esta función es equivalente al método DOM window.history.back().

Véase también canGoBack.

[since QtWebEngine 1.1] void goBackOrForward(int offset)

Si offset es positivo, avanza el número especificado de páginas de offset en el historial de la sesión actual. Si offset es negativo, retrocede. Si el offset no es válido, la página no se cambia.

Este método se introdujo en QtWebEngine 1.1.

Véase también goBack() y goForward().

void goForward()

Avanza dentro del historial de sesiones del navegador, si es posible. Esta función es equivalente al método DOM window.history.forward().

void loadHtml(string html, url baseUrl)

Carga la página html especificada como contenido de la vista web.

Este método ofrece una alternativa de bajo nivel a la propiedad url, que hace referencia a páginas HTML mediante URL.

baseUrl es opcional y se utiliza para resolver URL relativas en el documento, como imágenes u hojas de estilo referenciadas. Por ejemplo, si html se recupera de http://www.example.com/documents/overview.html, que es la URL base, entonces una imagen referenciada con la URL relativa, diagram.png, debería estar en http://www.example.com/documents/diagram.png.

Al utilizar este método, el motor web asume que los recursos externos, como los programas JavaScript o las hojas de estilo, están codificados en UTF-8, a menos que se especifique lo contrario. Por ejemplo, la codificación de un script externo puede especificarse a través del atributo charset de la etiqueta script de HTML. También es posible que la codificación sea especificada por el servidor web.

Véase también url.

[since QtWebEngine 1.3] void printToPdf(const string filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)

Imprime el contenido actual de WebEngineView en un documento PDF y lo almacena en filePath. El tamaño del documento vendrá determinado por el valor de pageSizeId y su orientación se determinará utilizando orientation.

Este método emite una petición asíncrona para imprimir la página web en un PDF y devuelve inmediatamente. Para conocer el resultado de la petición, conéctese a la señal pdfPrintingFinished().

Si se omite pageSizeId, se pasa por defecto a A4. Si se omite orientation, se pasa por defecto a Portrait.

Este método se introdujo en QtWebEngine 1.3.

Véase también pdfPrintingFinished().

[since QtWebEngine 1.3] void printToPdf(variant resultCallback, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)

Imprime el contenido actual de WebEngineView en un documento PDF y lo devuelve en una matriz de bytes. El tamaño del documento vendrá determinado por el valor de pageSizeId y su orientación se determinará mediante orientation.

resultCallback debe recibir un parámetro de cadena. Esta cadena contendrá los datos del documento en caso de impresión correcta y una cadena vacía en caso contrario.

Si se omite pageSizeId, el valor por defecto es A4. Si se omite orientation, el valor por defecto es Portrait.

Este método se introdujo en QtWebEngine 1.3.

void reload()

Recarga la página actual. Esta función es equivalente al método DOM window.location.reload().

Véase también reloadAndBypassCache().

[since QtWebEngine 1.1] void reloadAndBypassCache()

Recarga la página actual, ignorando cualquier contenido almacenado en caché.

Este método se introdujo en QtWebEngine 1.1.

Véase también reload().

[since QtWebEngine 1.3] void replaceMisspelledWord(const string replacement)

Sustituye la palabra mal escrita actual por replacement.

Este método se introdujo en QtWebEngine 1.3.

Ejecuta el script especificado en el contenido de la vista web.

El parámetro callback es opcional. Si se proporciona una función de devolución de llamada, se invocará después de que el script termine de ejecutarse.

runJavaScript("document.title", function(result) { console.log(result); });

Sólo se pueden devolver datos planos desde JavaScript como valor de resultado. Los tipos de datos admitidos incluyen todos los tipos de datos JSON, así como, por ejemplo, Date y ArrayBuffer. Los tipos de datos no admitidos son, por ejemplo, Function y Promise.

Para evitar conflictos con otros scripts ejecutados en la página, el mundo en el que se ejecuta el script puede especificarse mediante worldId. El ID del mundo debe estar entre 0 y 256. Si se omite el ID world, el script se ejecuta en MainWorld.

Para obtener más información sobre la inyección de scripts, consulte Inyección de scripts. Para una forma alternativa de inyectar scripts, consulte WebEngineView::userScripts.

[since QtWebEngine 6.6] void save(string filePath, WebEngineDownloadRequest.SavePageFormat format)

Guarda en disco la página web actual.

La página web se guarda en filePath en el format especificado.

Se trata de un acceso directo para las siguientes acciones:

• Activar la acción Guardar web.
• Aceptar el siguiente elemento de descarga y establecer la ruta de archivo y el formato de guardado especificados.

Esta función emite una solicitud de descarga asíncrona para la página web y la devuelve inmediatamente.

Este método se introdujo en QtWebEngine 6.6.

Véase también WebEngineDownloadRequest::savePageFormat.

[since QtWebEngine 1.2] void setActiveFocusOnPress(bool arg)

Establece el foco activo en una vista de motor web sobre la que se ha hecho clic si arg es true. Si se establece en false, se puede utilizar una vista de motor web para crear un elemento de interfaz de usuario que no debe obtener el foco. Esto puede ser útil en una interfaz de usuario híbrida.

Este método se introdujo en QtWebEngine 1.2.

Ver también activeFocusOnPress, activeFocusOnPressChanged, y WebEngineSettings::focusOnNavigationEnabled.

void stop()

Detiene la carga de la página actual.

[since QtWebEngine 1.2] void triggerWebAction(WebAction action)

Activa la acción web action.

Este método se introdujo en QtWebEngine 1.2.

Véase también WebAction.