Typedef for QFlags<FindFlag>. Refer to QWebPage::FindFlag for documentation.

This enum describes the domain of an ErrorPageExtensionOption object, for example the layer in which the error occurred.

See also

QNetworkRequest::Attribute

This enum describes the types of extensions that the page can support. Before using these extensions, you should verify that the extension is supported by calling supportsExtension().

See also

ChooseMultipleFilesExtensionOption, ChooseMultipleFilesExtensionReturn, ErrorPageExtensionOption, ErrorPageExtensionReturn

This enum describes the elements of a web page is has permission to access.

This enum describes the options available for the findText() method. The options can be OR-ed together from the following list.

This enum defines the delegation policies a webpage can have when activating links and emitting the linkClicked() signal.

See also

QWebPage::linkDelegationPolicy

This enum describes the types of navigation available when browsing through hyperlinked documents.

See also

acceptNavigationRequest()

This enum

This enum describes the types of action which can be performed on the web page. Actions only have an effect when they are applicable. The availability of actions can be determined by checking isEnabled() on the action returned by action().

One method of enabling the text editing, cursor movement, and text selection actions is by setting contentEditable to true.

This enum describes the types of window that can be created by the createWindow() function.

Constructs an empty QWebPage with the given parent.

Destroys the web page.

This method is called whenever WebKit wants to display the given request in the specified frame with the navigation type. If the frame is a null pointer then navigation to a new window is requested. If the request is accepted createWindow() will be called.

The default implementation interprets the page's linkDelegationPolicy and emits linkClicked accordingly or returns true to let QWebPage handle the navigation itself.

See also

createWindow()

Returns a QAction for the given action. The action is owned by the QWebPage but you can customize the look by changing its properties. QWebPage also takes care of implementing the action, so that upon triggering the corresponding action is performed on the page.

See also

triggerAction()

This signal is emitted whenever the web site is asking to store data to the application cache specified by origin and the defaultOriginQuota allocated to that web site is exceeded.

Returns the number of bytes that were received from the network to render the current page.

See also

totalBytes(), loadProgress()

This function is called when the web content requests a file name, for example as a result of the user clicking on a "file upload" button in a HTML form. A suggested filename may be provided in suggestedFile. The frame originating the request is provided as frame.

See also

QWebPage::Extension

This signal is emitted whenever the text in form elements changes as well as other editable content.

See also

contentEditable, modified, QWebFrame::toHtml(), QWebFrame::toPlainText()

This function is called whenever WebKit encounters an HTML object element with type "application/x-qt-plugin". It is called regardless of the value of QWebSettings::PluginsEnabled. The classid, url, paramNames and paramValues correspond to the HTML object element attributes and child elements to configure the embeddable object.

This function creates the standard context menu which is shown when the user clicks on the web page with the right mouse button. It is called from the default contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.

This function is called whenever WebKit wants to create a new window of the given type, for example when a JavaScript program requests to open a document in a new window.

If the new window can be created, the new window's QWebPage is returned, otherwise a null pointer is returned.

If the view associated with the web page is a QWebView object, then the default implementation forwards the request to QWebView's createWindow() function, otherwise it returns a null pointer.

If type is WebModalDialog, the application must call setWindowModality on the new window.

Note

In the cases when the window creation is being triggered by JavaScript, apart from reimplementing this method application must also set the JavaScriptCanOpenWindows attribute of QWebSettings to true in order for it to get called.

See also

acceptNavigationRequest(), QWebView::createWindow()

Returns the frame currently active.

See also

mainFrame(), frameCreated()

This signal is emitted whenever the web site shown in frame is asking to store data to the database databaseName and the quota allocated to that web site is exceeded.

See also

QWebDatabase

This signal is emitted when the user decides to download a link. The url of the link as well as additional meta information is contained in request.

See also

unsupportedContent()

Reimplemented from QObject::event()

This method can be reimplemented in a QWebPage subclass to provide support for extensions. The option argument is provided as input to the extension. The output results can be stored in output. The behavior is determined by extension. Returns true if the extension was called successfully, otherwise returns false.

The given option and output values are typically casted to the corresponding types. For example, ChooseMultipleFilesExtensionOption and ChooseMultipleFilesExtensionReturn for ChooseMultipleFilesExtension. You can call supportsExtension() to check if an extension is supported by the page.

See also

supportsExtension(), Extension

