webview

Provides web support in a widget using webkit.
Inherits
object widget
Description
Provides an embedded web browser using webkit.
Functions
$load(<url:string>)
Sets the current url for the webView and starts loading it
$findText(<txt:string>,[flag 1,flag 2,..;string])
Finds the specified string, in the page, using the given options. Valid flags are:
 FindBackward        - Searches backwards instead of forwards; FindCaseSensitively    - Changes the behaviour to a case sensitive find operation. FindWrapsAroundDocument    - Restart from the beginning of the document if the end was reached and the text was not found. HighlightAllOccurrences    - Highlights all existing occurrences. 
array $frames()
Returns an array containing the names of the document frames.
$firstChild()
Sets the first child of the current element as the new current element. Returns true if the current element has been changed.
$findAll(<query:string>)
Searches for all the elements named <query> and stores them in a collection
$findFirst(<query:string>)
Searches for the first element named <query>; returns true if an element have been found, false if not.
$parentElement()
Sets the parent of the current element as the new current element. Returns true if the current element has been changed.
$nextSibling()
Sets the element just after the current one as the new current element. Returns true if the current element has been changed.
$currentElementTagName()
Returns the tag name of the current element
$moveToQueryResultsAt(<index:int>)
Changes the current element to the <index>th element of the collection
int $queryResultsCount()
Returns the number of elements in the collection
$getDocumentElement([frame_name:string])
Sets the document element of the frame [frame_name] as the current element. If no value has been specified for [frame_name] or [frame_name] is empty, the main frame of the page will be used.
string $attributeNames()
Returns a comma-separated list of the attribute names set on the current element
string $attribute(<name:string>)
Returns the value of the attribute <name> for the current element.
pixmap $makePreview()
Returns a 212x142 thumbnail of the current webView contants. The returned object is an instance of the pixmap class.
string $rememberCurrent()
Returns the id of the current web element and stores it in a cache
$moveTo(<id:string>)
Changes the current element to <id>
string $toPlainText()
Returns the string representation of the current element.
string $setPlainText()
Set the string representation of the current element
$setAttribute(<name:string>,<value:string>)
Sets the attribute <name> with value <value> to the current element
$setWebSetting(<name:string>,<value:bool>)
Enables or disables the <name> setting depending on <value>. Valid settings name: JavascriptEnabled, PluginsEnabled, JavascriptCanOpenWindows, JavascriptCanAccessClipboard, ZoomTextOnly, LocalContentCanAccessFileUrls.
$removeFromDocument()
Removes the current element from the document. The parent element is set as the new current element.
$removeClass(<class_name:string>)
Removes a class from the current element
string $classes()
Returns a comma-separated list of classes set on the current element
$setLinkDelegationPolicy(<policy:string>)
Sets the link delegation policy: what happens when the users click on a link. Valid values:
DontDelegateLinks: No links are delegated. Instead, webView tries to handle them all.
DelegateExternalLinks: When activating links that point to documents not stored on the local filesystem or an equivalent then $linkClickedEvent() is executed.
DelegateAllLinks: Whenever a link is activated the $linkClickedEvent() is executed.    
$linkClickedEvent()
This function can be called when the user clicks on a link, depending no the current link delegation policy. The argument of the function is the url that has been clicked.
The default implementation emits the $linkclicked() signal.
$loadStartedEvent()
This function is called when the load of the page has started. The default implementation emits the $loadstarted() signal.
$loadProgressEvent()
This function can be called during the page load progress. The argument of the function is an int value that represent the loading progress status, ranging from 0 to 100.
The default implementation emits the $loadprogress() signal.
$loadFinishedEvent()
This function is called when the load of the page has finished. The argument of the function is a bool value that is true if the page has been loaded successfully, false otherwise.
The default implementation emits the $loadfinished() signal.
$downloadRequestEvent()
This function is called when the user tries to download a file. The argument of the function is the url of the file.
You should return a valid path in the filesystem where to save the file.
The default implementation emits the $downloadrequest() signal.
$downloadProgressEvent()
This function can be called during the download of a file. Three integer arguments are passed to this function: the number of downloaded bytes, the download id, the size of the remove file (if known). The default implementation emits the $downloadprogress() signal.
$downloadCompletedEvent()
This function can be called when a file download finishes. The argument of the function is the an integer value containing the download id. The default implementation emits the $downloadcompleted() signal.
Signals
linkClicked()
This signal is emitted by the default implementation of [classfnc:webview]linkClickedEvent[/classfnc]().
loadStarted()
This signal is emitted by the default implementation of [classfnc:webview]loadStartedEvent[/classfnc]().
loadProgress()
This signal is emitted by the default implementation of [classfnc:webview]loadProgressEvent[/classfnc]().
loadFinished()
This signal is emitted by the default implementation of [classfnc:webview]loadFinishedEvent[/classfnc]().
downloadRequest()
This signal is emitted by the default implementation of [classfnc:webview]downloadRequestEvent[/classfnc]().
downloadProgress()
This signal is emitted by the default implementation of [classfnc:webview]downloadProgressEvent[/classfnc]().
downloadCompleted()
This signal is emitted by the default implementation of [classfnc:webview]downloadCompletedEvent[/classfnc]().

Index, Object Classes
KVIrc 4.1.3.5988 Documentation
Generated by pbuilder at Wed Sep 12 22:17:55 2012