WebEngineView QML Type

Un WebEngineView rend le contenu web dans une application QML. Plus d'informations...

• Liste de tous les membres, y compris les membres hérités
• Membres obsolètes

Propriétés

• 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)

Signaux

• 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éthodes

• 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)

Description détaillée

Le type WebEngineView permet aux applications QML de rendre des régions de contenu web dynamique. Il peut partager l'écran avec d'autres types QML, tels que TabView, ou remplir l'écran, comme spécifié dans l'application QML.

Initialisation du moteur Web

Pour que la vue du moteur Web soit rendue, le moteur Web doit être initialisé à l'aide de QtWebEngineQuick::initialize dans le fichier source principal de l'application, comme l'illustre l'extrait de code suivant :

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();
}

Chargement des pages Web

Une application peut charger des pages dans le WebEngineView en utilisant soit la propriété url, soit la méthode loadHtml. La méthode GET est toujours utilisée pour charger les URL.

L'historique est représenté par un modèle de données WebEngineHistory détenu par la propriété history.

L'exemple d'application QML suivant charge une page web à l'aide de la propriété 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 propriété loading indique si une page HTML est en cours de chargement. Le signal loadingChanged() est émis lorsque le chargement de la page commence, se termine ou échoue.

Le titre d'une page HTML est accessible à l'aide de la propriété title. En outre, une page web peut spécifier une icône, accessible à l'aide de la propriété icon. La propriété zoomFactor permet d'agrandir le contenu de la page web en fonction d'un facteur d'échelle.

Si une erreur de certificat se produit lors du chargement d'une page web, le signal certificateError() est émis. Les erreurs de certificat sont gérées à l'aide des méthodes du type WebEngineCertificateError.

Interaction

Par défaut, les liens vers différentes pages se chargent dans le même objet WebEngineView, mais les sites web peuvent demander à ce qu'ils soient ouverts dans un nouvel onglet, une nouvelle fenêtre ou une nouvelle boîte de dialogue. Le signal newWindowRequested() est émis lorsqu'une demande de chargement de la page dans une vue distincte du moteur Web est émise. La propriété NewViewDestination décrit comment la nouvelle vue doit être ouverte. En outre, le type d'utilitaire WebEngineNewWindowRequest peut être utilisé pour charger des pages web dans des vues distinctes du moteur web.

La méthode findText() peut être utilisée pour rechercher une chaîne de caractères sur une page web, en utilisant les options décrites par FindFlags.

La méthode setActiveFocusOnPress() peut être utilisée pour créer un élément de l'interface utilisateur qui ne doit pas être mis en évidence par la presse. Cela peut être utile dans une interface utilisateur hybride.

Le paramètre focusOnNavigationEnabled peut être utilisé pour que la vue reçoive automatiquement le focus lorsqu'une opération de navigation se produit (comme le chargement ou le rechargement d'une page, ou la navigation dans l'historique).

Le signal linkHovered() est émis lorsque le pointeur de la souris passe sur un lien et correspond donc à l'événement DOM mouseover.

Des actions, telles que la sélection et l'édition de contenu, peuvent être effectuées sur une page web en utilisant la méthode triggerWebAction(). Les actions disponibles sont décrites par la propriété WebAction.

Le signal backgroundColorChanged() est émis lorsque la couleur d'arrière-plan de la page web change.

Scripts utilisateur

Pendant le chargement d'une page, des scripts utilisateur peuvent être injectés dans le moteur JavaScript à différents endroits. Les objets de script attachés à la vue du moteur web sont détenus par la propriété userScripts et injectés en utilisant le type WebEngineScript. Les scripts peuvent également être exécutés en utilisant la méthode runJavaScript() dans le même monde que les autres scripts qui font partie du site chargé.

La propriété webChannel peut être utilisée pour exposer une instance de canal Web dans le contexte JavaScript de la page qu'elle rend comme qt.webChannelTransport.

Mode plein écran

Une page web peut demander, par l'intermédiaire de l'API JavaScript, à être chargée en mode plein écran. Le signal fullScreenRequested() est émis lorsque la page web émet la demande. Le type d'utilitaire FullScreenRequest peut être utilisé pour basculer les demandes de mode plein écran. La méthode fullScreenCancelled peut être utilisée pour informer le moteur du navigateur lorsque le système de fenêtrage oblige l'application à quitter le mode plein écran.

Profils

Les vues du moteur Web peuvent être isolées les unes des autres à l'aide du type WebEngineProfile. Un profil contient des paramètres, des scripts et la liste des liens visités partagés par toutes les vues qui appartiennent au profil. Par exemple, un profil dédié peut être créé pour un mode de navigation privée. Le profil actuel de la vue est détenu par la propriété profile et les paramètres actuels sont détenus par la propriété settings. Les paramètres sont spécifiés à l'aide du type WebEngineSettings.

