webEngineFrame QML Value Type

webEngineFrame proporciona información y control sobre un marco de página. Más...

Propiedades

• children : list<webEngineFrame> (since QtWebEngine 6.10)
• htmlName : string
• isMainFrame : bool
• isValid : bool
• name : string
• size : size
• url : url

Métodos

• void printToPdf(string filePath)
• void printToPdf(variant callback)
• void runJavaScript(string script, variant callback)
• void runJavaScript(string script, uint worldId, variant callback)

Descripción detallada

Un marco de motor web representa un único marco dentro de una página web, como los creados por los elementos HTML <frame> o <iframe>. Un WebEngineView activo tiene uno o más marcos dispuestos en una estructura de árbol. Se puede acceder al marco de nivel superior, la raíz de este árbol, a través de la propiedad mainFrame de la vista.

El tiempo de vida de un marco es, como máximo, tan largo como el objeto WebEngineView que lo produjo. Sin embargo, los marcos pueden crearse y borrarse de forma espontánea y dinámica, por ejemplo, a través de la navegación y la ejecución de scripts.

Documentación de propiedades

children : list<webEngineFrame> [read-only, since QtWebEngine 6.10]

Devuelve una lista de los hijos del marco en un orden arbitrario.

Si el marco no puede ser encontrado, devuelve una lista vacía.

Esta propiedad se introdujo en QtWebEngine 6.10.

htmlName : string [read-only]

Devuelve el valor del atributo HTML name del marco, o una cadena vacía si no tiene ninguno.

Si no se encuentra el marco, devuelve una cadena vacía.

Véase también name.

isMainFrame : bool [read-only]

Devuelve true si este objeto representa el marco principal de la página; false en caso contrario.

isValid : bool [read-only]

Devuelve true si este objeto representa un marco existente; false en caso contrario.

Una vez que un marco es inválido, nunca vuelve a ser válido.

name : string [read-only]

Devuelve el nombre del marco; es decir, lo que devolvería window.name en JavaScript.

Si no se encuentra el marco, devuelve una cadena vacía.

Véase también htmlName.

size : size [read-only]

El tamaño del marco dentro de la ventana gráfica, 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 la escala. En estos casos, el tamaño puede contener valores fraccionarios.

Si no se ha podido encontrar el marco, devuelve un tamaño por defecto con dimensiones (-1, -1).

url : url [read-only]

Devuelve la URL del contenido cargado actualmente en este marco.

Si no se puede encontrar el marco, devuelve una URL vacía.

Documentación del método

void printToPdf(string filePath)

Imprime el contenido actual del marco en un documento PDF y lo guarda en filePath. El documento resultante tendrá un tamaño de página A4 y orientación vertical.

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 solicitud, conéctese a la señal WebEngineView::pdfPrintingFinished().

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

void printToPdf(variant callback)

Imprime el contenido actual del marco en un documento PDF y lo devuelve en una matriz de bytes. El documento resultante tendrá un tamaño de página A4 y una orientación vertical.

callback 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.

Ejecuta el código JavaScript contenido en script en este marco, sin comprobar si se ha construido el DOM de la página.

Para evitar conflictos con otros scripts ejecutados en la página, el mundo en el que se ejecuta el script se especifica mediante worldId. Los valores de ID de mundo son los mismos que los proporcionados por QWebEngineScript::ScriptWorldId, y entre 0 y 256. Si se omite el ID world, el script se ejecuta en MainWorld.

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.

frame.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.

El script se ejecutará en el mismo mundo que otros scripts que formen parte del sitio cargado.

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.