Qyoto  4.0.5
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Properties
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
QtWebKit.QWebFrame Class Reference

The QWebFrame class represents a frame in a web page. More...

Inheritance diagram for QtWebKit.QWebFrame:
Inheritance graph
[legend]
Collaboration diagram for QtWebKit.QWebFrame:
Collaboration graph
[legend]

Public Types

enum  RenderLayer { AllLayers = 255, ContentsLayer = 16, PanIconLayer = 64, ScrollBarLayer = 32 }
  More...
 

Public Member Functions

override void CreateProxy ()
 
new void AddToJavaScriptWindowObject (string name, QObject @object)
 
 
new void AddToJavaScriptWindowObject (string name, QObject @object, QScriptEngine.ValueOwnership ownership)
 
 
new
System.Collections.Generic.List
< QWebFrame > 		ChildFrames ()
 
 
new QWebElement DocumentElement ()
 
 
new object EvaluateJavaScript (string scriptSource)
 
 
override bool OnEvent (QEvent arg1)
 
 
new QWebElementCollection FindAllElements (string selectorQuery)
 
 
new QWebElement FindFirstElement (string selectorQuery)
 
 
new string FrameName ()
 
 
new QRect Geometry ()
 
 
new QWebHitTestResult HitTestContent (QPoint pos)
 
 
new void Load (QUrl url)
 
 
new void Load (QNetworkRequest request, QNetworkAccessManager.Operation operation=QNetworkAccessManager.Operation.GetOperation)
 
 
new void Load (QNetworkRequest request, QNetworkAccessManager.Operation operation, QByteArray body)
 
 
new
System.Collections.Generic.Dictionary
< System.String, System.String > 		MetaData ()
 
 
new QWebPage Page ()
 
 
new QWebFrame ParentFrame ()
 
 
new QPoint Pos ()
 
 
new void Print (QPrinter printer)
 
 
new void Render (QPainter arg1)
 
 
new void Render (QPainter arg1, QRegion clip)
 
 
new void Render (QPainter arg1, QWebFrame.RenderLayer layer)
 
 
new void Render (QPainter arg1, QWebFrame.RenderLayer layer, QRegion clip)
 
 
new string RenderTreeDump ()
 
 
new void Scroll (int arg1, int arg2)
 
 
new QRect ScrollBarGeometry (Qt.Orientation orientation)
 
 
new int ScrollBarMaximum (Qt.Orientation orientation)
 
 
new int ScrollBarMinimum (Qt.Orientation orientation)
 
 
new Qt.ScrollBarPolicy ScrollBarPolicy (Qt.Orientation orientation)
 
 
new int ScrollBarValue (Qt.Orientation orientation)
 
 
new void ScrollToAnchor (string anchor)
 
 
new QWebSecurityOrigin SecurityOrigin ()
 
 
new void SetContent (QByteArray data, string mimeType="")
 
 
new void SetContent (QByteArray data, string mimeType, QUrl baseUrl)
 
 
new void SetFocus ()
 
 
new void SetHtml (string html)
 
 
new void SetHtml (string html, QUrl baseUrl)
 
 
new void SetScrollBarPolicy (Qt.Orientation orientation, Qt.ScrollBarPolicy policy)
 
 
new void SetScrollBarValue (Qt.Orientation orientation, int value)
 
 
new void SetTextSizeMultiplier (double factor)
 
new void SetZoomFactor (double factor)
 
new double textSizeMultiplier ()
 
new string ToHtml ()
 
 
new string ToPlainText ()
 
 
new double zoomFactor ()
 
- 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

 QWebFrame (System.Type dummy)
 
new void OnContentsSizeChanged (QSize size)
 
 
new void OnIconChanged ()
 
 
new void OnInitialLayoutCompleted ()
 
 
new void OnJavaScriptWindowObjectCleared ()
 
 
new void OnLoadFinished (bool ok)
 
 
new void OnLoadStarted ()
 
 
new void OnPageChanged ()
 
 
new void OnProvisionalLoad ()
 
new void OnTitleChanged (string title)
 
 
new void OnUrlChanged (QUrl url)
 
 
- 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)
 
 

Properties

Slot JavaScriptWindowObjectCleared
 
 
Slot ProvisionalLoad
 
Slot< System.String > TitleChanged
 
 
Slot< QUrl > UrlChanged
 
 
Slot InitialLayoutCompleted
 
 
Slot IconChanged
 
 
Slot< QSize > ContentsSizeChanged
 
 
Slot LoadStarted
 
 
Slot< System.Boolean > LoadFinished
 
 
Slot PageChanged
 
 
new double TextSizeMultiplier [get, set]
 