Fonctionnalités de la plate-forme

Les pages web peuvent demander l'accès à des fonctionnalités de la plateforme telles que la géolocalisation ou les dispositifs de capture audio et vidéo. Le signal permissionRequested() est émis lorsqu'une page web demande à utiliser une ressource. Les caractéristiques de la plate-forme prises en charge sont décrites par la propriété WebEnginePermission::Feature.

Rendu vers une surface OpenGL

Lors de l'utilisation de QQuickRenderControl pour rendre une interface utilisateur Qt Quick sur une surface OpenGL, le type WebEngineView n'est pas rendu correctement. La vue du moteur web tente d'utiliser un contexte OpenGL global créé par QtWebEngineQuick::initialize, mais il n'existe pas d'API publique pour accéder à ce contexte afin de le partager avec le contexte QQuickRenderControl.

Pour obtenir un rendu correct de la vue du moteur web, il est possible de créer manuellement un nouveau contexte hors écran partagé avec le contexte QQuickRenderControl et d'appeler la fonction non publique qt_gl_set_global_share_context(), plutôt que d'appeler initialize(). Si initialize() est appelé après avoir défini un contexte global, il ne fera rien.

Documentation sur les propriétés

ErrorDomain : enumeration

Décrit les différents types d'erreurs de haut niveau :

FindFlags : enumeration

Décrit les options disponibles pour la fonction findText(). Les options peuvent être combinées par OU à partir de la liste suivante :

Voir également findText().

JavaScriptConsoleMessageLevel : enumeration

Indique la gravité d'un message de la console JavaScript :

LifecycleState : enumeration [since QtWebEngine 1.10]

Cette énumération décrit l'état du cycle de vie de la page :

Cette propriété a été introduite dans QtWebEngine 1.10.

Voir aussi lifecycleState, Page Lifecycle API, et WebEngine Lifecycle Example.

LoadStatus : enumeration

Reflète l'état de chargement d'une page :

PrintedPageOrientation : enumeration [since QtWebEngine 1.3]

Décrit l'orientation d'un document PDF créé à partir du contenu de WebEngineView. Les valeurs de l'énumération sont mappées à partir de et doivent correspondre à QPageLayout::Orientation.

Cette propriété a été introduite dans QtWebEngine 1.3.

Voir aussi WebEngineView::printToPdf().

PrintedPageSizeId : enumeration [since QtWebEngine 1.3]

Ce type d'énumération répertorie les tailles de page disponibles telles que définies dans la norme Postscript PPD.

Les valeurs de l'énumération proviennent de QPageSize::PageSizeId et doivent y correspondre. Elles sont également dupliquées dans QPagedPaintDevice et QPrinter.

Les tailles définies sont les suivantes

Cette propriété a été introduite dans QtWebEngine 1.3.

Voir aussi WebEngineView::printToPdf().

RenderProcessTerminationStatus : enumeration [since QtWebEngine 1.2]

Décrit l'état dans lequel le processus de rendu s'est terminé :

Cette propriété a été introduite dans QtWebEngine 1.2.

WebAction : enumeration [since QtWebEngine 1.2]

Décrit les types d'actions qui peuvent être effectuées sur une page web :

Cette propriété a été introduite dans QtWebEngine 1.2.

activeFocusOnPress : bool [since QtWebEngine 1.2]

Spécifie si la vue doit être mise au premier plan lorsqu'on appuie dessus. La valeur par défaut est true.

Cette propriété a été introduite dans QtWebEngine 1.2.

audioMuted : bool [since QtWebEngine 1.3]

L'état de la mise en sourdine de l'audio de la page en cours.

Cette propriété a été introduite dans QtWebEngine 1.3.

Voir aussi recentlyAudible.

backgroundColor : color [since QtWebEngine 1.2]

Modifie la couleur de l'arrière-plan de WebEngineView, derrière le corps du document. Cette couleur peut être réglée sur "transparent" ou sur une couleur translucide pour voir à travers le document ou pour correspondre au contenu web dans une application hybride afin d'éviter les flashs blancs qui peuvent apparaître pendant le chargement.

La valeur par défaut est le blanc.

Cette propriété a été introduite dans QtWebEngine 1.2.

canGoBack : bool [read-only]

Renvoie true s'il existe des entrées d'historique de session antérieures, false dans le cas contraire.

canGoForward : bool [read-only]

Renvoie true s'il existe des entrées ultérieures dans l'historique de la session, false dans le cas contraire.

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

Taille du contenu intégral de la page, mesurée en pixels logiques. Sur les appareils dont le facteur d'échelle est différent de 100 %, cette taille ne correspondra pas à la taille à l'écran, mais à la taille avant la mise à l'échelle. Dans ce cas, la taille peut contenir des valeurs fractionnaires.

Cette propriété a été introduite dans QtWebEngine 1.3.

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

