CopperSpice API  1.7.2
QWebPage Class Reference

The QWebPage class provides an object to view and edit web documents. More...

Inheritance diagram for QWebPage:
QObject

Classes

class  ChooseMultipleFilesExtensionOption
 The QWebPage::ChooseMultipleFilesExtensionOption class describes the option for the multiple files selection extension More...
 
class  ChooseMultipleFilesExtensionReturn
 The QWebPage::ChooseMultipleFilesExtensionReturn describes the return value for the multiple files selection extension More...
 
class  ErrorPageExtensionOption
 The QWebPage::ErrorPageExtensionOption class describes the option for the error page extension More...
 
class  ErrorPageExtensionReturn
 The QWebPage::ErrorPageExtensionReturn describes the error page, which will be shown for the frame for which the error occurred More...
 
class  ExtensionOption
 The QWebPage::ExtensionOption class provides an extended input argument to QWebPage's extension support More...
 
class  ExtensionReturn
 The QWebPage::ExtensionReturn class provides an output result from a QWebPage's extension More...
 
class  ViewportAttributes
 Describes hints that can be applied to a viewport More...
 

Public Types

enum  ErrorDomain
 
enum  Extension
 
enum  LinkDelegationPolicy
 
enum  NavigationType
 
enum  WebAction
 
enum  WebWindowType
 

Public Signals

void applicationCacheQuotaExceeded (QWebSecurityOrigin *origin, quint64 defaultOriginQuota)
 
void contentsChanged ()
 
void databaseQuotaExceeded (QWebFrame *frame, QString databaseName)
 
void downloadRequested (const QNetworkRequest &request)
 
void frameCreated (QWebFrame *frame)
 
void geometryChangeRequested (const QRect &geom)
 
void linkClicked (const QUrl &url)
 
void linkHovered (const QString &link, const QString &title, const QString &textContent)
 
void loadFinished (bool ok)
 
void loadProgress (int progress)
 
void loadStarted ()
 
void menuBarVisibilityChangeRequested (bool visible)
 
void microFocusChanged ()
 
void printRequested (QWebFrame *frame)
 
void repaintRequested (const QRect &dirtyRect)
 
void restoreFrameStateRequested (QWebFrame *frame)
 
void saveFrameStateRequested (QWebFrame *frame, QWebHistoryItem *item)
 
void scrollRequested (int dx, int dy, const QRect &scrollViewRect)
 
void selectionChanged ()
 
void statusBarMessage (const QString &text)
 
void statusBarVisibilityChangeRequested (bool visible)
 
void toolBarVisibilityChangeRequested (bool visible)
 
void unsupportedContent (QNetworkReply *reply)
 
void viewportChangeRequested ()
 
void windowCloseRequested ()
 
- Public Signals inherited from QObject
void destroyed (QObject *obj=nullptr)
 
void objectNameChanged (const QString &objectName)
 

Public Slots

bool shouldInterruptJavaScript ()
 
- Public Slots inherited from QObject
void deleteLater ()
 

Public Methods

 QWebPage (QObject *parent=nullptr)
 
 ~QWebPage ()
 
QActionaction (WebAction action) const
 
quint64 bytesReceived () const
 
QMenucreateStandardContextMenu ()
 
QWebFramecurrentFrame () const
 
bool event (QEvent *) override
 
virtual bool extension (Extension extension, const ExtensionOption *option=0, ExtensionReturn *output=0)
 
bool findText (const QString &subString, FindFlags options=0)
 
bool focusNextPrevChild (bool next)
 
QWebFrameframeAt (const QPoint &pos) const
 
QWebHistoryhistory () const
 
QVariant inputMethodQuery (Qt::InputMethodQuery property) const
 
QWebFramemainFrame () const
 
QNetworkAccessManagernetworkAccessManager () const
 
QWebPluginFactorypluginFactory () const
 
void setNetworkAccessManager (QNetworkAccessManager *manager)
 
void setPluginFactory (QWebPluginFactory *factory)
 
QWebSettingssettings () const
 
void setView (QWidget *view)
 
QStringList supportedContentTypes () const
 
bool supportsContentType (const QString &mimeType) const
 
virtual bool supportsExtension (Extension extension) const
 
bool swallowContextMenuEvent (QContextMenuEvent *event)
 
quint64 totalBytes () const
 