new double ZoomFactor [get, set]
 
 
new string Title [get]
 
 
new QUrl Url [get, set]
 
 
new QUrl RequestedUrl [get]
 
new QUrl BaseUrl [get]
 
 
new QIcon Icon [get]
 
 
new QSize ContentsSize [get]
 
 
new QPoint ScrollPosition [get, set]
 
 
new bool Focus [get]
 
static new QMetaObject StaticMetaObject [get]
 
new IQWebFrameSignals Emit [get]
 
- Properties inherited from QtCore.QObject
virtual EventHandler
< QEventArgs< QChildEvent > > 		ChildEvent
 
 
virtual EventHandler
< QEventArgs< QEvent > > 		CustomEvent
 
 
virtual EventHandler
< QEventArgs< QEvent > > 		Event
 
 
virtual EventHandler
< QEventArgs< QTimerEvent > > 		TimerEvent
 
 
Slot< QObject > DestroyedQObject
 
Slot Destroyed
 
 
new QObject Parent [get, set]
 
 
virtual System.IntPtr SmokeObject [get, set]
 
new string ObjectName [get, set]
 
 
static new QMetaObject StaticMetaObject [get]
 
 
static new QMetaObject StaticQtMetaObject [get]
 
new IQObjectSignals Emit [get]
 

Additional Inherited Members

- Protected Attributes inherited from QtCore.QObject
object Q_EMIT = null
 
SmokeInvocation interceptor
 
readonly List< QEventHandler > eventFilters = new List<QEventHandler>()
 

Detailed Description

The QWebFrame class represents a frame in a web page.

QWebFrame represents a frame inside a web page. Each QWebPage object contains at least one frame, the main frame, obtained using QWebPage::mainFrame(). Additional frames will be created for HTML <frame> or <iframe> elements.

A frame can be loaded using load() or setUrl(). Alternatively, if you have the HTML content readily available, you can use setHtml() instead.

The page() function returns a pointer to the web page object. See Elements of QWebView for an explanation of how web frames are related to a web page and web view.

The QWebFrame class also offers methods to retrieve both the URL currently loaded by the frame (see url()) as well as the URL originally requested to be loaded (see requestedUrl()). These methods make possible the retrieval of the URL before and after a DNS resolution or a redirection occurs during the load process. The requestedUrl() also matches to the URL added to the frame history (QWebHistory) if load is successful.

The title of an HTML frame can be accessed with the title() property. Additionally, a frame may also specify an icon, which can be accessed using the icon() property. If the title or the icon changes, the corresponding titleChanged() and iconChanged() signals will be emitted. The zoomFactor() property can be used to change the overall size of the content displayed in the frame.

QWebFrame objects are created and controlled by the web page. You can connect to the web page's frameCreated() signal to be notified when a new frame is created.

There are multiple ways to programmatically examine the contents of a frame. The hitTestContent() function can be used to find elements by coordinate. For access to the underlying DOM tree, there is documentElement(), findAllElements() and findFirstElement().

A QWebFrame can be printed onto a QPrinter using the print() function. This function is marked as a slot and can be conveniently connected to QPrintPreviewDialog's paintRequested() signal.

See also QWebPage.

Member Enumeration Documentation

enum QtWebKit.QWebFrame.RenderLayer

This enum describes the layers available for rendering using render(). The layers can be OR-ed together from the following list:

Enumerator:
AllLayers 

Includes all the above layers

ContentsLayer 

The web content of the frame

PanIconLayer 

The icon used when panning the frame

ScrollBarLayer 

The scrollbars of the frame

Constructor & Destructor Documentation

QtWebKit.QWebFrame.QWebFrame ( System.Type  dummy)
protected

Member Function Documentation

new void QtWebKit.QWebFrame.AddToJavaScriptWindowObject ( string  name,
QObject @  object 
)

Make object available under name from within the frame's JavaScript context. The object will be inserted as a child of the frame's window object.

Qt properties will be exposed as JavaScript properties and slots as JavaScript methods. The interaction between C++ and JavaScript is explained in the documentation of the QtWebKit bridge.

If you want to ensure that your QObjects remain accessible after loading a new URL, you should add them in a slot connected to the javaScriptWindowObjectCleared() signal.

If Javascript is not enabled for this page, then this method does nothing.

