Qyoto
4.0.5
Qyoto is a C# language binding for Qt
|
The QWebPage class provides an object to view and edit web documents. More...
Classes | |
class | ChooseMultipleFilesExtensionOption |
class | ChooseMultipleFilesExtensionReturn |
class | ErrorPageExtensionOption |
class | ErrorPageExtensionReturn |
class | ExtensionOption |
class | ExtensionReturn |
class | ViewportAttributes |
The QWebPage::ViewportAttributes class describes hints that can be applied to a viewport. More... | |
Public Member Functions | |
QWebPage (QObject parent=null) | |
| |
override void | CreateProxy () |
new QAction | Action (QWebPage.WebAction action) |
| |
new ulong | BytesReceived () |
| |
new QMenu | CreateStandardContextMenu () |
| |
new QWebFrame | CurrentFrame () |
| |
override bool | OnEvent (QEvent arg1) |
| |
new bool | extension (QWebPage.Extension extension) |
| |
new bool | extension (QWebPage.Extension extension, QWebPage.ExtensionOption option=null) |
| |
virtual bool | extension (QWebPage.Extension extension, QWebPage.ExtensionOption option=null, QWebPage.ExtensionReturn output=null) |
| |
new bool | FindText (string subString, QWebPage.FindFlag options=0) |
| |
new bool | FocusNextPrevChild (bool next) |
| |
new QWebFrame | FrameAt (QPoint pos) |
| |
new QWebHistory | History () |
| |
new object | InputMethodQuery (Qt.InputMethodQuery property) |
| |
new QWebFrame | MainFrame () |
| |
new void | SetActualVisibleContentRect (QRect rect) |
| |
new void | SetFeaturePermission (QWebFrame frame, QWebPage.Feature feature, QWebPage.PermissionPolicy policy) |
| |
new QWebSettings | Settings () |
| |
new bool | ShouldInterruptJavaScript () |
| |
new System.Collections.Generic.List < string > | SupportedContentTypes () |
| |
new bool | SupportsContentType (string mimeType) |
| |
virtual bool | SupportsExtension (QWebPage.Extension extension) |
| |
new bool | OnSwallowContextMenuEvent (QContextMenuEvent @event) |
| |
new ulong | TotalBytes () |
| |
virtual void | TriggerAction (QWebPage.WebAction action, bool @checked=false) |
| |
new QUndoStack | UndoStack () |
| |
new void | UpdatePositionDependentActions (QPoint pos) |
| |
new QWebPage.ViewportAttributes | ViewportAttributesForSize (QSize availableSize) |
| |
new void | Dispose () |
Public Member Functions inherited from QtCore.QObject | |
QObject (QObject parent=null) | |
| |
new bool | BlockSignals (bool b) |
| |
new System.Collections.Generic.List < QObject > | Children () |
| |
new bool | Connect (QObject sender, string signal, string member, Qt.ConnectionType type=Qt.ConnectionType.AutoConnection) |
| |
new void | DeleteLater () |
| |
new bool | Disconnect (QObject receiver, string member=null) |
| |
new bool | Disconnect (string signal=null, QObject receiver=null, string member=null) |
| |
new void | DumpObjectInfo () |
| |
new void | DumpObjectTree () |
| |
new System.Collections.Generic.List < QByteArray > | DynamicPropertyNames () |
| |
virtual bool | EventFilter (QObject arg1, QEvent arg2) |
| |
new bool | Inherits (string classname) |
| |
new void | InstallEventFilter (QObject arg1) |
| |
new bool | IsWidgetType () |
| |
new void | KillTimer (int id) |
| |
new object | Property (string name) |
| |
new void | RemoveEventFilter (QObject arg1) |
| |
new bool | SetProperty (string name, object value) |
| |
new void | SetUserData (uint id, QObjectUserData data) |
new bool | SignalsBlocked () |
| |
new int | StartTimer (int interval) |
| |
new QObjectUserData | UserData (uint id) |
new void | Dispose () |
Public Member Functions inherited from QtCore.Qt | |
delegate QTextStream | FuncQTextStreamQTextStream (QTextStream qTextStream) |
delegate string | FuncStringQByteArray (QByteArray qByteArray) |
delegate QByteArray | FuncQByteArrayString (string @string) |
delegate void | ActionQtMsgTypeString (QtMsgType qtMsgType, string @string) |
delegate QObject | FuncQObject () |
Static Public Member Functions | |
static string | Tr (string s, string c=null) |
static string | Tr (string s, string c, int n) |
static string | TrUtf8 (string s, string c=null) |
static string | TrUtf8 (string s, string c, int n) |
Static Public Member Functions inherited from QtCore.QObject | |
static bool | Connect (QObject sender, QMetaMethod signal, QObject receiver, QMetaMethod method, Qt.ConnectionType type=Qt.ConnectionType.AutoConnection) |
| |
static bool | Connect (QObject sender, string signal, QObject receiver, string member, Qt.ConnectionType arg5=Qt.ConnectionType.AutoConnection) |
| |
static bool | Disconnect (QObject sender, QMetaMethod signal, QObject receiver, QMetaMethod member) |
| |
static bool | Disconnect (QObject sender, string signal, QObject receiver, string member) |
| |
static uint | RegisterUserData () |
static string | Tr (string s, string c=null) |
| |
static string | Tr (string s, string c, int n) |
| |
static string | TrUtf8 (string s, string c=null) |
| |
static string | TrUtf8 (string s, string c, int n) |
| |
Static Public Member Functions inherited from QtCore.Qt | |
static QDataStream | Write (QDataStream s, object p) |
static QDataStream | Write (QDataStream arg1, QSizeF arg2) |
static QTextStream | Write (QTextStream s, Qt.FuncQTextStreamQTextStream f) |
static QDataStream | Write (QDataStream arg1, QPoint arg2) |
static QDataStream | Write (QDataStream arg1, QLineF arg2) |
static QDataStream | Write (QDataStream arg1, QPointF arg2) |
static QDataStream | Write (QDataStream arg1, QChar arg2) |
static QDataStream | Write (QDataStream arg1, QByteArray arg2) |
static QDataStream | Write (QDataStream arg1, QEasingCurve arg2) |
static QDataStream | Write (QDataStream arg1, QRectF arg2) |
static QDataStream | Write (QDataStream arg1, QDateTime arg2) |
static QDataStream | Write (QDataStream arg1, QUrl arg2) |
static QDataStream | Write (QDataStream arg1, QTime arg2) |
static QDataStream | Write (QDataStream arg1, QLocale arg2) |
static QDataStream | Write (QDataStream arg1, QBitArray arg2) |
static QDataStream | Write (QDataStream arg1, QUuid arg2) |
static QDataStream | Write (QDataStream arg1, QLine arg2) |
static QDataStream | Write (QDataStream arg1, QDate arg2) |
static QDataStream | Write (QDataStream @out, QRegExp regExp) |
static QDataStream | Write (QDataStream arg1, QRect arg2) |
static QDataStream | Write (QDataStream arg1, QSize arg2) |
static QDataStream | Write (QDataStream s, QVariant.Type p) |
static QDataStream | Write (QDataStream arg1, string arg2) |
static QDataStream | Write (QDataStream @out, System.Collections.Generic.List< string > list) |
static QDataStream | Read (QDataStream arg1, QChar arg2) |
static QDataStream | Read (QDataStream arg1, QLocale arg2) |
static QDataStream | Read (QDataStream arg1, QRect arg2) |
static QDataStream | Read (QDataStream arg1, QEasingCurve arg2) |
static QDataStream | Read (QDataStream arg1, QDate arg2) |
static QDataStream | Read (QDataStream arg1, QUrl arg2) |
static QDataStream | Read (QDataStream arg1, QUuid arg2) |
static QTextStream | Read (QTextStream s, Qt.FuncQTextStreamQTextStream f) |
static QDataStream | Read (QDataStream arg1, QLineF arg2) |
static QDataStream | Read (QDataStream arg1, QRectF arg2) |
static QDataStream | Read (QDataStream arg1, QPointF arg2) |
static QDataStream | Read (QDataStream arg1, QLine arg2) |
static QDataStream | Read (QDataStream arg1, QBitArray arg2) |
static QDataStream | Read (QDataStream arg1, QSize arg2) |
static QDataStream | Read (QDataStream arg1, QDateTime arg2) |
static QDataStream | Read (QDataStream arg1, QTime arg2) |
static QDataStream | Read (QDataStream arg1, QPoint arg2) |
static QDataStream | Read (QDataStream @in, QRegExp regExp) |
static QDataStream | Read (QDataStream s, object p) |
static QDataStream | Read (QDataStream arg1, QByteArray arg2) |
static QDataStream | Read (QDataStream arg1, QSizeF arg2) |
static QDataStream | Read (QDataStream arg1, string arg2) |
static QDataStream | Read (QDataStream s, QVariant.Type p) |
static QDataStream | Read (QDataStream @in, System.Collections.Generic.List< string > list) |
static double | qAcos (double v) |
static void | qAddPostRoutine (System.Action arg1) |
static string | qAppName () |
static double | qAsin (double v) |
static double | qAtan (double v) |
static double | qAtan2 (double x, double y) |
static void | qBadAlloc () |
static int | qCeil (double v) |
static ushort | qChecksum (string s, uint len) |
static QByteArray | qCompress (QByteArray data) |
static QByteArray | qCompress (QByteArray data, int compressionLevel=-1) |
static QByteArray | qCompress (Pointer< byte > data, int nbytes) |
static QByteArray | qCompress (Pointer< byte > data, int nbytes, int compressionLevel=-1) |
static double | qCos (double v) |
static double | qExp (double v) |
static double | qFabs (double v) |
static double | qFastCos (double x) |
static double | qFastSin (double x) |
static string | qFlagLocation (string method) |
static int | qFloor (double v) |
static bool | qFuzzyCompare (double p1, double p2) |
static bool | qFuzzyCompare (float p1, float p2) |
static bool | qFuzzyIsNull (double d) |
static bool | qFuzzyIsNull (float f) |
static uint | qHash (QBitArray key) |
static uint | qHash (QChar key) |
static uint | qHash (QStringRef key) |
static uint | qHash (QUrl url) |
static uint | qHash (QPersistentModelIndex index) |
static uint | qHash (QByteArray key) |
static uint | qHash (QModelIndex index) |
static uint | qHash (uint key) |
static uint | qHash (sbyte key) |
static uint | qHash (byte key) |
static uint | qHash (short key) |
static uint | qHash (NativeLong key) |
static uint | qHash (ushort key) |
static uint | qHash (long key) |
static uint | qHash (ulong key) |
static uint | qHash (int key) |
static uint | qHash (string key) |
static uint | qHash (NativeULong key) |
static double | qInf () |
static Qt.ActionQtMsgTypeString | qInstallMsgHandler (Qt.ActionQtMsgTypeString arg1) |
static int | qIntCast (float f) |
static int | qIntCast (double f) |
static bool | qIsFinite (double d) |
static bool | qIsFinite (float f) |
static bool | qIsInf (float f) |
static bool | qIsInf (double d) |
static bool | qIsNaN (float f) |
static bool | qIsNaN (double d) |
static bool | qIsNull (float f) |
static bool | qIsNull (double d) |
static double | qLn (double v) |
static double | qPow (double x, double y) |
static double | qQNaN () |
static void | qRegisterStaticPluginInstanceFunction (Qt.FuncQObject function) |
static void | qRemovePostRoutine (System.Action arg1) |
static int | qRound (double d) |
static long | qRound64 (double d) |
static double | qSNaN () |
static bool | qSharedBuild () |
static double | qSin (double v) |
static double | qSqrt (double v) |
static bool | qStringComparisonHelper (QStringRef s1, string s2) |
static double | qTan (double v) |
static QByteArray | qUncompress (QByteArray data) |
static QByteArray | qUncompress (Pointer< byte > data, int nbytes) |
static string | qVersion () |
static void | Qbswap_helper (Pointer< byte > src, Pointer< byte > dest, int size) |
static QByteArray | Qgetenv (string varName) |
static bool | Qputenv (string varName, QByteArray value) |
static int | Qrand () |
static void | Qsrand (uint seed) |
static int | Qstrcmp (QByteArray str1, QByteArray str2) |
static int | Qstrcmp (QByteArray str1, string str2) |
static int | Qstrcmp (string str1, QByteArray str2) |
static int | Qstrcmp (string str1, string str2) |
static Pointer< sbyte > | Qstrcpy (Pointer< sbyte > dst, string src) |
static Pointer< sbyte > | Qstrdup (string arg1) |
static int | Qstricmp (string arg1, string arg2) |
static uint | Qstrlen (string str) |
static int | Qstrncmp (string str1, string str2, uint len) |
static Pointer< sbyte > | Qstrncpy (Pointer< sbyte > dst, string src, uint len) |
static int | Qstrnicmp (string arg1, string arg2, uint len) |
static uint | Qstrnlen (string str, uint maxlen) |
static string | QtTrId (string id, int n=-1) |
Protected Member Functions | |
QWebPage (System.Type dummy) | |
virtual bool | AcceptNavigationRequest (QWebFrame frame, QNetworkRequest request, QWebPage.NavigationType type) |
| |
new void | OnApplicationCacheQuotaExceeded (QWebSecurityOrigin origin, ulong defaultOriginQuota) |
| |
virtual string | ChooseFile (QWebFrame originatingFrame, string oldFile) |
| |
new void | OnContentsChanged () |
| |
virtual QObject | CreatePlugin (string classid, QUrl url, System.Collections.Generic.List< string > paramNames, System.Collections.Generic.List< string > paramValues) |
| |
virtual QWebPage | CreateWindow (QWebPage.WebWindowType type) |
| |
new void | OnDatabaseQuotaExceeded (QWebFrame frame, string databaseName) |
| |
new void | OnDownloadRequested (QNetworkRequest request) |
| |
new void | OnFeaturePermissionRequestCanceled (QWebFrame frame, QWebPage.Feature feature) |
| |
new void | OnFeaturePermissionRequested (QWebFrame frame, QWebPage.Feature feature) |
| |
new void | OnFrameCreated (QWebFrame frame) |
| |
new void | OnGeometryChangeRequested (QRect geom) |
| |
virtual void | JavaScriptAlert (QWebFrame originatingFrame, string msg) |
| |
virtual bool | JavaScriptConfirm (QWebFrame originatingFrame, string msg) |
| |
virtual void | JavaScriptConsoleMessage (string message, int lineNumber, string sourceID) |
| |
virtual bool | JavaScriptPrompt (QWebFrame originatingFrame, string msg, string defaultValue, System.Text.StringBuilder result) |
| |
new void | OnLinkClicked (QUrl url) |
| |
new void | OnLinkHovered (string link, string title, string textContent) |
| |
new void | OnLoadFinished (bool ok) |
| |
new void | OnLoadProgress (int progress) |
| |
new void | OnLoadStarted () |
| |
new void | OnMenuBarVisibilityChangeRequested (bool visible) |
| |
new void | OnMicroFocusChanged () |
| |
new void | OnPrintRequested (QWebFrame frame) |
| |
new void | OnRepaintRequested (QRect dirtyRect) |
| |
new void | OnRestoreFrameStateRequested (QWebFrame frame) |
| |
new void | OnSaveFrameStateRequested (QWebFrame frame, QWebHistoryItem item) |
| |
new void | OnScrollRequested (int dx, int dy, QRect scrollViewRect) |
| |
new void | OnSelectionChanged () |
| |
new void | OnStatusBarMessage (string text) |
| |
new void | OnStatusBarVisibilityChangeRequested (bool visible) |
| |
new void | OnToolBarVisibilityChangeRequested (bool visible) |
| |
new void | OnUnsupportedContent (QNetworkReply reply) |
| |
virtual string | UserAgentForUrl (QUrl url) |
| |
new void | OnViewportChangeRequested () |
| |
new void | OnWindowCloseRequested () |
| |
Protected Member Functions inherited from QtCore.QObject | |
QObject (System.Type dummy) | |
virtual void | OnChildEvent (QChildEvent arg1) |
| |
virtual void | ConnectNotify (string signal) |
| |
virtual void | OnCustomEvent (QEvent arg1) |
| |
new void | OnDestroyed (QObject arg1=null) |
| |
virtual void | DisconnectNotify (string signal) |
| |
new int | Receivers (string signal) |
| |
new QObject | Sender () |
| |
new int | SenderSignalIndex () |
| |
virtual void | OnTimerEvent (QTimerEvent arg1) |
| |
Additional Inherited Members | |
Protected Attributes inherited from QtCore.QObject | |
object | Q_EMIT = null |
SmokeInvocation | interceptor |
readonly List< QEventHandler > | eventFilters = new List<QEventHandler>() |
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
{
Q_OBJECT
public:
Thumbnailer(const QUrl &url);
signals:
void finished();
private slots:
void render();
private:
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.
This enum describes the domain of an ErrorPageExtensionOption object (i.e. the layer in which the error occurred).
This enum was introduced or modified in Qt 4.6.
Http |
The error occurred in the HTTP layer; the error code is a HTTP status code (see QNetworkRequest::HttpStatusCodeAttribute). |
QtNetwork |
The error occurred in the QtNetwork layer; the error code is of type QNetworkReply::NetworkError. |
WebKit |
The 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().
See also ChooseMultipleFilesExtensionOption, ChooseMultipleFilesExtensionReturn, ErrorPageExtensionOption, and ErrorPageExtensionReturn.
This enum describes the options available to the findText() function. 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.
DelegateAllLinks |
Whenever a link is activated the linkClicked() signal is emitted. |
DelegateExternalLinks |
When activating links that point to documents not stored on the local filesystem or an equivalent - such as the Qt resource system - then linkClicked() is emitted. |
DontDelegateLinks |
No links are delegated. Instead, QWebPage tries to handle them all. |
This enum describes the types of navigation available when browsing through hyperlinked documents.
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.
|
protected |
QtWebKit.QWebPage.QWebPage | ( | QObject | parent = null | ) |
Constructs an empty QWebPage with parent parent.
|
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().
new QAction QtWebKit.QWebPage.Action | ( | QWebPage.WebAction | action | ) |
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().
new ulong QtWebKit.QWebPage.BytesReceived | ( | ) |
Returns the number of bytes that were received from the network to render the current page.
See also totalBytes() and loadProgress().
|
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.
|
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.
|
virtual |
Reimplemented from QtCore.QObject.
new QMenu QtWebKit.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.
This function was introduced in Qt 4.5.
|
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(Qt::ApplicationModal) 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() and QWebView::createWindow().
new QWebFrame QtWebKit.QWebPage.CurrentFrame | ( | ) |
Returns the frame currently active.
See also mainFrame() and frameCreated().
new void QtWebKit.QWebPage.Dispose | ( | ) |
new bool QtWebKit.QWebPage.extension | ( | QWebPage.Extension | extension | ) |
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() and Extension.
new bool QtWebKit.QWebPage.extension | ( | QWebPage.Extension | extension, |
QWebPage.ExtensionOption | option = null |
||
) |
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() and Extension.
|
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() and Extension.
new bool QtWebKit.QWebPage.FindText | ( | string | subString, |
QWebPage.FindFlag | 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.
new bool QtWebKit.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't.
Returns the frame at the given point pos, or 0 if there is no frame at that position.
This function was introduced in Qt 4.6.
See also mainFrame() and currentFrame().
new QWebHistory QtWebKit.QWebPage.History | ( | ) |
Returns a pointer to the view's history of navigated web pages.
new object QtWebKit.QWebPage.InputMethodQuery | ( | Qt.InputMethodQuery | property | ) |
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.
property specifies which property is queried.
See also QWidget::inputMethodEvent(), QInputMethodEvent, and QInputContext.
|
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.
|
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.
|
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.
|
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 cancelled 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 cancelled by the user, the implementation should return true and the result string must not be null.
The default implementation uses QInputDialog::getText().
new QWebFrame QtWebKit.QWebPage.MainFrame | ( | ) |
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().
|
protected |
This signal is emitted whenever the web site is asking to store data to the application cache database databaseName and the quota allocated to that web site is exceeded.
|
protected |
This signal is emitted whenever the text in form elements changes as well as other editable content.
This function was introduced in Qt 4.5.
See also contentEditable, modified, QWebFrame::toHtml(), and QWebFrame::toPlainText().
|
protected |
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.
This function was introduced in Qt 4.5.
See also QWebDatabase.
|
protected |
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().
|
virtual |
Reimplemented from QObject::event().
Reimplemented from QtCore.QObject.
|
protected |
void QWebPage::featurePermissionRequested ( QWebFrame * frame, QWebPage::Feature feature ) [signal]
|
protected |
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.
|
protected |
This signal is emitted whenever the page creates a new frame.
See also currentFrame().
|
protected |
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.
|
protected |
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 won't be emitted for clicked links which use JavaScript to trigger navigation.
See also linkHovered().
|
protected |
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().
|
protected |
This signal is emitted when the page finishes loading content. This signal is independant of script execution or page rendering. ok will indicate whether the load was successful or any error occurred.
See also loadStarted() and ErrorPageExtension.
|
protected |
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().
|
protected |
This signal is emitted when a page starts loading content.
See also loadFinished().
|
protected |
This signal is emitted whenever the visibility of the menubar in a web browser window that hosts QWebPage should be changed to visible.
|
protected |
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.
|
protected |
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() and QPrintPreviewDialog.
|
protected |
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() and view().
|
protected |
This signal is emitted when the load of frame is finished and the application may now update its state accordingly.
This function was introduced in Qt 4.5.
|
protected |
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 function was introduced in Qt 4.5.
|
protected |
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().
|
protected |
This signal is emitted whenever the selection changes, either interactively or programmatically (e.g. by calling triggerAction() with a selection action).
See also selectedText().
|
protected |
This signal is emitted when the statusbar text is changed by the page.
|
protected |
This signal is emitted whenever the visibility of the statusbar in a web browser window that hosts QWebPage should be changed to visible.
new bool QtWebKit.QWebPage.OnSwallowContextMenuEvent | ( | 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.
|
protected |
This signal is emitted whenever the visibility of the toolbar in a web browser window that hosts QWebPage should be changed to visible.
|
protected |
This signal is emitted when WebKit cannot 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.
Note: This signal is only emitted if the forwardUnsupportedContent property is set to true.
See also downloadRequested().
|
protected |
Page authors can provide the supplied values by using the viewport meta tag. More information about this can be found at Safari Reference Library: Using the Viewport Meta Tag.
This function was introduced in Qt 4.8.
See also QWebPage::ViewportAttributes, setPreferredContentsSize(), and QGraphicsWebView::setScale().
|
protected |
This signal is emitted whenever the page requests the web browser window to be closed, for example through the JavaScript window.close() call.
new void QtWebKit.QWebPage.SetActualVisibleContentRect | ( | QRect | rect | ) |
void QWebPage::setFeaturePermission ( QWebFrame * frame, Feature feature, PermissionPolicy policy )
new void QtWebKit.QWebPage.SetFeaturePermission | ( | QWebFrame | frame, |
QWebPage.Feature | feature, | ||
QWebPage.PermissionPolicy | policy | ||
) |
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().
new QWebSettings QtWebKit.QWebPage.Settings | ( | ) |
Returns a pointer to the page's settings object.
See also QWebSettings::globalSettings().
new bool QtWebKit.QWebPage.ShouldInterruptJavaScript | ( | ) |
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. QtWebKit will dynamically detect the slot and call it.
This function was introduced in Qt 4.6.
new System.Collections.Generic.List<string> QtWebKit.QWebPage.SupportedContentTypes | ( | ) |
Returns the list of all content types supported by QWebPage.
new bool QtWebKit.QWebPage.SupportsContentType | ( | string | mimeType | ) |
Returns true if QWebPage can handle the given mimeType; otherwise, returns false.
|
virtual |
This virtual function returns true if the web page supports extension; otherwise false is returned.
See also extension().
new ulong QtWebKit.QWebPage.TotalBytes | ( | ) |
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().
|
static |
|
static |
|
virtual |
This function can be called to trigger the specified action. It is also called by QtWebKit 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().
|
static |
|
static |
new QUndoStack QtWebKit.QWebPage.UndoStack | ( | ) |
Returns a pointer to the undo stack used for editable content.
See also modified.
new void QtWebKit.QWebPage.UpdatePositionDependentActions | ( | 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.
|
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 such as Symbian S60 and Maemo, "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.5").
WebKitVersion% is the version of WebKit the application was compiled against.
AppVersion% expands to QCoreApplication::applicationName()/QCoreApplication::applicationVersion() if they're set; otherwise defaulting to Qt and the current Qt version.
new QWebPage.ViewportAttributes QtWebKit.QWebPage.ViewportAttributesForSize | ( | QSize | availableSize | ) |
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().
|
addremove |
This signal is emitted whenever the web site is asking to store data to the application cache database databaseName and the quota allocated to that web site is exceeded.
|
getset |
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.
This property was introduced in Qt 4.5.
|
addremove |
This signal is emitted whenever the text in form elements changes as well as other editable content.
This function was introduced in Qt 4.5.
See also contentEditable, modified, QWebFrame::toHtml(), and QWebFrame::toPlainText().
|
addremove |
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.
This function was introduced in Qt 4.5.
See also QWebDatabase.
|
addremove |
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().
|
getprotected |
|
addremove |
void QWebPage::featurePermissionRequested ( QWebFrame * frame, QWebPage::Feature feature ) [signal]
|
addremove |
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.
|
getset |
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.
|
addremove |
This signal is emitted whenever the page creates a new frame.
See also currentFrame().
|
addremove |
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.
|
get |
This property holds whether this page contains selected content or not.
|
addremove |
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 won't be emitted for clicked links which use JavaScript to trigger navigation.
See also linkHovered().
|
getset |
This property holds how QWebPage should delegate the handling of links through the linkClicked() signal.
The default is to delegate no links.
|
addremove |
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().
|
addremove |
This signal is emitted when the page finishes loading content. This signal is independant of script execution or page rendering. ok will indicate whether the load was successful or any error occurred.
See also loadStarted() and ErrorPageExtension.
|
addremove |
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().
|
addremove |
This signal is emitted when a page starts loading content.
See also loadFinished().
|
addremove |
This signal is emitted whenever the visibility of the menubar in a web browser window that hosts QWebPage should be changed to visible.
|
addremove |
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.
|
get |
This property holds whether the page contains unsubmitted form data, or the contents have been changed.
By default, this property is false.
|
getset |
Returns the QNetworkAccessManager that is responsible for serving network requests for this QWebPage.
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.
|
getset |
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.
|
getset |
Returns the QWebPluginFactory that is responsible for creating plugins embedded into this QWebPage. If no plugin factory is installed a null pointer is returned.
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.
|
getset |
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.
This property was introduced in Qt 4.6.
|
addremove |
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() and QPrintPreviewDialog.
|
addremove |
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() and view().
|
addremove |
This signal is emitted when the load of frame is finished and the application may now update its state accordingly.
This function was introduced in Qt 4.5.
|
addremove |
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 function was introduced in Qt 4.5.
|
addremove |
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().
|
get |
This property holds the HTML currently selected.
By default, this property contains an empty string.
This property was introduced in Qt 4.8.
|
get |
This property holds the text currently selected.
By default, this property contains an empty string.
|
addremove |
This signal is emitted whenever the selection changes, either interactively or programmatically (e.g. by calling triggerAction() with a selection action).
See also selectedText().
|
staticget |
|
addremove |
This signal is emitted when the statusbar text is changed by the page.
|
addremove |
This signal is emitted whenever the visibility of the statusbar in a web browser window that hosts QWebPage should be changed to visible.
|
addremove |
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.
|
addremove |
This signal is emitted whenever the visibility of the toolbar in a web browser window that hosts QWebPage should be changed to visible.
|
addremove |
This signal is emitted when WebKit cannot 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.
Note: This signal is only emitted if the forwardUnsupportedContent property is set to true.
See also downloadRequested().
|
getset |
Returns the view widget that is associated with the web page.
Sets the view that is associated with the web page.
|
addremove |
Page authors can provide the supplied values by using the viewport meta tag. More information about this can be found at Safari Reference Library: Using the Viewport Meta Tag.
This function was introduced in Qt 4.8.
See also QWebPage::ViewportAttributes, setPreferredContentsSize(), and QGraphicsWebView::setScale().
|
getset |
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.
|
addremove |
This signal is emitted whenever the page requests the web browser window to be closed, for example through the JavaScript window.close() call.