A signal which indicates a permission request has been cancelled.

A signal which indicates a permission request has been made.

Finds the specified subString in the current page using the given options. To clear the selection pass an empty string. Returns true if the subString was found, otherwise returns false.

If the HighlightAllOccurrences flag is passed, the function will highlight all occurrences that exist in the page. All subsequent calls will extend the highlight, rather than replace it, with occurrences of the new string. If the HighlightAllOccurrences flag is not passed, the function will select an occurrence and all subsequent calls will replace the current occurrence with the next one.

Similar to QWidget::focusNextPrevChild() it focuses the next focusable web element if next is true, otherwise the previous element is focused.

Returns true if it can find a new focusable element, or false if it can not.

Returns the frame at the given point pos or a nullptr if there is no frame at that position.

See also

mainFrame(), currentFrame()

This signal is emitted whenever the page creates a new frame.

See also

currentFrame()

This signal is emitted whenever the document wants to change the position and size of the page to geom. This can happen for example through JavaScript.

Returns a pointer to the view's history of navigated web pages.

This method is used by the input method to query a set of properties of the page to be able to support complex input method operations as support for surrounding text and reconversions.

The given property specifies which property is queried.

See also

QWidget::inputMethodEvent(), QInputMethodEvent

This function is called whenever a JavaScript program running inside frame calls the alert() function with the message msg.

The default implementation shows the message, msg, with QMessageBox::information.

This function is called whenever a JavaScript program running inside frame calls the confirm() function with the message, msg. Returns true if the user confirms the message, otherwise returns false.

The default implementation executes the query using QMessageBox::information with QMessageBox::Yes and QMessageBox::No buttons.

This function is called whenever a JavaScript program tries to print a message to the web browser's console. For example in case of evaluation errors the source URL may be provided in sourceID as well as the lineNumber. The default implementation prints nothing.

This function is called whenever a JavaScript program running inside frame tries to prompt the user for input. The program may provide an optional message, msg, as well as a default value for the input in defaultValue.

If the prompt was canceled by the user the implementation should return false, otherwise the result should be written to result and true should be returned. If the prompt was not canceled by the user, the implementation should return true and the result string must not be null.

The default implementation uses QInputDialog::getText().

This signal is emitted whenever the user clicks on a link and the page's linkDelegationPolicy property is set to delegate the link handling for the specified url.

By default no links are delegated and are handled by QWebPage instead.

Note

This signal possibly will not be emitted for clicked links which use JavaScript to trigger navigation.

See also

linkHovered()

This signal is emitted when the mouse hovers over a link.

link contains the link url. title is the link element's title, if it is specified in the markup. textContent provides text within the link element, e.g., text inside an HTML anchor tag.

When the mouse leaves the link element the signal is emitted with empty parameters.

See also

linkClicked()

This signal is emitted when the page finishes loading content. This signal is independent of script execution or page rendering. ok will indicate whether the load was successful or any error occurred.

See also

loadStarted(), QWebPage::Extension

This signal is emitted when the global progress status changes. The current value is provided by progress and scales from 0 to 100, which is the default range of QProgressBar. It accumulates changes from all the child frames.

See also

bytesReceived()

This signal is emitted when a page starts loading content.

See also

loadFinished()

Returns the main frame of the page. The main frame provides access to the hierarchy of sub-frames and is also needed if you want to explicitly render a web page into a given painter.

See also

currentFrame()

This signal is emitted whenever the visibility of the menubar in a web browser window that hosts QWebPage should be changed to visible.

This signal is emitted when for example the position of the cursor in an editable form element changes. It is used to inform input methods about the new on-screen position where the user is able to enter text. This signal is usually connected to the QWidget::updateMicroFocus() slot.

Returns the QNetworkAccessManager that is responsible for serving network requests for this QWebPage.

See also

setNetworkAccessManager()

Returns the QWebPluginFactory that is responsible for creating plugins embedded into this QWebPage. If no plugin factory is installed a null pointer is returned.

See also

setPluginFactory()

Returns the value of the property.

This signal is emitted whenever the page requests the web browser to print frame, for example through the JavaScript window.print() call.

See also

QWebFrame::print(), QPrintPreviewDialog