L'identifiant de l'hôte des outils de développement associé à cette page.

Si le débogage à distance est activé (voir Qt WebEngine Developer Tools), l'identifiant peut être utilisé pour construire l'URL permettant de se connecter au websocket de l'outil de développement : ws://localhost:<debugging-port>/devtools/page/<id>). Le websocket peut être utilisé pour interagir avec la page en utilisant le protocole DevTools.

Cette propriété a été introduite dans QtWebEngine 6.6.

devToolsView : WebEngineView [since QtWebEngine 1.7]

La vue qui héberge actuellement les outils de développement de cette vue. La définir à une nouvelle vue naviguera cette vue vers une URL interne avec les outils de développement, et la liera à cette vue.

Cette propriété a été introduite dans QtWebEngine 1.7.

Voir aussi inspectedView.

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

L'historique de navigation de la vue actuelle.

Cette propriété a été introduite dans QtWebEngine 1.1.

Voir aussi WebEngineHistory.

icon : url [read-only]

URL interne permettant d'accéder à l'icône du site web actuellement affichée, également appelée favicon ou icône de raccourci. Cette URL en lecture seule correspond à l'image utilisée dans un navigateur mobile pour représenter une page marquée d'un signet sur l'écran d'accueil de l'appareil.

L'extrait suivant utilise la propriété icon pour construire un composant Image:

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

La spécification de la propriété Image::sourceSize informe le fournisseur de favicon Qt WebEngine de la taille demandée et redimensionne l'icône en conséquence. Si la propriété Image::sourceSize n'est pas spécifiée, le fournisseur fournit l'icône avec la plus grande résolution disponible.

inspectedView : WebEngineView [since QtWebEngine 1.7]

La vue que cette vue est en train d'inspecter, le cas échéant. La définition de cette propriété permet de naviguer vers une URL interne avec les outils de développement de la vue définie.

Il est recommandé de désactiver cette propriété lorsque les outils de développement ne sont pas visibles, sinon certaines informations de débogage peuvent apparaître dans la vue inspectée WebEngineView.

Cette propriété a été introduite dans QtWebEngine 1.7.

Voir aussi devToolsView.

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

Renvoie true si la vue Web est en mode plein écran, false sinon.

Cette propriété a été introduite dans QtWebEngine 1.1.

Voir aussi fullScreenRequested() et fullScreenCancelled().

lifecycleState : LifecycleState [since QtWebEngine 1.10]

L'état actuel du cycle de vie de la page.

Les restrictions suivantes sont appliquées par le setter :

• Une page visible doit rester dans l'état Active.
• Si la page est inspectée par un site devToolsView, les deux pages doivent rester dans l'état Active.
• Une page dans l'état Discarded ne peut que passer à l'état Active. Cela entraînera un rechargement de la page.

Ce sont les seules limites strictes sur l'état du cycle de vie, mais voir aussi recommendedState pour les limites douces recommandées.

Cette propriété a été introduite dans QtWebEngine 1.10.

Voir aussi recommendedState, Page Lifecycle API, et WebEngine Lifecycle Example.

loadProgress : int [read-only]

La quantité de données de la page qui a été chargée, exprimée sous la forme d'un pourcentage entier compris entre 0 et 100.

loading : bool [read-only]

Renvoie true si la page HTML est en cours de chargement, false sinon.

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

Cadre principal, de premier niveau, de la page. Tous les autres cadres de cette page sont accessibles en tant qu'enfants du cadre principal.

Cette propriété a été introduite dans QtWebEngine 6.8.

profile : WebEngineProfile [since QtWebEngine 1.1]

Le profil actuel utilisé pour la vue.

Cette propriété a été introduite dans QtWebEngine 1.1.

Voir aussi WebEngineProfile.

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

Renvoie l'état sonore de la page en cours (l'audio a été joué récemment ou non).

Cette propriété a été introduite dans QtWebEngine 1.3.

Voir aussi audioMuted et recentlyAudibleChanged.

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

Limite recommandée pour l'état du cycle de vie de la page.

La définition de l'état du cycle de vie à un niveau d'utilisation des ressources inférieur à l'état recommandé peut entraîner des effets secondaires tels que l'arrêt de la lecture audio en arrière-plan ou la perte de la saisie des formulaires HTML. Définir l'état du cycle de vie à un état d'utilisation des ressources plus élevé est cependant totalement sûr.

Cette propriété a été introduite dans QtWebEngine 1.10.

Voir aussi lifecycleState, Page Lifecycle API, et WebEngine Lifecycle Example.

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

Renvoie l'ID de processus (PID) du processus de rendu affecté au cadre principal de la page actuelle.

Si aucun processus de rendu n'est encore disponible, 0 est renvoyé.

Cette propriété a été introduite dans QtWebEngine 1.11.

Voir aussi renderProcessPidChanged.

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

Position de défilement du contenu de la page.

Cette propriété a été introduite dans QtWebEngine 1.3.

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

Paramètres utilisés par cette vue.

Cette propriété a été introduite dans QtWebEngine 1.1.

Voir aussi WebEngineSettings.

title : string [read-only]

Titre de la page HTML actuellement affichée. Il s'agit d'une valeur en lecture seule qui reflète le contenu de la balise <title>.

touchHandleDelegate : Component [since QtWebEngine 6.4]

Le site touchHandleDelegate fournit un modèle définissant des poignées tactiles visuelles instanciées par la vue chaque fois que la gestion de la sélection tactile est requise.

La position, l'opacité et la visibilité de la poignée sont mises à jour automatiquement. Le délégué doit être un élément QML ou tout type QML qui en hérite.

Le code suivant utilise un délégué de poignée tactile personnalisé :

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

Les poignées tactiles peuvent également être changées dynamiquement :

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

Cette propriété a été introduite dans QtWebEngine 6.4.

url : url

Emplacement de la page HTML actuellement affichée. Cette propriété inscriptible offre l'interface principale pour charger une page dans une vue web. Elle fonctionne de la même manière que la propriété DOM window.location.

Voir également loadHtml().

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

La collection de scripts utilisateur associée à la vue.

Cette propriété a été introduite dans QtWebEngine 1.1.

Voir aussi WebEngineScriptCollection.

webChannel : QQmlWebChannel [since QtWebEngine 1.1]

L'instance de canal web utilisée par cette vue. Ce canal utilise automatiquement le mécanisme de transport interne QtWebEngine sur Chromium IPC, et est exposé dans le contexte javascript de la page qu'il rend en tant que qt.webChannelTransport. Cet objet de transport est utilisé lors de l'instanciation de la contrepartie JavaScript de QWebChannel à l'aide de l'API JavaScriptQt WebChannel .

Cette propriété a été introduite dans QtWebEngine 1.1.

webChannelWorld : int [since QtWebEngine 1.3]

Monde JavaScript dans lequel est installée l'instance de canal web utilisée par cette vue. Le monde doit être un nombre compris entre 0 et 256.

Cette propriété a été introduite dans QtWebEngine 1.3.

zoomFactor : real [since QtWebEngine 1.1]

Facteur de zoom pour la vue. Les valeurs valides sont comprises entre 0.25 et 5.0. Le facteur par défaut est 1.0.

Cette propriété a été introduite dans QtWebEngine 1.1.

Documentation sur le signal

[since QtWebEngine 1.2] activeFocusOnPressChanged(bool activeFocusOnPress)

Ce signal est émis lorsque la valeur de activeFocusOnPress change. Il indique si la vue doit être mise au premier plan lorsqu'on appuie dessus.

Ce signal a été introduit dans QtWebEngine 1.2.

Voir aussi activeFocusOnPress et setActiveFocusOnPress().

[since QtWebEngine 1.3] audioMutedChanged(bool muted)

Ce signal est émis lorsque la valeur de muted change. La valeur est spécifiée à l'aide de la propriété audioMuted.

Ce signal a été introduit dans QtWebEngine 1.3.

Voir aussi audioMuted et recentlyAudibleChanged.

[since QtWebEngine 1.4] authenticationDialogRequested(AuthenticationDialogRequest request)

Ce signal est émis lorsqu'un dialogue d'authentification est demandé.

Le signal request peut être traité en utilisant les méthodes du type AuthenticationDialogRequest.

Ce signal a été introduit dans QtWebEngine 1.4.

[since QtWebEngine 1.2] backgroundColorChanged()

Ce signal est émis lorsque la couleur d'arrière-plan de la vue du moteur web change.

Ce signal a été introduit dans QtWebEngine 1.2.

[since QtWebEngine 1.1] certificateError(WebEngineCertificateError error)

Ce signal est émis lorsqu'une erreur de certificat invalide, error, est soulevée lors du chargement d'une requête donnée.

L'erreur de certificat peut être gérée en utilisant les méthodes du type WebEngineCertificateError.

Ce signal a été introduit dans QtWebEngine 1.1.

[since QtWebEngine 1.4] colorDialogRequested(ColorDialogRequest request)

Ce signal est émis lorsqu'une boîte de dialogue de sélection des couleurs est demandée.

Le signal request peut être traité en utilisant les méthodes du type ColorDialogRequest.

Ce signal a été introduit dans QtWebEngine 1.4.

[since QtWebEngine 1.4] contextMenuRequested(ContextMenuRequest request)

Ce signal est émis lorsqu'un menu contextuel est demandé.

Le signal request peut être géré en utilisant les propriétés du type ContextMenuRequest.

Ce signal a été introduit dans QtWebEngine 1.4.

[since QtWebEngine 6.7] desktopMediaRequested(webEngineDesktopMediaRequest request)

