Difference between revisions of "Projects/WebKit/Library"

Jump to: navigation, search
(Update documentation)
Line 2: Line 2:
  
 
== About ==
 
== About ==
The WebKitKDE library sits on top of QtWebKit, providing KDE integration (for example, WebActions using KDE icons and shortcuts, downloading using KIO, etc). WebKitKDE provides the following classes:
+
The [http://api.kde.org/4.x-api/kdelibs-apidocs/kdewebkit/html/index.html KDEWebKit] library sits on top of QtWebKit, providing KDE integration (for example, WebActions using KDE icons and shortcuts, downloading using KIO, etc).
  
=== KWebView ===
+
See the following link for a list of all classes:
A QWebView with KDE integration.
+
http://api.kde.org/4.x-api/kdelibs-apidocs/kdewebkit/html/annotated.html
* KWebPage* KWebView::page() : Overridden from QWebView, it return a KWebPage instead of a QWebPage.
+
* QWidget* KWebView::searchBar() : Get a search bar widget, usable for searching the page.
+
* void setCustomContextMenu(bool) [slot] : Should KWebView use it's own context menu, or should it emit a signal on right-click.
+
* void showContextMenu() [signal] : If setCustomContextMenu is set to true, this signal will be emited when the user right-clicks on the page.
+
* void openUrlInNewTab(const KUrl) [signal] : When the user middle-clicks a link, instead of opening it, KWebView will emit this signal. In tab-enabled browsers, this usually results in opening a new tab.
+
* void load(const KUrl&, const KParts::OpenUrlArguments&, const KParts::BrowserArguments&) : convenience function similar to QWebView::load(), but for KParts-style arguments instead.
+
  
=== KWebPage ===
+
=== KIO::Integration::AccessManger, KIO::Integration::AccessMangerReply (before: KNetworkAccessManager, KNetworkReply) ===
A QWebPage with KDE integration.
+
Overwrites the default QtNetwork based QNetworkAccessManager for KIO-based network-interaction. Also supplies a few special additions (like the rest of KDEWebKit does).
* void setAllowExternalContent(bool) : Useful for, as an example, email applications: should this KWebPage be allowed to request content from the web?
+
* bool isExternalContentAllowed() : Will this KWebPage load content from the web?
+
  
=== KIO/AccessManger, KIO/AccessMangerReply (before: KNetworkAccessManager, KNetworkReply) ===
+
See:
Overwrites the default QtNetwork based QNetworkAccessManager for KIO-based network-interaction. Also supplies a few special additions (like the rest of WebKitKDE does).
+
http://api.kde.org/4.x-api/kdelibs-apidocs/kio/html/classKIO_1_1AccessManager.html
* void setAllowExternalContent(bool) : Should this AccessManager load content from the web?
+
* bool isExternalContentAllowed() : Will this AccessManager load content from the web?
+

Revision as of 16:04, 15 November 2009

This page is still work in progress.

About

The KDEWebKit library sits on top of QtWebKit, providing KDE integration (for example, WebActions using KDE icons and shortcuts, downloading using KIO, etc).

See the following link for a list of all classes: http://api.kde.org/4.x-api/kdelibs-apidocs/kdewebkit/html/annotated.html

KIO::Integration::AccessManger, KIO::Integration::AccessMangerReply (before: KNetworkAccessManager, KNetworkReply)

Overwrites the default QtNetwork based QNetworkAccessManager for KIO-based network-interaction. Also supplies a few special additions (like the rest of KDEWebKit does).

See: http://api.kde.org/4.x-api/kdelibs-apidocs/kio/html/classKIO_1_1AccessManager.html


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal