class KHTMLPart

 HTML Browser Widget. More...
Definition#include <khtml_part.h>
InheritsKParts::ReadOnlyPart (kparts) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Slots

Signals

Protected Methods

Protected Slots

Detailed Description

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 an 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 are disabled. You can enable them 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. You should use one or the other (but not both) since the method using the char * argument does an additional decoding step to convert the written data to Unicode.

enum GUIProfile { DefaultGUI, BrowserViewGUI }; }

 KHTMLPart ( QWidget *parentWidget = 0, const char *widgetname = 0, QObject *parent = 0, const char *name = 0, GUIProfile prof = DefaultGUI )

Construct 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.

 KHTMLPart ( KHTMLView *view, QObject *parent = 0, const char *name = 0, GUIProfile prof = DefaultGUI )

 ~KHTMLPart ()

[virtual]

Destructor.

bool  openURL ( const KURL &url )

[virtual]

Opens the specified URL url.

Reimplemented from KParts::ReadOnlyPart::openURL .

Reimplemented from ReadOnlyPart.

bool  closeURL ()

[virtual]

Stop loading the document and kill all data requests (for images, etc.)

Reimplemented from ReadOnlyPart.

DOM::HTMLDocument  htmlDocument ()

[const]

Retrieve a reference to the DOM HTML document (for non-HTML documents, returns null)

DOM::Document  document ()

[const]

Retrieve a reference to the DOM document.

DOM::Node  activeNode ()

[const]

Retrieve the node that has the keyboard focus

KParts::BrowserExtension * browserExtension ()

[const]

Retrieve a pointer to the KParts::BrowserExtension

KHTMLView * view ()

[const]

Retrieve a pointer to the HTML document's view.

void  setJScriptEnabled ( bool enable )

Enable/disable Javascript support. Note that this will in either case permanently override the default usersetting. If you want to have the default UserSettings, don't call this method.

void  enableJScript ( bool enable )

Deprecated, use setJScriptEnabled instead.

bool  jScriptEnabled ()

[const]

Returns true if Javascript support is enabled or false otherwise.

void  enableMetaRefresh ( bool enable )

Enable/disable the automatic forwarding by <meta http-equiv="refresh" ....>

bool  metaRefreshEnabled ()

[const]

Returns true if automtaic forwarding is enabled.

QVariant  executeScript ( const QString &script )

Execute the specified snippet of JavaScript code.

Returns true if JavaScript was enabled, no error occured and the code returned true itself or false otherwise.

QVariant  executeScript ( const DOM::Node &n, const QString &script )

Same as above except the Node parameter specifying the 'this' value.

void  setDNDEnabled ( bool b )

Enable or disable Drag'n'Drop support. A drag operation is started if the users drags a link.

bool  dndEnabled ()

[const]

Returns whether Dragn'n'Drop support is enabled or not.

void  setJavaEnabled ( bool enable )

Enable/disable Java applet support. Note that calling this function will permanently override the User settings about Java applet support. Not calling this function is the only way to let the default settings apply.

void  enableJava ( bool enable )

Deprecated, use setJavaEnabled instead.

bool  javaEnabled ()

[const]

Return if Java applet support is enabled/disabled.

KJavaAppletContext * javaContext ()

Return the java context of the applets. If no applet exists, 0 is returned.

KJavaAppletContext * createJavaContext ()

Return the java context of the applets. If no context exists yet, a new one is created.

void  enablePlugins ( bool enable )

Deprecated. Use setPluginsEnabled instead.

void  setPluginsEnabled ( bool enable )

Enable or disable plugins via, default is enabled

bool  pluginsEnabled ()

[const]

Return if plugins are enabled/disabled.

void  autoloadImages ( bool enable )

Deprecated. Use setAutoloadImages instead.

void  setAutoloadImages ( bool enable )

Specify whether images contained in the document should be loaded automatically or not.

bool  autoloadImages ()

[const]

Return whether images contained in the document are loaded automatically or not.

void  begin ( const KURL &url = KURL(), int xOffset = 0, int yOffset = 0 )

[virtual]

Clear 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:
urlis 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.
xOffsetis the initial horizontal scrollbar value. Usually you don't want to use this.
yOffsetis the initial vertical scrollbar value. Usually you don't want to use this.

void  write ( const char *str, int len = -1 )

[virtual]

Write another part of the HTML code to the widget.

You may call this function many times in sequence. But remember: The fewer calls you make, the faster the widget will be.

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  write ( const QString &str )

[virtual]

Write another part of the HTML code to the widget.