Ce signal est émis lorsqu'une application web demande l'accès au contenu d'un écran.

L'argument request contient des références aux modèles de données pour les fenêtres et les écrans disponibles pour la capture. Pour accepter la demande, le gestionnaire du signal peut appeler webEngineDesktopMediaRequest::selectScreen() ou webEngineDesktopMediaRequest::selectWindow().

Ce signal a été introduit dans QtWebEngine 6.7.

[since QtWebEngine 1.4] fileDialogRequested(FileDialogRequest request)

Ce signal est émis lorsqu'une boîte de dialogue de sélection de fichiers est demandée.

Le signal request peut être traité en utilisant les méthodes du type FileDialogRequest.

Ce signal a été introduit dans QtWebEngine 1.4.

[since QtWebEngine 1.10] findTextFinished(findTextResult result)

Ce signal est émis lorsqu'une recherche de chaîne de caractères sur une page est terminée. result est le résultat de la recherche de chaîne de caractères.

Ce signal a été introduit dans QtWebEngine 1.10.

Voir aussi findText() et findTextResult.

[since QtWebEngine 1.1] fullScreenRequested(FullScreenRequest request)

Ce signal est émis lorsque la page web émet l'adresse request pour le mode plein écran par l'intermédiaire de l'API JavaScript.

Ce signal a été introduit dans QtWebEngine 1.1.

Voir aussi isFullScreen.

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

Ce signal est émis chaque fois que le document souhaite modifier la position et la taille de la page à l'adresse frameGeometry. Cela peut se produire, par exemple, par le biais de JavaScript.

Alors que frameGeometry inclut, geometry exclut la taille des marges du cadre.

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

Ce signal a été introduit dans QtWebEngine 1.7.

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

Ce signal est émis lorsqu'un programme JavaScript tente d'imprimer une adresse message sur la console du navigateur web.

Par exemple, en cas d'erreur d'évaluation, l'URL source peut être fournie dans sourceID ainsi que dans lineNumber.

level indique la gravité de l'événement qui a déclenché le message, c'est-à-dire s'il a été déclenché par une erreur ou un événement moins grave.

Si aucun gestionnaire n'est spécifié, la vue enregistre les messages dans un fichier js logging category .

Voir également Console Logging.

[since QtWebEngine 1.4] javaScriptDialogRequested(JavaScriptDialogRequest request)

Ce signal est émis lorsqu'un dialogue JavaScript est demandé.

Le signal request peut être traité en utilisant les méthodes du type JavaScriptDialogRequest.

Ce signal a été introduit dans QtWebEngine 1.4.

linkHovered(url hoveredUrl)

Dans une interface pilotée par la souris, ce signal est émis lorsque le pointeur de la souris passe au-dessus d'un lien, ce qui correspond à l'événement DOM mouseover. Cet événement peut également se produire dans les interfaces tactiles pour les événements mouseover qui ne sont pas annulés par preventDefault(). hoveredUrl fournit l'emplacement du lien.

loadingChanged(WebEngineLoadingInfo loadingInfo)

Ce signal est émis lorsque le chargement d'une page commence, se termine ou échoue.

Lors du traitement du signal avec onLoadingChanged, divers paramètres en lecture seule sont disponibles sur le WebEngineLoadingInfo spécifié par loadingInfo.

Voir également loading, LoadStatus, et ErrorDomain.

navigationRequested(WebEngineNavigationRequest request)

Ce signal est émis lorsque la demande de navigation request est émise.

[since QtWebEngine 2.0] newWindowRequested(WebEngineNewWindowRequest request)

Ce signal est émis lorsque request est utilisé pour charger une page dans une vue distincte du moteur web. Cela peut être dû au fait que la page actuelle l'a demandé explicitement par le biais d'un appel JavaScript à window.open, ou parce que l'utilisateur a cliqué sur un lien tout en maintenant Shift, Cmd/Ctrl, ou une combinaison intégrée qui déclenche l'ouverture de la page dans une nouvelle fenêtre.

Le signal est traité en appelant acceptAsNewWindow() sur la vue de destination. Si ce signal n'est pas traité, le chargement demandé échouera.

Exemple de mise en œuvre :

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);
            }
        }
    }
}

Ce signal a été introduit dans QtWebEngine 2.0.

Voir aussi WebEngineNewWindowRequest et WebEngine Quick Nano Browser.

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

Ce signal est émis lorsque l'impression de la page web dans un fichier PDF est terminée. filePath contiendra le chemin d'accès au fichier dont la création a été demandée, et success sera true si le fichier a été créé avec succès et false dans le cas contraire.

Ce signal a été introduit dans QtWebEngine 1.5.

Voir aussi printToPdf().

[since QtWebEngine 6.8] permissionRequested(webEnginePermission permission)