This signal is emitted whenever this QWebPage should be updated. It's useful when rendering a QWebPage without a QWebView or QGraphicsWebView. dirtyRect contains the area that needs to be updated. To paint the QWebPage get the mainFrame() and call the render(QPainter*, const QRegion&) method with the dirtyRect as the second parameter.

See also

mainFrame(), view()

This signal is emitted when the load of frame is finished and the application may now update its state accordingly.

This signal is emitted shortly before the history of navigated pages in frame is changed, for example when navigating back in the history. The provided QWebHistoryItem, item, holds the history entry of the frame before the change.

A potential use-case for this signal is to store custom data in the QWebHistoryItem associated to the frame, using QWebHistoryItem::setUserData().

This signal is emitted whenever the content given by rect needs to be scrolled dx and dy downwards and no view was set.

See also

view()

This signal is emitted whenever the selection changes, either interactively or programmatically (e.g. by calling triggerAction() with a selection action).

See also

selectedText()

Sets the area for content to the given rect.

Sets the permission for the website displayed in the given frame using the feature and policy.

Sets the QNetworkAccessManager manager responsible for serving network requests for this QWebPage.

Note

It is currently not supported to change the network access manager after the QWebPage has used it. The results of doing this are undefined.

See also

networkAccessManager()

Sets the QWebPluginFactory factory responsible for creating plugins embedded into this QWebPage. The plugin factory is only used if the QWebSettings::PluginsEnabled attribute is enabled.

See also

pluginFactory()

Sets the value of the property to size.

Returns a pointer to the page's settings object.

See also

QWebSettings::globalSettings()

Sets the view that is associated with the web page.

See also

view()

This method is called when a JavaScript program is running for a long period of time. If the user wanted to stop the JavaScript the implementation should return true, otherwise false. The default implementation executes the query using QMessageBox::information with QMessageBox::Yes and QMessageBox::No buttons.

Warning

Because of binary compatibility constraints, this function is not virtual. If you want to provide your own implementation in a QWebPage subclass, reimplement the shouldInterruptJavaScript() slot in your subclass instead. CsWebKit will dynamically detect the slot and call it.

This signal is emitted when the statusbar text is changed by the page.

This signal is emitted whenever the visibility of the statusbar in a web browser window that hosts QWebPage should be changed to visible.

Returns the list of all content types supported by QWebPage.

Returns true if QWebPage can handle the given mimeType, otherwise returns false.

This method returns true if the web page supports extension, otherwise false is returned.

See also

extension()

Filters the context menu event, through handlers for scrollbars and custom event handlers in the web page. Returns true if the event was handled, otherwise false.

A web page may swallow a context menu event through a custom event handler, allowing for context menus to be implemented in HTML/JavaScript. This is used by Google Maps, for example.

This signal is emitted whenever the visibility of the toolbar in a web browser window that hosts QWebPage should be changed to visible.

Returns the total number of bytes that were received from the network to render the current page, including extra content such as embedded images.

See also

bytesReceived()

This method can be called to trigger the specified action. It is also called by CsWebKit if the user triggers the action, for example through a context menu item. If action is a checkable action then checked specified whether the action is toggled or not.

See also

action()

Returns a pointer to the undo stack used for editable content.

See also

modified

This signal is emitted when WebKit can not handle a link the user navigated to or a web server's response includes a "Content-Disposition" header with the 'attachment' directive. If "Content-Disposition" is present in reply, the web server is indicating that the client should prompt the user to save the content regardless of content-type. Refer to RFC 2616 sections 19.5.1 for details about Content-Disposition.

At signal emission time the meta data of the QNetworkReply reply is available.

Note

The receiving slot is responsible for deleting the QNetworkReply the given reply. This signal is only emitted if the forwardUnsupportedContent property is set to true.

See also

downloadRequested()

Updates the page's actions depending on the position pos. For example if pos is over an image element the CopyImageToClipboard action is enabled.

This method is called when a user agent for HTTP requests is needed. You can reimplement this function to dynamically return different user agents for different URLs, based on the url parameter.

The default implementation returns the following value:

"Mozilla/5.0 (Platform%Security%Subplatform%) AppleWebKit/WebKitVersion% (KHTML, like Gecko) AppVersion Safari/WebKitVersion%"

On mobile platforms, "Mobile Safari" is used instead of "Safari".

In this string the following values are replaced at runtime:

• %Platform% expands to the windowing system followed by "; " if it is not Windows (e.g. "X11; ").
• %Security% expands to "N; " if SSL is disabled.
• %Subplatform% expands to the operating system version (e.g. "Windows NT 6.1" or "Intel Mac OS X 10.7").
• %WebKitVersion% is the version of WebKit the application was compiled against.
• %AppVersion% expands to QCoreApplication::applicationName() / QCoreApplication::applicationVersion() if they are set, otherwise it defaults to CopperSpice and the current CopperSpice version.

Returns the view widget that is associated with the web page.

See also

setView()

Computes the optimal viewport configuration given the availableSize, when user interface components are disregarded. The configuration is also dependent on the device screen size which is obtained automatically. For testing purposes the size can be overridden by setting two environment variables QTWEBKIT_DEVICE_WIDTH and QTWEBKIT_DEVICE_HEIGHT, which both needs to be set.

The ViewportAttributes includes a pixel density ratio, which will also be exposed to the web author though the -webkit-pixel-ratio media feature. This is the ratio between 1 density-independent pixel (DPI) and physical pixels.

A density-independent pixel is equivalent to one physical pixel on a 160 DPI screen, so on our platform assumes that as the baseline density.

The conversion of DIP units to screen pixels is quite simple:

pixels = DIPs * (density / 160).

On a 240 DPI screen, 1 DIPs would equal 1.5 physical pixels.

An invalid instance will be returned in the case an empty size is passed to the method.

Note

The density is automatically obtained from the DPI of the screen where the page is being shown, but as many X11 servers are reporting wrong DPI, it is possible to override it using QX11Info::setAppDpiY().

Page authors can provide the supplied values by using the viewport meta tag. More information about can be found in the Apple Safari Reference Library, Using the Viewport Meta Tag.

See also

QWebPage::ViewportAttributes, setPreferredContentsSize(), QGraphicsWebView::setScale()

This signal is emitted whenever the page requests the web browser window to be closed, for example through the JavaScript window.close() call.

Returns the 'major' version number of WebKit at runtime as an integer (for example, 531). This is the version of WebKit the application was compiled against.

See also

qWebKitVersion

Returns the 'minor' version number of WebKit at runtime as an integer (for example, 3). This is the version of WebKit the application was compiled against.

See also

qWebKitVersion

Returns the version number of WebKit at runtime as a string (for example, "531.3"). This version is commonly used in WebKit based browsers as part of the user agent string. Web servers and JavaScript might use it to identify the presence of certain WebKit engine features and behavior. The evolution of this version is bound to the releases of Apple's Safari browser.

See also

QWebPage::userAgentForUrl()

This property holds whether the content in this QWebPage is editable or not. If this property is enabled the contents of the page can be edited by the user through a visible cursor. If disabled (the default) only HTML elements in the web page with their contenteditable attribute set are editable.

See also

modified, contentsChanged(), WebAction

This property holds whether QWebPage should forward unsupported content. If enabled, the unsupportedContent() signal is emitted with a network reply that can be used to read the content. If disabled the download of such content is aborted immediatel and unsupported content is not forwarded.

This property holds whether this page contains selected content or not.

See also

selectionChanged()

This property holds how QWebPage should delegate the handling of links through the linkClicked() signal.

The default is to delegate no links.

This property holds whether the page contains unsubmitted form data, or the contents have been changed.

By default, this property is false.

See also

contentsChanged(), contentEditable, undoStack()

This property holds the page's palette. The base brush of the palette is used to draw the background of the main frame.

By default, this property contains the application's default palette.

This property holds a custom size used for laying out the page contents. If this property is set to a valid size, this size is used for all layout needs instead of the size of the viewport. Setting an invalid size, makes the page fall back to using the viewport size for layout.

By default all pages are laid out using the viewport of the page as the base.

As pages mostly are designed for desktop usage, they often do not layout properly on small devices as the contents require a certain view width. For this reason it is common to use a different layout size and then scale the contents to fit within the actual view.

See also

viewportSize

This property holds the HTML currently selected.

By default, this property contains an empty string.

See also

selectionChanged(), selectedText()

This property holds the text currently selected.

By default, this property contains an empty string.

See also

selectionChanged(), selectedHtml()

This property holds the size of the viewport.

The size affects for example the visibility of scrollbars if the document is larger than the viewport.

By default, for a newly-created Web page, this property contains a size with zero width and height.

See also

QWebFrame::render(), preferredContentsSize