|
|
This class is khtml's main class. It features an almost complete web browser, and html renderer.
The easiest way to use this class (if you just want to display a HTML page at some URL) is the following:
KURL url = "http://www.kde.org"; KHTMLPart *w = new KHTMLPart(); w->openURL(url); w->view()->resize(500, 400); w->show();
By default Java and JavaScript support is disabled. You can enable it by using the enableJava() and enableJScript() methods.
Some apps want to write their HTML code directly into the widget instead of it opening an url. You can also do that in the following way:
QString myHTMLCode = ...; KHTMLPart *w = new KHTMLPart(); w->begin(); w->write(myHTMLCode); ... w->end();
You can do as many calls to write as you want. But there are two write() methods, one accepting a QString one accepting a char * argument. These should not get mixed, since the method usnig the char * argument does an additional decoding step to convert the written data to Unicode.
|
Constructs a new KHTMLPart.
KHTML basically consists of two objects: The KHTMLPart itself, holding the document data
(DOM document), and the KHTMLView, derived from QScrollview, in which the document content is
rendered in. You can specify two different parent objects for a KHTMLPart, one parent for the
KHTMLPart document and on parent for the KHTMLView. If the second parent
argument is 0L, then
parentWidget
is used as parent for both objects, the part and the view.
~ |
[virtual]
Destructor
bool |
[virtual]
Reimplemented from KParts::ReadOnlyPart::openURL . Opens the specified url url
.
Reimplemented from ReadOnlyPart
bool |
[virtual]
Stops loading the document and kills all data requests (for images, etc.)
Reimplemented from ReadOnlyPart
DOM::HTMLDocument |
[const]
Retrieve a reference to the DOM document.
KHTMLPartBrowserExtension * |
[const]
Retrieve a pointer to the KParts::BrowserExtension
KHTMLView * |
[const]
Retrieve a pointer to the html document's view.
void |
Enable/disable Javascript support.
bool |
[const]
Return if Javascript support is enabled/disabled.
void |
Enable/disable Java applet support.
bool |
[const]
Return if Java applet support is enabled/disabled.
void |
should images be loaded automatically? Default is true. (not implemented at the moment)
void |
[virtual]
Clears the widget and prepares it for new content. If you want url() to return for example "file:/tmp/test.html", you can use the following code:
view->begin( KURL("file:/tmp/test.html" ) );
All child frames and the old document are removed if you call this method.
Parameters:
url | is the url of the document to be displayed. Even if you are generating the HTML on the fly, it may be useful to specify a directory so that any pixmaps are found. |
xOffset | is the initial horizontal scrollbar value. Usually you don't want to use this. |
yOffset | is the initial vertical scrollbar value. Usually you don't want to use this. |
void |
[virtual]
Writes another part of the HTML code to the widget. You may call this function many times in sequence. But remember: The less calls the faster the widget is.
The html code is send through a decoder, which decodes the stream to unicode.
The len parameter is needed for streams encoded in utf-16, since these can have \0 chars in them. In case the encoding you're using isn't utf-16, you can safely leave out the length parameter.
Attention: Don't mix calls to write( const char *) with calls to write( const QString & ). The result might not be what you want.
void |
[virtual]
Writes another part of the HTML code to the widget. You may call this function many times in sequence. But remember: The less calls the faster the widget is.
void |
[virtual]
Call this after your last call to write.
void |
Mainly used internally. Sets the document's base URL
KURL |
[const]
The base url is ususally set by an <base url=...> tag in the document head.
Returns: the base URL of this document
void |
Mainly used internally. Sets the document's base target.
QString |
[const]
Returns: the base target of this document The base target is ususally set by an <base target=...> tag in the document head.
KURL |
void |
bool |
sets the charset to use for displaying html pages. If override is true, it will override charset specifications of the document.
bool |
set the encoding the page uses. This can be different form the charset.
void |
set a user defined style sheet to be used on top of the HTML 4 default style sheet. This gives a wide range of possibilities to change the layout of the page
void |
set a user defined style sheet to be used on top of the HTML 4 default style sheet. This gives a wide range of possibilities to change the layout of the page
void |
Sets point sizes to be associated with the HTML-sizes used in <FONT size=Html-Font-Size>
Html-Font-Sizes range from 0 (smallest) to 6 (biggest), but you can specify up to 15 font sizes, the bigger ones will get used, if <font size=+1> extends over 7, or if a 'font-size: larger' style declaration gets into this region.
They are related to the CSS font sizes by 0 == xx-small to 6 == xx-large.
QValueList<int> |
[const]
Gets point sizes to be associated with the HTML-sizes used in <FONT size=Html-Font-Size>
Html-Font-Sizes range from 0 (smallest) to 6 (biggest).
They are related to the CSS font sizes by 0 == xx-small to 6 == xx-large.
void |
Resets the point sizes to be associated with the HTML-sizes used in <FONT size=Html-Font-Size> to their default.
Html-Font-Sizes range from 1 (smallest) to 7 (biggest).
void |
Sets the standard font style.
Parameters:
name | is the font name to use for standard text. |
void |
Sets the fixed font style.
Parameters:
name | is the font name to use for fixed text, e.g. the <tt><pre></tt> tag. |
bool |
Find the anchor named '_name'. If the anchor is found, the widget scrolls to the closest position. Returns TRUE if the anchor has been found.
void |
Sets the cursor to use when the cursor is on a link. (convenience function, just calls htmlWidget->setURLCursor() )
const QCursor& |
[const]
Returns the cursor which is used when the cursor is on a link. (convenience function, just cals htmlWidget->urlCursor() )
void |
Initiate a text search.
bool |
Find the next occurrance of the expression.
QString |
[const virtual]
Get the text the user has marked.
DOM::Range |
[const]
Returns: the selected part of the HTML
bool |
[const]
Has the user selected anything? Call selectedText to retrieve the selected text.
Returns: true if there is text selected.
void |
Convenience method to show the document's view. Equivalent to widget()->show() or view()->show() .
void |
Convenience method to hide the document's view. Equivalent to widget()->hide() or view()->hide() .
KParts::PartManager * |
void |
[virtual]
Save the KHTMLPart's complete state (including child frame objects) to the provided QDataStream. You can use this method to provide history functionality.
This is called from the saveState method of the browserExtension .
void |
[virtual]
Restore the KHTMLPart's previously saved state (including child frame objects) from the provided QDataStream. See saveState.
This is called from the restoreState method of the browserExtension .
DOM::Node |
[const]
Returns: the Node, currently under the mouse
const khtml::Settings * |
[const]
KHTMLPart * |
Returns a pointer to the parent KHTMLPart if the part is a frame in a html frameset. (returns 0L otherwise)
void |
[signal]
This signal is emitted if the cursor is moved over an URL.
void |
[signal]
This signal is emitted when the user clicks the right mouse button on the document.
bool |
[protected virtual]
Internal empty reimplementation of KParts::ReadOnlyPart::openFile .
Reimplemented from ReadOnlyPart
void |
[protected virtual]
void |
[protected virtual]
void |
[protected]
void |
[protected virtual]
void |
[protected virtual]
KParts::ReadOnlyPart * |
[protected virtual]
bool |
[protected virtual]
derived classes can use this hook to filter out key events from the KHTMLView.
bool |
[protected virtual]
derived classes can use this hook to filter out key events from the KHTMLView.
bool |
[protected virtual]
derived classes can use this hook to filter out mouse events from the KHTMLView.
bool |
[protected virtual]
derived classes can use this hook to filter out mouse events from the KHTMLView.
bool |
[protected virtual]
derived classes can use this hook to filter out mouse events from the KHTMLView.
bool |
[protected virtual]
derived classes can use this hook to filter out mouse events from the KHTMLView.
void |
[protected virtual]
derived classes can use this hook to process paint events from the KHTMLView.
void |
[protected]
Internal. Called by the BrowserExtension .