virtual void triggerAction (WebAction action, bool checked=false)
 
QUndoStackundoStack () const
 
void updatePositionDependentActions (const QPoint &pos)
 
QWidgetview () const
 
ViewportAttributes viewportAttributesForSize (const QSize &availableSize) const
 
- Public Methods inherited from QObject
 QObject (QObject *parent=nullptr)
 
 ~QObject ()
 
bool blockSignals (bool block)
 
const QList< QObject * > & children () const
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QStringdynamicPropertyNames () const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
template<typename T >
findChild (const QString &childName=QString ()) const
 
template<class T >
QList< T > findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<class T >
QList< T > findChildren (const QString &objName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
bool inherits (const QString &className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
QObject * parent () const
 
template<class T = QVariant>
property (const QString &name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const QString &name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 
QThreadthread () const
 

Protected Methods

virtual bool acceptNavigationRequest (QWebFrame *frame, const QNetworkRequest &request, NavigationType type)
 
virtual QString chooseFile (QWebFrame *originatingFrame, const QString &oldFile)
 
virtual QObjectcreatePlugin (const QString &classid, const QUrl &url, const QStringList &paramNames, const QStringList &paramValues)
 
virtual QWebPage * createWindow (WebWindowType type)
 
virtual void javaScriptAlert (QWebFrame *originatingFrame, const QString &msg)
 
virtual bool javaScriptConfirm (QWebFrame *originatingFrame, const QString &msg)
 
virtual void javaScriptConsoleMessage (const QString &message, int lineNumber, const QString &sourceID)
 
virtual bool javaScriptPrompt (QWebFrame *originatingFrame, const QString &msg, const QString &defaultValue, QString *result)
 
virtual QString userAgentForUrl (const QUrl &url) const
 
- Protected Methods inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signalMethod) const
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signalMethod) const
 
bool isSignalConnected (const QMetaMethod &signalMethod) const
 
int receivers (const QString &signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Properties

 contentEditable
 
 forwardUnsupportedContent
 
 hasSelection
 
 linkDelegationPolicy
 
 modified
 
 palette
 
 preferredContentsSize
 
 selectedHtml
 
 selectedText
 
 viewportSize
 
- Properties inherited from QObject
 objectName
 

Friends

class QGraphicsWebView
 
class QWebFrame
 
class QWebInspector
 
class QWebView
 

Related Functions

These are not member functions

int qWebKitMajorVersion ()
 
int qWebKitMinorVersion ()
 
QString qWebKitVersion ()
 

Additional Inherited Members

- Static Public Methods inherited from QObject
static bool connect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())
 
static bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...))
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)
 
static QMetaObjectstaticMetaObject ()
 
static QString tr (const char *text, const char *comment=nullptr, std::optional< int > numArg=std::optional< int >())
 

Detailed Description

The QWebPage class provides an object to view and edit web documents.

QWebPage holds a main frame responsible for web content, settings, the history of navigated links and actions. This class can be used, together with QWebFrame, to provide functionality like QWebView in a widget-less environment.

QWebPage's API is very similar to QWebView, as you are still provided with common functions like action() (known as pageAction() in QWebView), triggerAction(), findText() and settings(). More QWebView-like functions can be found in the main frame of QWebPage, obtained via the mainFrame() function. For example, the load(), setUrl() and setHtml() functions for QWebPage can be accessed using QWebFrame.

The loadStarted() signal is emitted when the page begins to load.The loadProgress() signal, on the other hand, is emitted whenever an element of the web page completes loading, such as an embedded image, a script, etc. Finally, the loadFinished() signal is emitted when the page contents are loaded completely, independent of script execution or page rendering. Its argument, either true or false, indicates whether or not the load operation succeeded.

Using QWebPage in a Widget-less Environment

Before you begin painting a QWebPage object, you need to set the size of the viewport by calling setViewportSize(). Then, you invoke the main frame's render function (QWebFrame::render()). An example of this is shown in the code snippet below.

Suppose we have a Thumbnail class as follows:

class Thumbnailer : public QObject
{
CS_OBJECT(Thumbnailer)
public:
Thumbnailer(const QUrl &url);
CS_SIGNAL_1(Public, void finished())
CS_SIGNAL_2(finished)
private:
CS_SLOT_1(Private, void render())
CS_SLOT_2(render)
QWebPage page;
};