Ce signal est émis lorsqu'un site web envoie une demande d'autorisation (par exemple, accès à la géolocalisation, autorisation d'envoyer des notifications). L'objet permission peut être interrogé pour connaître l'URL requérante et le WebEnginePermission.PermissionType qu'elle demande, ainsi que pour accorder ou refuser la permission.

Ce signal a été introduit dans QtWebEngine 6.8.

[since QtWebEngine 1.8] printRequested()

Ce signal est émis lorsque la méthode JavaScript window.print() est appelée dans le cadre principal, ou lorsque l'utilisateur a appuyé sur le bouton d'impression du plugin de visualisation PDF. Généralement, le gestionnaire du signal peut simplement appeler printToPdf().

Depuis QtWebEngine 6.8, ce signal n'est émis que pour le cadre principal, au lieu d'être émis pour tout cadre demandant une impression.

Ce signal a été introduit dans QtWebEngine 1.8.

Voir aussi printToPdf.

[since QtWebEngine 6.8] printRequestedByFrame(webEngineFrame frame)

Ce signal est émis lorsque la méthode JavaScript window.print() est appelée sur frame. Si le cadre est le cadre principal, le signal printRequested est émis à la place.

Ce signal a été introduit dans QtWebEngine 6.8.

Voir aussi printRequested.

[since QtWebEngine 1.3] recentlyAudibleChanged(bool recentlyAudible)

Ce signal est émis lorsque l'état audible de la page, spécifié par recentlyAudible, est modifié en raison de la lecture ou de l'arrêt d'un fichier audio.

Si une page web contient deux vidéos lancées en séquence, ce signal n'est émis qu'une seule fois, pour que la première vidéo génère du son. Après l'arrêt des deux vidéos, le signal est émis au moment où le dernier son est généré. Cela signifie que le signal est émis à la fois lorsqu'un son est généré et lorsque tout devient complètement silencieux, quel que soit le nombre de flux audio.

Des émissions de signaux parasites peuvent également se produire. Par exemple, lorsque le son est arrêté, ce signal est émis d'abord avec une valeur de true, puis avec une valeur de false. De plus, lorsque l'audio commence à jouer, le signal est émis deux fois avec une valeur de true.

Ce signal a été introduit dans QtWebEngine 1.3.

Voir aussi recentlyAudible.

[since QtWebEngine 1.7] registerProtocolHandlerRequested(registerProtocolHandlerRequest request)

Ce signal est émis lorsque la page web tente d'enregistrer un protocole personnalisé en émettant un signal registerProtocolHandler request.

Ce signal a été introduit dans QtWebEngine 1.7.

Voir aussi registerProtocolHandlerRequest.

[since QtWebEngine 1.11] renderProcessPidChanged(qint64 pid)

Si aucun processus de rendu n'est encore disponible, 0 est renvoyé. Ce signal est émis lorsque pid (ID du processus) du processus de rendu sous-jacent de la page a changé.

Ce signal a été introduit dans QtWebEngine 1.11.

Voir aussi renderProcessPid.

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

Ce signal est émis lorsque le processus de rendu se termine avec un état de sortie non nul. terminationStatus est l'état de fin du processus et exitCode est le code d'état avec lequel le processus s'est terminé.

Ce signal a été introduit dans QtWebEngine 1.2.

Voir aussi RenderProcessTerminationStatus.

[since QtWebEngine 1.9] selectClientCertificate(WebEngineClientCertificateSelection clientCertificateSelection)

Ce signal est émis lorsqu'un site web demande un certificat client SSL et qu'un ou plusieurs ont été trouvés dans le magasin de certificats clients du système.

Le traitement de ce signal est asynchrone et le chargement sera en attente jusqu'à ce qu'un certificat soit sélectionné ou que la dernière copie de clientCertificateSelection soit détruite.

Si le signal n'est pas traité, clientCertificateSelection est automatiquement détruit et le chargement se poursuit sans certificat client.

Ce signal a été introduit dans QtWebEngine 1.9.

Voir aussi WebEngineClientCertificateSelection.

[since QtWebEngine 1.10] tooltipRequested(TooltipRequest request)

Ce signal est émis lorsque la page web envoie un message request pour afficher une infobulle à une position spécifiée.

Ce signal a été introduit dans QtWebEngine 1.10.

Voir aussi TooltipRequest.

[since QtWebEngine 6.3] touchSelectionMenuRequested(TouchSelectionMenuRequest request)

Ce signal est émis lorsqu'un menu de sélection tactile est demandé à une position spécifiée.

Le signal request peut être traité en utilisant les méthodes du type TouchSelectionMenuRequest.

Ce signal a été introduit dans QtWebEngine 6.3.

Voir aussi TouchSelectionMenuRequest.

[since QtWebEngine 1.3] wasRecentlyAudibleChanged(bool wasRecentlyAudible)

Ce signal est émis lorsque l'état audible de la page, spécifié par wasRecentlyAudible, est modifié en raison de la lecture ou de l'arrêt d'un fichier audio.

Ce signal a été introduit dans QtWebEngine 1.3.

[since QtWebEngine 6.7] webAuthUxRequested(WebEngineWebAuthUxRequest request)

Ce signal est émis lorsqu'un authentificateur WebAuth nécessite une interaction avec l'utilisateur au cours du processus d'authentification. Ces demandes sont traitées en affichant une boîte de dialogue à l'utilisateur.

L'objet request contient les informations et l'API nécessaires pour compléter la demande WebAuth UX.

Ce signal a été introduit dans QtWebEngine 6.7.

Voir aussi WebEngineWebAuthUxRequest.

[since QtWebEngine 1.2] windowCloseRequested()

Ce signal est émis lorsque la page demande la fermeture de la fenêtre du navigateur web, par exemple par l'intermédiaire de l'appel JavaScript window.close().

Ce signal a été introduit dans QtWebEngine 1.2.

[since QtWebEngine 6.8] zoomFactorChanged(qreal factor)

Ce signal est émis lorsque le zoom factor de la page change.

Ce signal a été introduit dans QtWebEngine 6.8.

Voir aussi zoomFactor.

Documentation de la méthode

[since QtWebEngine 2.0] void acceptAsNewWindow(WebEngineNewWindowRequest request)

Traite le signal newWindowRequested en ouvrant le site request dans cette vue.

Cette méthode a été introduite dans QtWebEngine 2.0.

Voir aussi newWindowRequested.

WebEngineAction action(WebAction action)

Renvoie une adresse WebEngineAction pour l'adresse WebAction spécifiée action. WebEngineView se charge également de la mise en œuvre de l'action, de sorte qu'au moment du déclenchement, l'action correspondante est exécutée sur la vue.

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

Voir aussi WebEngineAction.

[since QtWebEngine 6.8] webEngineFrame findFrameByName(string name)

Renvoie le cadre portant le nom name. S'il existe plusieurs images portant le même nom, le choix de l'image renvoyée est arbitraire. Si aucun cadre n'a été trouvé, un cadre invalid est renvoyé.

Cette méthode a été introduite dans QtWebEngine 6.8.

[since QtWebEngine 1.1] void findText(string subString)

Recherche la chaîne spécifiée, subString, dans la page. Le signal findTextFinished() est émis lorsqu'une recherche de chaîne est terminée.

Pour effacer la mise en évidence de la recherche, il suffit de passer une chaîne vide.

Cette méthode a été introduite dans QtWebEngine 1.1.

Voir aussi findTextFinished().

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

Recherche la chaîne spécifiée, subString, dans la page, à l'aide de l'adresse options. Le signal findTextFinished() est émis lorsqu'une recherche de chaîne est terminée.

Pour effacer la mise en évidence de la recherche, il suffit de passer une chaîne vide.

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

Cette méthode a été introduite dans QtWebEngine 1.1.

Voir aussi findTextFinished().

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

Recherche la chaîne spécifiée, subString, dans la page, à l'aide de l'adresse options. Le signal findTextFinished() est émis lorsqu'une recherche de chaîne est terminée.

Pour effacer la mise en évidence de la recherche, il suffit de passer une chaîne vide.

La commande resultCallback doit prendre un paramètre entier. Il sera appelé avec le nombre d'occurrences trouvées de la chaîne subString.

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

Cette méthode a été introduite dans QtWebEngine 1.1.

Voir aussi findTextFinished().

[since QtWebEngine 1.1] void fullScreenCancelled()

Définit immédiatement la propriété isFullScreen à false. Elle peut être utilisée pour notifier le moteur du navigateur lorsque le système de fenêtrage force l'application à quitter le mode plein écran.

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

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

Cette méthode a été introduite dans QtWebEngine 1.1.

Voir aussi isFullScreen et fullScreenRequested().

void goBack()

Retourner en arrière dans l'historique de la session du navigateur, si possible. Cette fonction est équivalente à la méthode window.history.back() DOM.

Voir également canGoBack.

[since QtWebEngine 1.1] void goBackOrForward(int offset)

Si offset est positif, il avance du nombre spécifié de pages de décalage dans l'historique de la session en cours. Si le décalage est négatif, il revient en arrière. Si le décalage n'est pas valide, la page n'est pas modifiée.

Cette méthode a été introduite dans QtWebEngine 1.1.

Voir aussi goBack() et goForward().

void goForward()

Avancer dans l'historique de la session du navigateur, si possible. Cette fonction est équivalente à la méthode window.history.forward() DOM.

void loadHtml(string html, url baseUrl)

Charge le site html spécifié en tant que contenu de la vue Web.

Cette méthode offre une alternative de niveau inférieur à la propriété url, qui référence les pages HTML via l'URL.

baseUrl est facultatif et utilisé pour résoudre les URL relatives dans le document, telles que les images ou les feuilles de style référencées. Par exemple, si html est récupéré à partir de http://www.example.com/documents/overview.html, qui est l'URL de base, une image référencée avec l'URL relative, diagram.png, devrait se trouver à http://www.example.com/documents/diagram.png.

Lorsqu'il utilise cette méthode, le moteur web suppose que les ressources externes, telles que les programmes JavaScript ou les feuilles de style, sont codées en UTF-8, sauf indication contraire. Par exemple, le codage d'un script externe peut être spécifié par l'attribut charset de la balise HTML script. Il est également possible que l'encodage soit spécifié par le serveur web.

Voir aussi url.

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

Imprime le contenu actuel de WebEngineView dans un document PDF et le stocke sous filePath. La taille du document sera déterminée par la valeur de pageSizeId et son orientation sera déterminée à l'aide de orientation.

Cette méthode émet une requête asynchrone pour l'impression de la page web en PDF et renvoie immédiatement. Pour être informé du résultat de la demande, connectez-vous au signal pdfPrintingFinished().

Si vous omettez pageSizeId, la valeur par défaut est A4. Si vous omettez orientation, la valeur par défaut est Portrait.

Cette méthode a été introduite dans QtWebEngine 1.3.

Voir aussi pdfPrintingFinished().

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

Imprime le contenu actuel de WebEngineView dans un document PDF et le renvoie dans un tableau d'octets. La taille du document sera déterminée par la valeur de pageSizeId et son orientation sera déterminée à l'aide de orientation.

Le paramètre resultCallback doit être une chaîne de caractères. Cette chaîne contiendra les données du document en cas d'impression réussie et une chaîne vide dans le cas contraire.

Si vous omettez pageSizeId, la valeur par défaut est A4. Si vous omettez orientation, la valeur par défaut est Portrait.

Cette méthode a été introduite dans QtWebEngine 1.3.

void reload()

Recharge la page en cours. Cette fonction est équivalente à la méthode DOM window.location.reload().

Voir aussi reloadAndBypassCache().

[since QtWebEngine 1.1] void reloadAndBypassCache()

Recharge la page courante, en ignorant tout contenu mis en cache.

Cette méthode a été introduite dans QtWebEngine 1.1.

Voir aussi reload().

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

Remplace le mot mal orthographié actuel par replacement.

Cette méthode a été introduite dans QtWebEngine 1.3.

Exécute l'adresse script spécifiée dans le contenu de la vue Web.

Le paramètre callback est facultatif. Si une fonction de rappel est fournie, elle sera invoquée à la fin de l'exécution du script.

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

Seules des données simples peuvent être renvoyées par JavaScript en tant que valeur de résultat. Les types de données pris en charge comprennent tous les types de données JSON ainsi que, par exemple, Date et ArrayBuffer. Les types de données non pris en charge sont, par exemple, Function et Promise.

Pour éviter les conflits avec d'autres scripts exécutés sur la page, le monde dans lequel le script est exécuté peut être spécifié par worldId. L'ID du monde doit être compris entre 0 et 256. Si vous omettez l'ID world, le script est exécuté dans le monde MainWorld.

Pour plus d'informations sur l'injection de scripts, voir Injection de scripts. Pour une autre façon d'injecter des scripts, voir WebEngineView::userScripts.

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

Enregistre la page web actuelle sur le disque.

La page web est enregistrée à l'adresse filePath dans l'emplacement spécifié format.

Il s'agit d'un raccourci pour les actions suivantes :

• Déclencher l'action Enregistrer la page web.
• Accepter l'élément de téléchargement suivant et définir le chemin d'accès au fichier et le format d'enregistrement spécifiés.

Cette fonction émet une demande de téléchargement asynchrone pour la page web et renvoie immédiatement.

Cette méthode a été introduite dans QtWebEngine 6.6.

Voir aussi WebEngineDownloadRequest::savePageFormat.

[since QtWebEngine 1.2] void setActiveFocusOnPress(bool arg)

Attribue le focus actif à une vue du moteur web cliquée si arg est true. En le définissant sur false, une vue du moteur web peut être utilisée pour créer un élément de l'interface utilisateur qui ne doit pas recevoir le focus. Cela peut être utile dans une interface utilisateur hybride.

Cette méthode a été introduite dans QtWebEngine 1.2.

Voir aussi activeFocusOnPress, activeFocusOnPressChanged, et WebEngineSettings::focusOnNavigationEnabled.

void stop()

Arrête le chargement de la page en cours.

[since QtWebEngine 1.2] void triggerWebAction(WebAction action)

Déclenche l'action web action.

Cette méthode a été introduite dans QtWebEngine 1.2.

Voir aussi WebAction.