The object will never be explicitly deleted by QtWebKit.

new void QtWebKit.QWebFrame.AddToJavaScriptWindowObject ( string  name,
QObject @  object,
QScriptEngine.ValueOwnership  ownership 
)

This is an overloaded function.

Make object available under name from within the frame's JavaScript context. The object will be inserted as a child of the frame's window object.

Qt properties will be exposed as JavaScript properties and slots as JavaScript methods. The interaction between C++ and JavaScript is explained in the documentation of the QtWebKit bridge.

If you want to ensure that your QObjects remain accessible after loading a new URL, you should add them in a slot connected to the javaScriptWindowObjectCleared() signal.

If Javascript is not enabled for this page, then this method does nothing.

The ownership of object is specified using own.

new System.Collections.Generic.List<QWebFrame> QtWebKit.QWebFrame.ChildFrames ( )

Returns a list of all frames that are direct children of this frame.

See also parentFrame().

override void QtWebKit.QWebFrame.CreateProxy ( )
virtual

Reimplemented from QtCore.QObject.

new QWebElement QtWebKit.QWebFrame.DocumentElement ( )

Returns the document element of this frame.

The document element provides access to the entire structured content of the frame.

This function was introduced in Qt 4.6.

new object QtWebKit.QWebFrame.EvaluateJavaScript ( string  scriptSource)

Evaluates the JavaScript defined by scriptSource using this frame as context and returns the result of the last executed statement.

See also addToJavaScriptWindowObject() and javaScriptWindowObjectCleared().

new QWebElementCollection QtWebKit.QWebFrame.FindAllElements ( string  selectorQuery)

Returns a new list of elements matching the given CSS selector selectorQuery. If there are no matching elements, an empty list is returned.

Standard CSS2 selector syntax is used for the query.

This function was introduced in Qt 4.6.

See also QWebElement::findAll().

new QWebElement QtWebKit.QWebFrame.FindFirstElement ( string  selectorQuery)

Returns the first element in the frame's document that matches the given CSS selector selectorQuery. If there is no matching element, a null element is returned.

Standard CSS2 selector syntax is used for the query.

This function was introduced in Qt 4.6.

See also QWebElement::findFirst().

new string QtWebKit.QWebFrame.FrameName ( )

The name of this frame as defined by the parent frame.

new QRect QtWebKit.QWebFrame.Geometry ( )

Return the geometry of the frame relative to it's parent frame.

new QWebHitTestResult QtWebKit.QWebFrame.HitTestContent ( QPoint  pos)

Performs a hit test on the frame contents at the given position pos and returns the hit test result.

new void QtWebKit.QWebFrame.Load ( QUrl  url)

Loads url into this frame.

Note: The view remains the same until enough data has arrived to display the new url.

See also setUrl(), setHtml(), and setContent().

new void QtWebKit.QWebFrame.Load ( QNetworkRequest  request,
QNetworkAccessManager.Operation  operation = QNetworkAccessManager.Operation.GetOperation 
)

Loads url into this frame.

Note: The view remains the same until enough data has arrived to display the new url.

See also setUrl(), setHtml(), and setContent().

new void QtWebKit.QWebFrame.Load ( QNetworkRequest  request,
QNetworkAccessManager.Operation  operation,
QByteArray  body 
)

Loads url into this frame.

Note: The view remains the same until enough data has arrived to display the new url.

See also setUrl(), setHtml(), and setContent().

new System.Collections.Generic.Dictionary<System.String,System.String> QtWebKit.QWebFrame.MetaData ( )

Returns the meta data in this frame as a QMultiMap

The meta data consists of the name and content attributes of the of the <meta> tags in the HTML document.

For example:

<html>

<head>

<meta name="description" content="This document is a tutorial about Qt development">

<meta name="keywords" content="Qt, WebKit, Programming">

</head>

...

</html>

Given the above HTML code the metaData() function will return a map with two entries:

KeyValue

"description" "This document is a tutorial about Qt development"

"keywords" "Qt, WebKit, Programming"

This function returns a multi map to support multiple meta tags with the same attribute name.

This function was introduced in Qt 4.5.

new void QtWebKit.QWebFrame.OnContentsSizeChanged ( QSize  size)
protected

This signal is emitted when the frame's contents size changes to size.

This function was introduced in Qt 4.6.

See also contentsSize().

override bool QtWebKit.QWebFrame.OnEvent ( QEvent  arg1)
virtual