The Thumbnail's constructor takes in a url. We connect our QWebPage object's loadFinished() signal to our private slot, render().

Thumbnailer::Thumbnailer(const QUrl &url)
{
page.mainFrame()->load(url);
connect(&page, SIGNAL(loadFinished(bool)), this, SLOT(render()));
}

The render() function shows how we can paint a thumbnail using a QWebPage object.

void Thumbnailer::render()
{
page.setViewportSize(page.mainFrame()->contentsSize());
QImage image(page.viewportSize(), QImage::Format_ARGB32);
QPainter painter(&image);
page.mainFrame()->render(&painter);
painter.end();
QImage thumbnail = image.scaled(400, 400);
thumbnail.save("thumbnail.png");
emit finished();
}

We begin by setting the viewportSize and then we instantiate a QImage object, image, with the same size as our viewportSize. This image is then sent as a parameter to painter. Next, we render the contents of the main frame and its subframes into painter. Finally, we save the scaled image.

See also
QWebFrame

Member Enumeration Documentation

This enum describes the domain of an ErrorPageExtensionOption object (i.e. the layer in which the error occurred).

ConstantValueDescription
QWebPage::QtNetwork0The error occurred in the QtNetwork layer; the error code is of type QNetworkReply::NetworkError.
QWebPage::Http1The error occurred in the HTTP layer; the error code is a HTTP status code (see QNetworkRequest::HttpStatusCodeAttribute).
QWebPage::WebKit2The error is an internal WebKit error.

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().

ConstantValueDescription
QWebPage::ChooseMultipleFilesExtension0Whether the web page supports multiple file selection. This extension is invoked when the web content requests one or more file names, for example as a result of the user clicking on a "file upload" button in a HTML form where multiple file selection is allowed.
QWebPage::ErrorPageExtension1Whether the web page can provide an error page when loading fails.
See also
ChooseMultipleFilesExtensionOption, ChooseMultipleFilesExtensionReturn, ErrorPageExtensionOption, ErrorPageExtensionReturn

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

ConstantValueDescription
QWebPage::DontDelegateLinks0No links are delegated. Instead, QWebPage tries to handle them all.
QWebPage::DelegateExternalLinks1When activating links which point to documents not stored on the local file system or the Resource system, then linkClicked() is emitted.
QWebPage::DelegateAllLinks2Whenever a link is activated the linkClicked() signal is emitted.
See also
QWebPage::linkDelegationPolicy

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

ConstantValueDescription
QWebPage::NavigationTypeLinkClicked0The user clicked on a link or pressed return on a focused link.
QWebPage::NavigationTypeFormSubmitted1The user activated a submit button for an HTML form.
QWebPage::NavigationTypeBackOrForward2Navigation to a previously shown document in the back or forward history is requested.
QWebPage::NavigationTypeReload3The user activated the reload action.
QWebPage::NavigationTypeFormResubmitted4An HTML form was submitted a second time.
QWebPage::NavigationTypeOther5A navigation to another document using a method not listed above.
See also
acceptNavigationRequest()

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 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.

