<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qwebengineurlschemehandler.cpp --> <title>QWebEngineUrlSchemeHandler Class | Qt WebEngine 5.9</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.9</td><td ><a href="qtwebengine-index.html">Qt WebEngine</a></td><td ><a href="qtwebengine-modules.html">C++ Classes</a></td><td >QWebEngineUrlSchemeHandler</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QWebEngineUrlSchemeHandler Class</h1> <!-- $$$QWebEngineUrlSchemeHandler-brief --> <p>The <a href="qwebengineurlschemehandler.html">QWebEngineUrlSchemeHandler</a> is a base class for handling custom URL schemes. <a href="#details">More...</a></p> <!-- @@@QWebEngineUrlSchemeHandler --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWebEngineUrlSchemeHandler></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.6</td></tr></table></div><ul> <li><a href="qwebengineurlschemehandler-members.html">List of all members, including inherited members</a></li> </ul> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwebengineurlschemehandler.html#QWebEngineUrlSchemeHandler">QWebEngineUrlSchemeHandler</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwebengineurlschemehandler.html#dtor.QWebEngineUrlSchemeHandler">~QWebEngineUrlSchemeHandler</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qwebengineurlschemehandler.html#requestStarted">requestStarted</a></b>(QWebEngineUrlRequestJob *<i>request</i>) = 0</td></tr> </table></div> <a name="details"></a> <!-- $$$QWebEngineUrlSchemeHandler-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qwebengineurlschemehandler.html">QWebEngineUrlSchemeHandler</a> is a base class for handling custom URL schemes.</p> <p>To implement a custom URL scheme for <a href="qtwebengine-module.html">QtWebEngine</a>, you must write a class derived from this class, and reimplement <a href="qwebengineurlschemehandler.html#requestStarted">requestStarted</a>(). Then install it via <a href="qwebengineprofile.html#installUrlSchemeHandler">QWebEngineProfile::installUrlSchemeHandler</a>() or <a href="qquickwebengineprofile.html#installUrlSchemeHandler">QQuickWebEngineProfile::installUrlSchemeHandler</a>().</p> </div> <!-- @@@QWebEngineUrlSchemeHandler --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QWebEngineUrlSchemeHandler[overload1]$$$QWebEngineUrlSchemeHandlerQObject* --> <h3 class="fn" id="QWebEngineUrlSchemeHandler"><a name="QWebEngineUrlSchemeHandler"></a>QWebEngineUrlSchemeHandler::<span class="name">QWebEngineUrlSchemeHandler</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3> <p>Constructs a new URL scheme handler.</p> <p>The handler is created with the parent <i>parent</i>.</p> <!-- @@@QWebEngineUrlSchemeHandler --> <!-- $$$~QWebEngineUrlSchemeHandler[overload1]$$$~QWebEngineUrlSchemeHandler --> <h3 class="fn" id="dtor.QWebEngineUrlSchemeHandler"><a name="dtor.QWebEngineUrlSchemeHandler"></a>QWebEngineUrlSchemeHandler::<span class="name">~QWebEngineUrlSchemeHandler</span>()</h3> <p>Deletes a custom URL scheme handler.</p> <!-- @@@~QWebEngineUrlSchemeHandler --> <!-- $$$requestStarted[overload1]$$$requestStartedQWebEngineUrlRequestJob* --> <h3 class="fn" id="requestStarted"><a name="requestStarted"></a><code>[pure virtual] </code><span class="type">void</span> QWebEngineUrlSchemeHandler::<span class="name">requestStarted</span>(<span class="type"><a href="qwebengineurlrequestjob.html">QWebEngineUrlRequestJob</a></span> *<i>request</i>)</h3> <p>This method is called whenever a request <i>request</i> for the registered scheme is started.</p> <p>This method must be reimplemented by all custom URL scheme handlers. The request is asynchronous and does not need to be handled right away.</p> <p><b>See also </b><a href="qwebengineurlrequestjob.html">QWebEngineUrlRequestJob</a>.</p> <!-- @@@requestStarted --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. </p> </div> </body> </html>