Reimplemented from QObject::event().

Reimplemented from QtCore.QObject.

new void QtWebKit.QWebFrame.OnIconChanged ( )
protected

This signal is emitted when the icon ("favicon") associated with the frame has been loaded.

See also icon().

new void QtWebKit.QWebFrame.OnInitialLayoutCompleted ( )
protected

This signal is emitted when the frame is laid out the first time. This is the first time you will see contents displayed on the frame.

Note: A frame can be laid out multiple times.

new void QtWebKit.QWebFrame.OnJavaScriptWindowObjectCleared ( )
protected

This signal is emitted whenever the global window object of the JavaScript environment is cleared, e.g., before starting a new load.

If you intend to add QObjects to a QWebFrame using addToJavaScriptWindowObject(), you should add them in a slot connected to this signal. This ensures that your objects remain accessible when loading new URLs.

new void QtWebKit.QWebFrame.OnLoadFinished ( bool  ok)
protected

This signal is emitted when a load of this frame is finished. ok will indicate whether the load was successful or any error occurred.

This function was introduced in Qt 4.6.

See also loadStarted().

new void QtWebKit.QWebFrame.OnLoadStarted ( )
protected

This signal is emitted when a new load of this frame is started.

This function was introduced in Qt 4.6.

See also loadFinished().

new void QtWebKit.QWebFrame.OnPageChanged ( )
protected

This signal is emitted when this frame has been moved to a different QWebPage.

This function was introduced in Qt 4.7.

See also page().

new void QtWebKit.QWebFrame.OnProvisionalLoad ( )
protected
new void QtWebKit.QWebFrame.OnTitleChanged ( string  title)
protected

This signal is emitted whenever the title of the frame changes. The title string specifies the new title.

See also title().

new void QtWebKit.QWebFrame.OnUrlChanged ( QUrl  url)
protected

This signal is emitted with the URL of the frame when the frame's title is received. The new URL is specified by url.

See also url().

new QWebPage QtWebKit.QWebFrame.Page ( )

The web page that contains this frame.

See also pageChanged().

new QWebFrame QtWebKit.QWebFrame.ParentFrame ( )

Returns the parent frame of this frame, or 0 if the frame is the web pages main frame.

This is equivalent to qobject_cast<QWebFrame*>(frame->parent()).

See also childFrames().

new QPoint QtWebKit.QWebFrame.Pos ( )

Returns the position of the frame relative to it's parent frame.

new void QtWebKit.QWebFrame.Print ( QPrinter  printer)

Prints the frame to the given printer.

See also render().

new void QtWebKit.QWebFrame.Render ( QPainter  arg1)

Render the frame into painter.

new void QtWebKit.QWebFrame.Render ( QPainter  arg1,
QRegion  clip 
)

Render the frame into painter clipping to clip.

new void QtWebKit.QWebFrame.Render ( QPainter  arg1,
QWebFrame.RenderLayer  layer 
)

Render the frame into painter.

new void QtWebKit.QWebFrame.Render ( QPainter  arg1,
QWebFrame.RenderLayer  layer,
QRegion  clip 
)

Render the frame into painter.

new string QtWebKit.QWebFrame.RenderTreeDump ( )

Returns a dump of the rendering tree. This is mainly useful for debugging html.

new void QtWebKit.QWebFrame.Scroll ( int  arg1,
int  arg2 
)

Scrolls the frame dx pixels to the right and dy pixels downward. Both dx and dy may be negative.

This function was introduced in Qt 4.5.

See also QWebFrame::scrollPosition.

new QRect QtWebKit.QWebFrame.ScrollBarGeometry ( Qt.Orientation  orientation)

Returns the geometry for the scrollbar with orientation orientation.

If the scrollbar does not exist an empty rect is returned.

This function was introduced in Qt 4.6.

new int QtWebKit.QWebFrame.ScrollBarMaximum ( Qt.Orientation  orientation)

Returns the maximum value for the scrollbar with orientation orientation, or 0 if no scrollbar is found for orientation.

See also scrollBarMinimum().

new int QtWebKit.QWebFrame.ScrollBarMinimum ( Qt.Orientation  orientation)

Returns the minimum value for the scrollbar with orientation orientation.

The minimum value is always 0.

See also scrollBarMaximum().

new Qt.ScrollBarPolicy QtWebKit.QWebFrame.ScrollBarPolicy ( Qt.Orientation  orientation)

Returns the scrollbar policy for the scrollbar defined by orientation.