ConstantValueDescription
QWebPage::NoWebAction-1No action is triggered.
QWebPage::OpenLink0Open the current link.
QWebPage::OpenLinkInNewWindow1Open the current link in a new window.
QWebPage::OpenFrameInNewWindow2Replicate the current frame in a new window.
QWebPage::DownloadLinkToDisk3Download the current link to the disk.
QWebPage::CopyLinkToClipboard4Copy the current link to the clipboard.
QWebPage::OpenImageInNewWindow5Open the highlighted image in a new window.
QWebPage::DownloadImageToDisk6Download the highlighted image to the disk.
QWebPage::CopyImageToClipboard7Copy the highlighted image to the clipboard.
QWebPage::CopyImageUrlToClipboard68Copy the highlighted image's URL to the clipboard.
QWebPage::Back8Navigate back in the history of navigated links.
QWebPage::Forward9Navigate forward in the history of navigated links.
QWebPage::Stop10Stop loading the current page.
QWebPage::StopScheduledPageRefresh67Stop all pending page refresh/redirect requests.
QWebPage::Reload11Reload the current page.
QWebPage::ReloadAndBypassCache53Reload the current page, but do not use any local cache.
QWebPage::Cut12Cut the content currently selected into the clipboard.
QWebPage::Copy13Copy the content currently selected into the clipboard.
QWebPage::Paste14Paste content from the clipboard.
QWebPage::Undo15Undo the last editing action.
QWebPage::Redo16Redo the last editing action.
QWebPage::MoveToNextChar17Move the cursor to the next character.
QWebPage::MoveToPreviousChar18Move the cursor to the previous character.
QWebPage::MoveToNextWord19Move the cursor to the next word.
QWebPage::MoveToPreviousWord20Move the cursor to the previous word.
QWebPage::MoveToNextLine21Move the cursor to the next line.
QWebPage::MoveToPreviousLine22Move the cursor to the previous line.
QWebPage::MoveToStartOfLine23Move the cursor to the start of the line.
QWebPage::MoveToEndOfLine24Move the cursor to the end of the line.
QWebPage::MoveToStartOfBlock25Move the cursor to the start of the block.
QWebPage::MoveToEndOfBlock26Move the cursor to the end of the block.
QWebPage::MoveToStartOfDocument27Move the cursor to the start of the document.
QWebPage::MoveToEndOfDocument28Move the cursor to the end of the document.
QWebPage::SelectNextChar29Select to the next character.
QWebPage::SelectPreviousChar30Select to the previous character.
QWebPage::SelectNextWord31Select to the next word.
QWebPage::SelectPreviousWord32Select to the previous word.
QWebPage::SelectNextLine33Select to the next line.
QWebPage::SelectPreviousLine34Select to the previous line.
QWebPage::SelectStartOfLine35Select to the start of the line.
QWebPage::SelectEndOfLine36Select to the end of the line.
QWebPage::SelectStartOfBlock37Select to the start of the block.
QWebPage::SelectEndOfBlock38Select to the end of the block.
QWebPage::SelectStartOfDocument39Select to the start of the document.
QWebPage::SelectEndOfDocument40Select to the end of the document.
QWebPage::DeleteStartOfWord41Delete to the start of the word.
QWebPage::DeleteEndOfWord42Delete to the end of the word.
QWebPage::SetTextDirectionDefault43Set the text direction to the default direction.
QWebPage::SetTextDirectionLeftToRight44Set the text direction to left-to-right.
QWebPage::SetTextDirectionRightToLeft45Set the text direction to right-to-left.
QWebPage::ToggleBold46Toggle the formatting between bold and normal weight.
QWebPage::ToggleItalic47Toggle the formatting between italic and normal style.
QWebPage::ToggleUnderline48Toggle underlining.
QWebPage::InspectElement49Show the Web Inspector with the currently highlighted HTML element.
QWebPage::InsertParagraphSeparator50Insert a new paragraph.
QWebPage::InsertLineSeparator51Insert a new line.
QWebPage::SelectAll52Selects all content.
QWebPage::PasteAndMatchStyle54Paste content from the clipboard with current style.
QWebPage::RemoveFormat55Removes formatting and style.
QWebPage::ToggleStrikethrough56Toggle the formatting between strikethrough and normal style.
QWebPage::ToggleSubscript57Toggle the formatting between subscript and baseline.
QWebPage::ToggleSuperscript58Toggle the formatting between supercript and baseline.
QWebPage::InsertUnorderedList59Toggles the selection between an ordered list and a normal block.
QWebPage::InsertOrderedList60Toggles the selection between an ordered list and a normal block.
QWebPage::Indent61Increases the indentation of the currently selected format block by one increment.
QWebPage::Outdent62Decreases the indentation of the currently selected format block by one increment.
QWebPage::AlignCenter63Applies center alignment to content.
QWebPage::AlignJustified64Applies full justification to content.
QWebPage::AlignLeft65Applies left justification to content.
QWebPage::AlignRight66Applies right justification to content.

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

ConstantValueDescription
QWebPage::WebBrowserWindow0 The window is a regular web browser window.
QWebPage::WebModalDialog1 The window acts as modal dialog.

Constructor & Destructor Documentation

QWebPage::QWebPage ( QObject parent = nullptr)
explicit

Constructs an empty QWebPage with parent parent.

QWebPage::~QWebPage ( )

Destroys the web page.

Method Documentation

bool QWebPage::acceptNavigationRequest ( QWebFrame frame,
const QNetworkRequest request,
NavigationType  type 
)
protectedvirtual

