QWebEngineUrlSchemeHandler Class | Qt WebEngine 5.10

Qt 5.10 | Qt WebEngine | C++ Classes | QWebEngineUrlSchemeHandler

Qt 5.10.1 Reference Documentation

# QWebEngineUrlSchemeHandler Class

The QWebEngineUrlSchemeHandler is a base class for handling custom URL schemes. More...

Header: | #include <QWebEngineUrlSchemeHandler>
Since: | Qt 5.6
Inherits: | QObject

- List of all members, including inherited members

## Public Functions

| QWebEngineUrlSchemeHandler(QObject *parent = Q_NULLPTR)
| ~QWebEngineUrlSchemeHandler()
virtual void | requestStarted(QWebEngineUrlRequestJob *request) = 0

- 32 public functions inherited from QObject

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 2 signals inherited from QObject
- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 9 protected functions inherited from QObject
- 2 protected variables inherited from QObject

## Detailed Description

The QWebEngineUrlSchemeHandler is a base class for handling custom URL schemes.

To implement a custom URL scheme for QtWebEngine, you must write a class derived from this class, and reimplement requestStarted(). Then install it via QWebEngineProfile::installUrlSchemeHandler() or QQuickWebEngineProfile::installUrlSchemeHandler().

## Member Function Documentation

### QWebEngineUrlSchemeHandler::QWebEngineUrlSchemeHandler(QObject *parent = Q_NULLPTR)

Constructs a new URL scheme handler.

The handler is created with the parent parent.

### QWebEngineUrlSchemeHandler::~QWebEngineUrlSchemeHandler()

Deletes a custom URL scheme handler.

### `[pure virtual]` void QWebEngineUrlSchemeHandler::requestStarted(QWebEngineUrlRequestJob *request)

This method is called whenever a request request for the registered scheme is started.

This method must be reimplemented by all custom URL scheme handlers. The request is asynchronous and does not need to be handled right away.

See also QWebEngineUrlRequestJob.