See also setScrollBarPolicy().

new int QtWebKit.QWebFrame.ScrollBarValue ( Qt.Orientation  orientation)

Returns the current value for the scrollbar with orientation orientation, or 0 if no scrollbar is found for orientation.

See also setScrollBarValue(), scrollBarMinimum(), and scrollBarMaximum().

new void QtWebKit.QWebFrame.ScrollToAnchor ( string  anchor)

Scrolls the frame to the given anchor name.

This function was introduced in Qt 4.7.

new QWebSecurityOrigin QtWebKit.QWebFrame.SecurityOrigin ( )

Returns the frame's security origin.

This function was introduced in Qt 4.5.

new void QtWebKit.QWebFrame.SetContent ( QByteArray  data,
string  mimeType = "" 
)

Sets the content of this frame to the specified content data. If the mimeType argument is empty it is currently assumed that the content is HTML but in future versions we may introduce auto-detection.

External objects referenced in the content are located relative to baseUrl.

The data is loaded immediately; external objects are loaded asynchronously.

Note: This method will not affect session or global history for the frame.

See also toHtml() and setHtml().

new void QtWebKit.QWebFrame.SetContent ( QByteArray  data,
string  mimeType,
QUrl  baseUrl 
)

Sets the content of this frame to the specified content data. If the mimeType argument is empty it is currently assumed that the content is HTML but in future versions we may introduce auto-detection.

External objects referenced in the content are located relative to baseUrl.

The data is loaded immediately; external objects are loaded asynchronously.

Note: This method will not affect session or global history for the frame.

See also toHtml() and setHtml().

new void QtWebKit.QWebFrame.SetFocus ( )

Gives keyboard input focus to this frame.

This function was introduced in Qt 4.6.

See also hasFocus().

new void QtWebKit.QWebFrame.SetHtml ( string  html)

Sets the content of this frame to html. baseUrl is optional and used to resolve relative URLs in the document, such as referenced images or stylesheets.

The html is loaded immediately; external objects are loaded asynchronously.

If a script in the html runs longer than the default script timeout (currently 10 seconds), for example due to being blocked by a modal JavaScript alert dialog, this method will return as soon as possible after the timeout and any subsequent html will be loaded asynchronously.

When using this method WebKit assumes that external resources such as JavaScript programs or style sheets are encoded in UTF-8 unless otherwise specified. For example, the encoding of an external script can be specified through the charset attribute of the HTML script tag. It is also possible for the encoding to be specified by web server.

This is a convenience function equivalent to setContent(html, "text/html", baseUrl).

Note: This method will not affect session or global history for the frame.

Warning: This function works only for HTML, for other mime types (i.e. XHTML, SVG) setContent() should be used instead.

See also toHtml(), setContent(), and load().

new void QtWebKit.QWebFrame.SetHtml ( string  html,
QUrl  baseUrl 
)

Sets the content of this frame to html. baseUrl is optional and used to resolve relative URLs in the document, such as referenced images or stylesheets.

The html is loaded immediately; external objects are loaded asynchronously.

If a script in the html runs longer than the default script timeout (currently 10 seconds), for example due to being blocked by a modal JavaScript alert dialog, this method will return as soon as possible after the timeout and any subsequent html will be loaded asynchronously.

When using this method WebKit assumes that external resources such as JavaScript programs or style sheets are encoded in UTF-8 unless otherwise specified. For example, the encoding of an external script can be specified through the charset attribute of the HTML script tag. It is also possible for the encoding to be specified by web server.

This is a convenience function equivalent to setContent(html, "text/html", baseUrl).

Note: This method will not affect session or global history for the frame.

Warning: This function works only for HTML, for other mime types (i.e. XHTML, SVG) setContent() should be used instead.

See also toHtml(), setContent(), and load().

new void QtWebKit.QWebFrame.SetScrollBarPolicy ( Qt.Orientation  orientation,
Qt.ScrollBarPolicy  policy 
)

Sets the scrollbar policy for the scrollbar defined by orientation to policy.

See also scrollBarPolicy().

new void QtWebKit.QWebFrame.SetScrollBarValue ( Qt.Orientation  orientation,
int  value 
)

Sets the current value for the scrollbar with orientation orientation.

The scrollbar forces the value to be within the legal range: minimum <= value <= maximum.

Changing the value also updates the thumb position.

See also scrollBarValue(), scrollBarMinimum(), and scrollBarMaximum().

