TooltipRequest QML Type | Qt WebEngine 6.8.0
Description: A request for showing a tooltip to the user.

- Qt 6.8
- Qt WebEngine
- QML Types
- TooltipRequest
- Qt 6.8.0 Reference Documentation

# TooltipRequest QML Type

A request for showing a tooltip to the user. More...

Import Statement: | import QtWebEngine
Since: | QtWebEngine 1.10

- List of all members, including inherited members

## Properties

- accepted : bool
- text : bool
- type : enumeration
- x : int
- y : int

## Detailed Description

A TooltipRequest is a request object that is passed as a parameter of the WebEngineView::tooltipRequested signal. Use the `onTooltipRequested` signal handler to handle requests for custom tooltip menus at specific positions.

The accepted property of the request indicates whether the request is handled by the user code or the default tooltip should be displayed.

The following code uses a custom tooltip to handle the request:

     WebEngineView {
         // ...
         onTooltipRequested: function(request) {
             if (request.type == TooltipRequest.Show) {
                 tooltip.visible = true;
                 tooltip.x = request.x;
                 tooltip.y = request.y;
                 tooltip.text = request.text;
             } else {
                 tooltip.visible = false;
             }
             request.accepted = true;
         }
         // ...
     }

## Property Documentation

accepted : bool

Indicates whether the tooltip request has been accepted by the signal handler.

If the property is `false` after any signal handlers for WebEngineView::tooltipRequested have been executed, a default tooltip will be shown. To prevent this, set `request.accepted` to `true`.

The default is `false`.

text : bool `[read-only]`

The text of the tooltip. It contains an empty string when the tooltip should be hidden.

type : enumeration `[read-only]`

The type of the tooltip request.

Constant | Description
--- | ---
`TooltipRequest.Show` | The tooltip should be shown.
`TooltipRequest.Hide` | The tooltip should be hidden.

x : int `[read-only]`

The x coordinate of the top-left corner of the requested tooltip.

y : int `[read-only]`

The y coordinate of the top-left corner of the requested tooltip.