This function is called whenever WebKit requests to navigate frame to the resource specified by request by means of the specified navigation type type.

If 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()
QAction * QWebPage::action ( WebAction  action) const

Returns a QAction for the specified WebAction 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()
void QWebPage::applicationCacheQuotaExceeded ( QWebSecurityOrigin origin,
quint64  defaultOriginQuota 
)
signal

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.

quint64 QWebPage::bytesReceived ( ) const

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

See also
totalBytes(), loadProgress()
QString QWebPage::chooseFile ( QWebFrame parentFrame,
const QString suggestedFile 
)
protectedvirtual

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 parentFrame.

See also
ChooseMultipleFilesExtension
void QWebPage::contentsChanged ( )
signal

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()
QObject * QWebPage::createPlugin ( const QString classid,
const QUrl url,
const QStringList paramNames,
const QStringList paramValues 
)
protectedvirtual

This function is called whenever WebKit encounters a 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.

QMenu * QWebPage::createStandardContextMenu ( )

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.

QWebPage * QWebPage::createWindow ( WebWindowType  type)
protectedvirtual

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()
QWebFrame * QWebPage::currentFrame ( ) const

Returns the frame currently active.

See also
mainFrame(), frameCreated()
void QWebPage::databaseQuotaExceeded ( QWebFrame frame,
QString  databaseName 
)
signal

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
void QWebPage::downloadRequested ( const QNetworkRequest request)
signal

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()
bool QWebPage::event ( QEvent event)
overridevirtual

Reimplemented from QObject::event().

Reimplemented from QObject.

bool QWebPage::extension ( Extension  extension,
const ExtensionOption option = 0,
ExtensionReturn output = 0 
)
virtual

This virtual function 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 of this function is determined by extension. The 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.

Returns true if the extension was called successfully, otherwise returns false.

See also
supportsExtension(), Extension
bool QWebPage::findText ( const QString subString,
FindFlags  options = 0 
)

Finds the specified string, subString, in the page, using the given options.

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.

To clear the selection, just pass an empty string.

Returns true if subString was found, otherwise returns false.

bool QWebPage::focusNextPrevChild ( bool  next)

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.

QWebFrame * QWebPage::frameAt ( const QPoint pos) const

Returns the frame at the given point pos, or 0 if there is no frame at that position.

See also
mainFrame(), currentFrame()
void QWebPage::frameCreated ( QWebFrame frame)
signal

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

See also
currentFrame()
void QWebPage::geometryChangeRequested ( const QRect geom)
signal

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.

QWebHistory * QWebPage::history ( ) const

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

QVariant QWebPage::inputMethodQuery ( Qt::InputMethodQuery  property) const

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
void QWebPage::javaScriptAlert ( QWebFrame frame,
const QString msg 
)
protectedvirtual

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.

bool QWebPage::javaScriptConfirm ( QWebFrame frame,
const QString msg 
)
protectedvirtual

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.

void QWebPage::javaScriptConsoleMessage ( const QString message,
int  lineNumber,
const QString sourceID 
)
protectedvirtual

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.

bool QWebPage::javaScriptPrompt ( QWebFrame frame,
const QString msg,
const QString defaultValue,
QString result 
)
protectedvirtual

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().

void QWebPage::linkClicked ( const QUrl url)
signal

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()
void QWebPage::linkHovered ( const QString link,
const QString title,
const QString textContent 
)
signal

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()
void QWebPage::loadFinished ( bool  ok)
signal

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(), ErrorPageExtension
void QWebPage::loadProgress ( int  progress)
signal

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()
void QWebPage::loadStarted ( )
signal

This signal is emitted when a page starts loading content.

See also
loadFinished()
QWebFrame * QWebPage::mainFrame ( ) const

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()
void QWebPage::menuBarVisibilityChangeRequested ( bool  visible)
signal

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

void QWebPage::microFocusChanged ( )
signal

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.

QNetworkAccessManager * QWebPage::networkAccessManager ( ) const

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

See also
setNetworkAccessManager()
QWebPluginFactory * QWebPage::pluginFactory ( ) const

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()
void QWebPage::printRequested ( QWebFrame frame)
signal

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
void QWebPage::repaintRequested ( const QRect dirtyRect)
signal

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()
void QWebPage::restoreFrameStateRequested ( QWebFrame frame)
signal

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