new void QtWebKit.QWebFrame.SetTextSizeMultiplier ( double  factor)
new void QtWebKit.QWebFrame.SetZoomFactor ( double  factor)
new double QtWebKit.QWebFrame.textSizeMultiplier ( )
new string QtWebKit.QWebFrame.ToHtml ( )

Returns the frame's content as HTML, enclosed in HTML and BODY tags.

See also setHtml() and toPlainText().

new string QtWebKit.QWebFrame.ToPlainText ( )

Returns the content of this frame converted to plain text, completely stripped of all HTML formatting.

See also toHtml().

static string QtWebKit.QWebFrame.Tr ( string  s,
string  c = null 
)
static
static string QtWebKit.QWebFrame.Tr ( string  s,
string  c,
int  n 
)
static
static string QtWebKit.QWebFrame.TrUtf8 ( string  s,
string  c = null 
)
static
static string QtWebKit.QWebFrame.TrUtf8 ( string  s,
string  c,
int  n 
)
static
new double QtWebKit.QWebFrame.zoomFactor ( )

Property Documentation

new QUrl QtWebKit.QWebFrame.BaseUrl
get

This property holds the base URL of the frame, can be used to resolve relative URLs.

This property was introduced in Qt 4.6.

new QSize QtWebKit.QWebFrame.ContentsSize
get

This property holds the size of the contents in this frame.

Slot<QSize> QtWebKit.QWebFrame.ContentsSizeChanged
addremove

This signal is emitted when the frame's contents size changes to size.

This function was introduced in Qt 4.6.

See also contentsSize().

new IQWebFrameSignals QtWebKit.QWebFrame.Emit
getprotected
new bool QtWebKit.QWebFrame.Focus
get
new QIcon QtWebKit.QWebFrame.Icon
get

This property holds the icon associated with this frame.

Slot QtWebKit.QWebFrame.IconChanged
addremove

This signal is emitted when the icon ("favicon") associated with the frame has been loaded.

See also icon().

Slot QtWebKit.QWebFrame.InitialLayoutCompleted
addremove

This signal is emitted when the frame is laid out the first time. This is the first time you will see contents displayed on the frame.

Note: A frame can be laid out multiple times.

Slot QtWebKit.QWebFrame.JavaScriptWindowObjectCleared
addremove

This signal is emitted whenever the global window object of the JavaScript environment is cleared, e.g., before starting a new load.

If you intend to add QObjects to a QWebFrame using addToJavaScriptWindowObject(), you should add them in a slot connected to this signal. This ensures that your objects remain accessible when loading new URLs.

Slot<System.Boolean> QtWebKit.QWebFrame.LoadFinished
addremove

This signal is emitted when a load of this frame is finished. ok will indicate whether the load was successful or any error occurred.

This function was introduced in Qt 4.6.

See also loadStarted().

Slot QtWebKit.QWebFrame.LoadStarted
addremove

This signal is emitted when a new load of this frame is started.

This function was introduced in Qt 4.6.

See also loadFinished().

Slot QtWebKit.QWebFrame.PageChanged
addremove

This signal is emitted when this frame has been moved to a different QWebPage.

This function was introduced in Qt 4.7.

See also page().

Slot QtWebKit.QWebFrame.ProvisionalLoad
addremove
new QUrl QtWebKit.QWebFrame.RequestedUrl
get
new QPoint QtWebKit.QWebFrame.ScrollPosition
getset

This property holds the position the frame is currently scrolled to.

This property was introduced in Qt 4.5.

new QMetaObject QtWebKit.QWebFrame.StaticMetaObject
staticget
new double QtWebKit.QWebFrame.TextSizeMultiplier
getset
new string QtWebKit.QWebFrame.Title
get

This property holds the title of the frame as defined by the HTML <title> element.

Slot<System.String> QtWebKit.QWebFrame.TitleChanged
addremove

This signal is emitted whenever the title of the frame changes. The title string specifies the new title.

See also title().

new QUrl QtWebKit.QWebFrame.Url
getset

This property holds the url of the frame currently viewed.

Setting this property clears the view and loads the URL.

By default, this property contains an empty, invalid URL.

Slot<QUrl> QtWebKit.QWebFrame.UrlChanged
addremove

This signal is emitted with the URL of the frame when the frame's title is received. The new URL is specified by url.

See also url().

new double QtWebKit.QWebFrame.ZoomFactor
getset

This property holds the zoom factor for the frame.

This property was introduced in Qt 4.5.