You may call this function many times in sequence. But remember: The fewer calls you make, the faster the widget will be.

void  end ()

[virtual]

Call this after your last call to write().

void  paint (QPainter *, const QRect &, int = 0, bool * = 0)

Paints the HTML page to a QPainter. See KHTMLView::paint for details

void  setBaseURL ( const KURL &url )

Mainly used internally.

Sets the document's base URL.

KURL  baseURL ()

[const]

Retrieve the base URL of this document

The base URL is ususally set by a <base url=...> tag in the document head. If no base tag is set, the url of the current document serves as base url and is returned.

void  setBaseTarget ( const QString &target )

Mainly used internally.

Sets the document's base target.

QString  baseTarget ()

[const]

Retrieve the base target of this document.

The base target is ususally set by a <base target=...> tag in the document head.

KURL  completeURL ( const QString &url, const QString &target = QString::null )

Constructs a KURL object (representing an absolute URL) given a possibly relative URL (for example from a document's anchor) .

void  scheduleRedirection ( int delay, const QString &url )

bool  setCharset ( const QString &name, bool override = false )

Set the charset to use for displaying HTML pages.

If override is true, it will override charset specifications of the document.

bool  setEncoding ( const QString &name, bool override = false )

Set the encoding the page uses.

This can be different from the charset. The widget will try to reload the current page in the new encoding, if url() is not empty.

QString  encoding ()

return the encoding the page currently uses.

Note that the encoding might be different from the charset.

void  setUserStyleSheet (const KURL &url)

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  setUserStyleSheet (const QString &styleSheet)

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  setFontSizes (const QValueList<int> &newFontSizes )

Set 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>  fontSizes ()

[const]

Get 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  resetFontSizes ()

Reset 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 0 (smallest) to 6 (biggest).

void  setStandardFont ( const QString &name )

Set the standard font style.

Parameters:
nameThe font name to use for standard text.

void  setFixedFont ( const QString &name )

Set the fixed font style.

Parameters:
nameThe font name to use for fixed text, e.g. the <tt>&lt;pre&gt;</tt> tag.

bool  gotoAnchor ( const QString &name )

Find the anchor named name.

If the anchor is found, the widget scrolls to the closest position. Returns if the anchor has been found.

void  setURLCursor ( const QCursor &c )

Set the cursor to use when the cursor is on a link.

const QCursor&  urlCursor ()

[const]

Retrieve the cursor which is used when the cursor is on a link.

void  findTextBegin ()

Initiate a text search.

bool  findTextNext ( const QRegExp &exp, bool forward )

Find the next occurrance of the expression.

bool  findTextNext ( const QString &str, bool forward, bool caseSensitive )

Find the next occurence of the string.

QString  selectedText ()

[const virtual]

Get the text the user has marked.

DOM::Range  selection ()

[const]

Retrieve the selected part of the HTML.

void  setSelection ( const DOM::Range & )

set the current selection

bool  hasSelection ()

[const]

Has the user selected anything?

Call selectedText() to retrieve the selected text.

Returns: true if there is text selected.

void  selectAll ()

Marks all text in the document as selected.

void  show ()

Convenience method to show the document's view.

Equivalent to widget()->show() or view()->show() .

void  hide ()

Convenience method to hide the document's view.

Equivalent to widget()->hide() or view()->hide().

KParts::PartManager * partManager ()

Retrieve a reference to the partmanager instance which manages html frame objects.

void  saveState ( QDataStream &stream )

[virtual]

Save the KHTMLPart's complete state (including child frame objects) to the provided QDataStream.

This is called from the saveState() method of the browserExtension().

void  restoreState ( QDataStream &stream )

[virtual]

Restore the KHTMLPart's previously saved state (including child frame objects) from the provided QDataStream.

This is called from the restoreState() method of the browserExtension() .

See also: saveState()

bool  restoreURL ( const KURL &url )

Internal method called by restoreState() when the document, which is to be restored, is contained in the html page-cache.

DOM::Node  nodeUnderMouse ()

[const]

Retrieve the Node currently under the mouse

const KHTMLSettings * settings ()

[const]

KHTMLPart * parentPart ()

Retrieve a pointer to the parent KHTMLPart if the part is a frame in an HTML frameset.

Returns 0L otherwise.

QStringList  frameNames ()

[const]

Retrieve a list of names of all frame (including iframe) objects of the current document. Note that this method is not working recursively for sub-frames.

const QList<KParts::ReadOnlyPart>  frames ()

[const]

KHTMLPart * findFrame ( const QString &f )

Find a frame by name. Returns 0L if frame can't be found.

bool  frameExists ( const QString &frameName )

Returns whether a frame with the specified name is exists or not. In contrary to the findFrame method this one also returns true if the frame is defined but no displaying component has been found/loaded, yet.

bool  openURLInFrame ( const KURL &url, const KParts::URLArgs &urlArgs )

The real implementation of the openURLInFrame method of KParts::BrowserExtension, called by khtml's implementation of the BrowserExtension interface.

void  setJSStatusBarText ( const QString &text )

Called by KJS. Sets the StatusBarText assigned via window.status

void  setJSDefaultStatusBarText ( const QString &text )

Called by KJS. Sets the DefaultStatusBarText assigned via window.defaultStatus

QString  jsStatusBarText ()

[const]

Called by KJS. Returns the StatusBarText assigned via window.status

QString  jsDefaultStatusBarText ()

[const]

Called by KJS. Returns the DefaultStatusBarText assigned via window.defaultStatus

void  onURL ( const QString &url )

[signal]

Emitted if the cursor is moved over an URL.

void  popupMenu (const QString &url, const QPoint &point)

[signal]

Emitted when the user clicks the right mouse button on the document.

void  selectionChanged ()

[signal]

This signal is emitted when the selection changes.

void  nodeActivated (const DOM::Node &)

[signal]

This signal is emitted when an element retrieves the keyboard focus. Note that the signal argument can be a null node if no element is active, meaning a node has explicitly been deactivated without a new one becoming active.

bool  event ( QEvent *event )

[protected: virtual]

Reimplementation of KParts::ReadOnlyPart::event .

bool  eventFilter ( QObject *o, QEvent *event )

[protected: virtual]

Reimplementation of QObject::eventFilter .

void  khtmlMousePressEvent ( khtml::MousePressEvent *event )

[protected: virtual]

Eventhandler of the khtml::MousePressEvent.

void  khtmlMouseDoubleClickEvent ( khtml::MouseDoubleClickEvent * )

[protected: virtual]

Eventhandler for the khtml::MouseDoubleClickEvent.

void  khtmlMouseMoveEvent ( khtml::MouseMoveEvent *event )

[protected: virtual]

Eventhandler for the khtml::MouseDoubleClickEvent.

void  khtmlMouseReleaseEvent ( khtml::MouseReleaseEvent *event )

[protected: virtual]

Eventhandler for the khtml::MouseMoveEvent.

void  khtmlDrawContentsEvent ( khtml::DrawContentsEvent * )

[protected: virtual]

Eventhandler for the khtml::DrawContentsEvent.

void  guiActivateEvent ( KParts::GUIActivateEvent *event )

[protected: virtual]

Internal reimplementation of KParts::Part::guiActivateEvent .

Reimplemented from ReadOnlyPart.

bool  openFile ()

[protected: virtual]

Internal empty reimplementation of KParts::ReadOnlyPart::openFile .

Reimplemented from ReadOnlyPart.

void  overURL ( const QString &url, const QString &target )

[protected: virtual]

void  urlSelected ( const QString &url, int button = 0, int state = 0, const QString &_target = QString::null )

[protected: virtual]

bool  processObjectRequest ( khtml::ChildFrame *child, const KURL &url, const QString &mimetype )

[protected: ]

void  submitForm ( const char *action, const QString &url, const QByteArray &formData, const QString &target, const QString& contentType = QString::null, const QString& boundary = QString::null )

[protected: virtual]

void  popupMenu ( const QString &url )

[protected: virtual]

KParts::ReadOnlyPart * createPart ( QWidget *parentWidget, const char *widgetName, QObject *parent, const char *name, const QString &mimetype, QString &serviceName, QStringList &serviceTypes, const QStringList &params)

[protected: virtual]

This method is called when a new embedded object (include html frames) is to be created. Reimplement it if you want to add support for certain embeddable objects without registering them in the KDE wide registry system (KSyCoCa) . Another reason for re-implementing this method could be if you want to derive from KTHMLPart and also want all html frame objects to be a object of your derived type, in which case you should return a new instance for the mimetype 'text/html' .

void  updateFontSize ( int add )

[protected: ]

void  setFontBaseInternal ( int base, bool absolute )

[protected: ]

void  setActiveNode (const DOM::Node &)

[slot]

Call this method to explicitly pass the focus to a certain element of the current document.

void  reparseConfiguration ()

[protected slots: slot]

Internal. Called by the BrowserExtension .

void  emitSelectionChanged ()

[protected: ]