void QWebPage::saveFrameStateRequested ( QWebFrame frame,
QWebHistoryItem item 
)
signal

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().

void QWebPage::scrollRequested ( int  dx,
int  dy,
const QRect rectToScroll 
)
signal

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

See also
view()
void QWebPage::selectionChanged ( )
signal

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

See also
selectedText()
void QWebPage::setNetworkAccessManager ( QNetworkAccessManager manager)

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()
void QWebPage::setPluginFactory ( QWebPluginFactory factory)

Sets the QWebPluginFactory factory responsible for creating plugins embedded into this QWebPage.

Note: The plugin factory is only used if the QWebSettings::PluginsEnabled attribute is enabled.

See also
pluginFactory()
QWebSettings * QWebPage::settings ( ) const

Returns a pointer to the page's settings object.

See also
QWebSettings::globalSettings()
void QWebPage::setView ( QWidget view)

Sets the view that is associated with the web page.

See also
view()
bool QWebPage::shouldInterruptJavaScript ( )
slot

This function 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.
void QWebPage::statusBarMessage ( const QString text)
signal

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

void QWebPage::statusBarVisibilityChangeRequested ( bool  visible)
signal

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

QStringList QWebPage::supportedContentTypes ( ) const

Returns the list of all content types supported by QWebPage.

bool QWebPage::supportsContentType ( const QString mimeType) const

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

bool QWebPage::supportsExtension ( Extension  extension) const
virtual

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

See also
extension()
bool QWebPage::swallowContextMenuEvent ( QContextMenuEvent event)

Filters the context menu event, 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.

void QWebPage::toolBarVisibilityChangeRequested ( bool  visible)
signal

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

quint64 QWebPage::totalBytes ( ) const

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()
void QWebPage::triggerAction ( WebAction  action,
bool  checked = false 
)
virtual

This function 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()
QUndoStack * QWebPage::undoStack ( ) const

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

See also
modified
void QWebPage::unsupportedContent ( QNetworkReply reply)
signal

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. See 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 reply.
This signal is only emitted if the forwardUnsupportedContent property is set to true.
See also
downloadRequested()
void QWebPage::updatePositionDependentActions ( const QPoint pos)

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

QString QWebPage::userAgentForUrl ( const QUrl url) const
protectedvirtual

This function 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 run-time:

  • %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.
QWidget * QWebPage::view ( ) const

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

See also
setView()
ViewportAttributes QWebPage::viewportAttributesForSize ( const QSize availableSize) const

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

Thus, 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().
void QWebPage::viewportChangeRequested ( )
signal

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()
void QWebPage::windowCloseRequested ( )
signal

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

Friends And Related Function Documentation

int qWebKitMajorVersion ( )
related

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

See also
qWebKitVersion
int qWebKitMinorVersion ( )
related

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

See also
qWebKitVersion
QString qWebKitVersion ( )
related

Returns the version number of WebKit at run-time 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()

Property Documentation

QWebPage::contentEditable

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
PropertiesClass Methods
read isContentEditable
write setContentEditable
QWebPage::forwardUnsupportedContent

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 immediately.

By default unsupported content is not forwarded.

PropertiesClass Methods
read forwardUnsupportedContent
write setForwardUnsupportedContent
QWebPage::hasSelection

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

See also
selectionChanged()
PropertiesClass Methods
read hasSelection
QWebPage::linkDelegationPolicy

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

The default is to delegate no links.

PropertiesClass Methods
read linkDelegationPolicy
write setLinkDelegationPolicy
QWebPage::modified

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()
PropertiesClass Methods
read isModified
QWebPage::palette

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.

PropertiesClass Methods
read palette
write setPalette
QWebPage::preferredContentsSize

This property holds a custom size used for laying out the page contents.

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.

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.

See also
viewportSize
PropertiesClass Methods
read preferredContentsSize
write setPreferredContentsSize
QWebPage::selectedHtml

This property holds the HTML currently selected.

By default, this property contains an empty string.

See also
selectionChanged(), selectedText()
PropertiesClass Methods
read selectedHtml
QWebPage::selectedText

This property holds the text currently selected.

By default, this property contains an empty string.

See also
selectionChanged(), selectedHtml()
PropertiesClass Methods
read selectedText
QWebPage::viewportSize

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
PropertiesClass Methods
read viewportSize
write setViewportSize