KHTML

KHTMLPart Class Reference

#include <khtml_part.h>

Inheritance diagram for KHTMLPart:

[legend]

List of all members.

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 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();

Java and JavaScript are enabled by default depending on the user's settings. If you do not need them, and especially if you display unfiltered data from untrusted sources, it is strongly recommended to turn them off. In that case, you should also turn off the automatic redirect and plugins:

 w->setJScriptEnabled(false);
 w->setJavaEnabled(false);
 w->setMetaRefreshEnabled(false);
 w->setPluginsEnabled(false);

You may also wish to disable external references. This will prevent KHTML from loading images, frames, etc, or redirecting to external sites.

 w->setOnlyLocalReferences(true);

Some apps want to write their HTML code directly into the widget instead of opening an url. You can do this 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 wish. There are two write() methods, one accepting a QString and 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.

It is also possible to write content to the HTML part using the standard streaming API from KParts::ReadOnlyPart. The usage of the API is similar to that of the begin(), write(), end() process described above as the following example shows:

 KHTMLPart *doc = new KHTMLPart();
 doc->openStream( "text/html", KUrl() );
 doc->writeStream( QCString( "<html><body><p>KHTML Rocks!</p></body></html>" ) );
 doc->closeStream();

HTML Browser Widget

Author:: Lars Knoll (knoll@kde.org)

Definition at line 186 of file khtml_part.h.


Public Types
enum	GUIProfile { DefaultGUI, BrowserViewGUI }
enum	CaretDisplayPolicy { CaretVisible, CaretInvisible, CaretBlink }
enum	FindOptions { FindLinksOnly = 1 * KFind::MinimumUserOption, FindNoPopups = 2 * KFind::MinimumUserOption }
enum	FormNotification { NoNotification = 0, Before, Only, Unused = 255 }
Public Slots
void	setActiveNode (const DOM::Node &node)
void	stopAnimations ()
QVariant	executeScript (const QString &script)
void	setCaretMode (bool enable)
void	setEditable (bool enable)
void	setCaretVisible (bool show)
void	submitFormProxy (const char *action, const QString &url, const QByteArray &formData, const QString &target, const QString &contentType=QString(), const QString &boundary=QString())
Signals
void	onURL (const QString &url)
void	popupMenu (const QString &url, const QPoint &point)
void	selectionChanged ()
void	nodeActivated (const DOM::Node &)
void	docCreated ()
void	caretPositionChanged (const DOM::Node &node, long offset)
void	formSubmitNotification (const char *action, const QString &url, const QByteArray &formData, const QString &target, const QString &contentType, const QString &boundary)
void	configurationChanged ()
Public Member Functions
	KHTMLPart (QWidget parentWidget=0, QObject parent=0, GUIProfile prof=DefaultGUI)
	KHTMLPart (KHTMLView view, QObject parent=0, GUIProfile prof=DefaultGUI)
virtual	~KHTMLPart ()
virtual bool	openUrl (const KUrl &url)
virtual bool	closeUrl ()
virtual void	showError (KJob *job)
DOM::HTMLDocument	htmlDocument () const
DOM::Document	document () const
QString	documentSource () const
DOM::Node	activeNode () const
KParts::BrowserExtension *	browserExtension () const
KParts::BrowserHostExtension *	browserHostExtension () const
KHTMLView *	view () const
void	setJScriptEnabled (bool enable)
bool	jScriptEnabled () const
KJS::Interpreter *	jScriptInterpreter ()
void	setStatusMessagesEnabled (bool enable)
bool	statusMessagesEnabled () const
void	setMetaRefreshEnabled (bool enable)
bool	metaRefreshEnabled () const
QVariant	executeScript (const DOM::Node &n, const QString &script)
void	setDNDEnabled (bool b)
bool	dndEnabled () const
void	setJavaEnabled (bool enable)
bool	javaEnabled () const
void	setPluginsEnabled (bool enable)
bool	pluginsEnabled () const
void	setAutoloadImages (bool enable)
bool	autoloadImages () const
void	setOnlyLocalReferences (bool enable)
bool	onlyLocalReferences () const
bool	isCaretMode () const
bool	isEditable () const
void	setCaretPosition (DOM::Node node, long offset, bool extendSelection=false)
CaretDisplayPolicy	caretDisplayPolicyNonFocused () const
void	setCaretDisplayPolicyNonFocused (CaretDisplayPolicy policy)
KUrl	baseURL () const
KUrl	backgroundURL () const
void	scheduleRedirection (int delay, const QString &url, bool lockHistory=true)
virtual void	begin (const KUrl &url=KUrl(), int xOffset=0, int yOffset=0)
virtual void	write (const char *str, int len=-1)
virtual void	write (const QString &str)
virtual void	end ()
void	paint (QPainter , const QRect &, int=0, bool =0)
bool	setEncoding (const QString &name, bool override=false)
QString	encoding () const
void	setUserStyleSheet (const KUrl &url)
void	setUserStyleSheet (const QString &styleSheet)
void	setStandardFont (const QString &name)
void	setFixedFont (const QString &name)
bool	gotoAnchor (const QString &name)
bool	nextAnchor ()
bool	prevAnchor ()
void	setURLCursor (const QCursor &c)
QCursor	urlCursor () const
void	findText ()
void	findText (const QString &str, long options, QWidget parent=0, KFindDialog findDialog=0)
void	findTextBegin ()
bool	findTextNext (bool reverse=false)
void	setZoomFactor (int percent)
int	zoomFactor () const
void	setFontScaleFactor (int percent)
int	fontScaleFactor () const
virtual QString	selectedText () const
QString	selectedTextAsHTML () const
DOM::Range	selection () const
void	selection (DOM::Node &startNode, long &startOffset, DOM::Node &endNode, long &endOffset) const
void	setSelection (const DOM::Range &)
bool	hasSelection () const
void	selectAll ()
void	show ()
void	hide ()
KParts::PartManager *	partManager ()
virtual void	saveState (QDataStream &stream)
virtual void	restoreState (QDataStream &stream)
DOM::Node	nodeUnderMouse () const
DOM::Node	nonSharedNodeUnderMouse () const
const KHTMLSettings *	settings () const
KHTMLPart *	parentPart ()
QStringList	frameNames () const
QList< KParts::ReadOnlyPart * >	frames () const
KHTMLPart *	findFrame (const QString &f)
KHTMLPart *	findFrameParent (KParts::ReadOnlyPart callingPart, const QString &f, khtml::ChildFrame *childFrame=0)
KParts::ReadOnlyPart *	currentFrame () const
bool	frameExists (const QString &frameName)
KJSProxy *	framejScript (KParts::ReadOnlyPart *framePart)
KParts::ReadOnlyPart *	findFramePart (const QString &f)
void	setJSStatusBarText (const QString &text)
void	setJSDefaultStatusBarText (const QString &text)
QString	jsStatusBarText () const
QString	jsDefaultStatusBarText () const
QString	referrer () const
QString	pageReferrer () const
QString	lastModified () const
void	preloadStyleSheet (const QString &url, const QString &stylesheet)
void	preloadScript (const QString &url, const QString &script)
bool	restored () const
void	setFormNotification (FormNotification fn)
FormNotification	formNotification () const
KUrl	toplevelURL ()
bool	isModified () const
void	setSuppressedPopupIndicator (bool enable, KHTMLPart *originPart=0)
bool	inProgress () const
Protected Types
enum	PageSecurity { NotCrypted, Encrypted, Mixed }
Protected Slots
virtual void	slotFinished (KJob *)
Protected Member Functions
KUrl	completeURL (const QString &url)
void	htmlError (int errorCode, const QString &text, const KUrl &reqUrl)
virtual void	customEvent (QEvent *event)
virtual void	khtmlMousePressEvent (khtml::MousePressEvent *event)
virtual void	khtmlMouseDoubleClickEvent (khtml::MouseDoubleClickEvent *)
virtual void	khtmlMouseMoveEvent (khtml::MouseMoveEvent *event)
virtual void	khtmlMouseReleaseEvent (khtml::MouseReleaseEvent *event)
virtual void	khtmlDrawContentsEvent (khtml::DrawContentsEvent *)
virtual void	guiActivateEvent (KParts::GUIActivateEvent *event)
virtual bool	openFile ()
virtual bool	urlSelected (const QString &url, int button, int state, const QString &_target, const KParts::OpenUrlArguments &args=KParts::OpenUrlArguments(), const KParts::BrowserArguments &browserArgs=KParts::BrowserArguments())
virtual KParts::ReadOnlyPart *	createPart (QWidget parentWidget, QObject parent, const QString &mimetype, QString &serviceName, QStringList &serviceTypes, const QStringList &params)
bool	pluginPageQuestionAsked (const QString &mimetype) const
void	setPluginPageQuestionAsked (const QString &mimetype)
void	setPageSecurity (PageSecurity sec)
virtual bool	doOpenStream (const QString &mimeType)
virtual bool	doWriteStream (const QByteArray &data)
virtual bool	doCloseStream ()
virtual void	startingJob (KIO::Job *)
Properties
bool	javaScriptEnabled
bool	javaEnabled
bool	dndEnabled
bool	pluginsEnabled
bool	modified
QString	encoding
QString	lastModified
bool	metaRefreshEnabled
Friends
class	KHTMLView
class	DOM::HTMLTitleElementImpl
class	DOM::HTMLFrameElementImpl
class	DOM::HTMLIFrameElementImpl
class	DOM::HTMLObjectBaseElementImpl
class	DOM::HTMLObjectElementImpl
class	DOM::HTMLAnchorElementImpl
class	DOM::HTMLMetaElementImpl
class	DOM::NodeImpl
class	KHTMLRun
class	DOM::HTMLFormElementImpl
class	KJS::Window
class	KJS::ScheduledAction
class	KJS::JSNodeFilter
class	KJS::WindowFunc
class	KJS::ExternalFunc
class	KJS::JSEventListener
class	KJS::JSLazyEventListener
class	KJS::DOMDocument
class	KJS::HTMLElement
class	KJS::SourceFile
class	KJSProxy
class	KHTMLPartBrowserExtension
class	DOM::DocumentImpl
class	DOM::HTMLDocumentImpl
class	KHTMLPartBrowserHostExtension
class	khtml::HTMLTokenizer
class	khtml::XMLTokenizer
class	khtml::RenderWidget
class	khtml::CSSStyleSelector
class	KHTMLPartIface
class	KHTMLPartFunction
class	KHTMLPopupGUIClient
class	KHTMLPartPrivate

Member Enumeration Documentation

enum KHTMLPart::GUIProfile

Enumerator:

DefaultGUI
BrowserViewGUI

Definition at line 240 of file khtml_part.h.

enum KHTMLPart::CaretDisplayPolicy

Enumeration for displaying the caret.

Enumerator:

CaretVisible	caret is displayed
CaretInvisible	caret is not displayed
CaretBlink	caret toggles between visible and invisible

Definition at line 498 of file khtml_part.h.

enum KHTMLPart::FindOptions

Extra Find options that can be used when calling the extended findText().

Enumerator:

FindLinksOnly
FindNoPopups

Definition at line 694 of file khtml_part.h.

enum KHTMLPart::FormNotification

Enumerator:

NoNotification
Before
Only
Unused

Definition at line 987 of file khtml_part.h.

enum KHTMLPart::PageSecurity [protected]

Enumerator:

NotCrypted
Encrypted
Mixed

Definition at line 1158 of file khtml_part.h.

Constructor & Destructor Documentation

KHTMLPart::KHTMLPart	(	QWidget *	parentWidget = `0`,
		QObject *	parent = `0`,
		GUIProfile	prof = `DefaultGUI`
	)

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

Definition at line 211 of file khtml_part.cpp.

KHTMLPart::KHTMLPart	(	KHTMLView *	view,
		QObject *	parent = `0`,
		GUIProfile	prof = `DefaultGUI`
	)

Constructs a new KHTMLPart.

This constructor is useful if you wish to subclass KHTMLView. If the view passed as first argument to the constructor was built with a null KHTMLPart pointer, then the newly created KHTMLPart will be assigned as the view's part.

Therefore, you might either initialize the view as part of the initialization list of your derived KHTMLPart class constructor:

   MyKHTMLPart() : KHTMLPart( new MyKHTMLView( this ), ...

Or separately build the KHTMLView beforehand:

   KHTMLView * v = KHTMLView( 0L, parentWidget());
   KHTMLPart * p = KHTMLPart( v ); // p will be assigned to v, so that v->part() == p

Definition at line 222 of file khtml_part.cpp.

KHTMLPart::~KHTMLPart ( ) [virtual]

Destructor.

Definition at line 476 of file khtml_part.cpp.

Member Function Documentation

bool KHTMLPart::openUrl ( const KUrl & url ) [virtual]

Opens the specified URL url.

Reimplemented from KParts::ReadOnlyPart::openUrl .

The format of the error url is that two variables are passed in the query: error = int kio error code, errText = QString error text from kio and the URL where the error happened is passed as a sub URL.

Reimplemented from KParts::ReadOnlyPart.

Definition at line 569 of file khtml_part.cpp.

bool KHTMLPart::closeUrl ( ) [virtual]

Stops loading the document and kills all data requests (for images, etc.

)

Reimplemented from KParts::ReadOnlyPart.

Definition at line 793 of file khtml_part.cpp.

void KHTMLPart::showError ( KJob * job ) [virtual]

Called when a certain error situation (i.e.

connection timed out) occurred. The default implementation either shows a KIO error dialog or loads a more verbose error description a as page, depending on the users configuration. job is the job that signaled the error situation

Definition at line 1679 of file khtml_part.cpp.

DOM::HTMLDocument KHTMLPart::htmlDocument ( ) const

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

Definition at line 875 of file khtml_part.cpp.

DOM::Document KHTMLPart::document ( ) const

Returns a reference to the DOM document.

Definition at line 883 of file khtml_part.cpp.

QString KHTMLPart::documentSource ( ) const

Returns the content of the source document.

Definition at line 888 of file khtml_part.cpp.

DOM::Node KHTMLPart::activeNode ( ) const

Returns the node that has the keyboard focus.

Definition at line 6980 of file khtml_part.cpp.

KParts::BrowserExtension * KHTMLPart::browserExtension ( ) const

Returns a pointer to the KParts::BrowserExtension.

Reimplemented from KParts::ReadOnlyPart.

Definition at line 920 of file khtml_part.cpp.

KParts::BrowserHostExtension * KHTMLPart::browserHostExtension ( ) const

Definition at line 925 of file khtml_part.cpp.

KHTMLView * KHTMLPart::view ( ) const

Returns a pointer to the HTML document's view.

Definition at line 930 of file khtml_part.cpp.

void KHTMLPart::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.

Definition at line 954 of file khtml_part.cpp.

bool KHTMLPart::jScriptEnabled ( ) const

Returns true if Javascript support is enabled or false otherwise.

Definition at line 963 of file khtml_part.cpp.

KJS::Interpreter * KHTMLPart::jScriptInterpreter ( )

Returns the JavaScript interpreter the part is using.

This method is mainly intended for applications which embed and extend the part and provides a mechanism for adding additional native objects to the interpreter (or removing the built-ins).

One thing people using this method to add things to the interpreter must consider, is that when you start writing new content to the part, the interpreter is cleared. This includes both use of the begin( const KUrl &, int, int ) method, and the openUrl( const KUrl & ) method. If you want your objects to have a longer lifespan, then you must retain a KJS::Object yourself to ensure that the reference count of your custom objects never reaches 0. You will also need to re-add your bindings every time this happens - one way to detect the need for this is to connect to the docCreated() signal, another is to reimplement the begin() method.

Definition at line 940 of file khtml_part.cpp.

void KHTMLPart::setStatusMessagesEnabled ( bool enable )

Enable/disable statusbar messages.

When this class wants to set the statusbar text, it emits setStatusBarText(const QString & text) If you want to catch this for your own statusbar, note that it returns back a rich text string, starting with "<qt>". This you need to either pass this into your own QLabel or to strip out the tags before passing it to QStatusBar::message(const QString & message)

See also:: KParts::Part::setStatusBarText( const QString & text )

Definition at line 935 of file khtml_part.cpp.

bool KHTMLPart::statusMessagesEnabled ( ) const

Returns true if status messages are enabled.

Definition at line 949 of file khtml_part.cpp.

void KHTMLPart::setMetaRefreshEnabled ( bool enable )

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

...>

Definition at line 972 of file khtml_part.cpp.

bool KHTMLPart::metaRefreshEnabled ( ) const

Returns true if automatic forwarding is enabled.

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

Same as executeScript( const QString & ) except with the Node parameter specifying the 'this' value.

Definition at line 1214 of file khtml_part.cpp.

void KHTMLPart::setDNDEnabled ( bool b )

Enables or disables Drag'n'Drop support.

A drag operation is started if the users drags a link.

Definition at line 5986 of file khtml_part.cpp.

bool KHTMLPart::dndEnabled ( ) const

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

void KHTMLPart::setJavaEnabled ( bool enable )

Enables/disables 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.

Definition at line 1275 of file khtml_part.cpp.

bool KHTMLPart::javaEnabled ( ) const

Return true if Java applet support is enabled, false if disabled.

void KHTMLPart::setPluginsEnabled ( bool enable )

Enables or disables plugins, default is enabled.

Definition at line 1293 of file khtml_part.cpp.

bool KHTMLPart::pluginsEnabled ( ) const

Returns true if plugins are enabled, false if disabled.

void KHTMLPart::setAutoloadImages ( bool enable )

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

Note:: Request will be ignored if called before begin().

Definition at line 1355 of file khtml_part.cpp.

bool KHTMLPart::autoloadImages ( ) const

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

Note:: that the returned information is unrelieable as long as no begin() was called.

Definition at line 1383 of file khtml_part.cpp.

void KHTMLPart::setOnlyLocalReferences ( bool enable )

Security option.

Specify whether only file:/ or data:/ urls are allowed to be loaded without user confirmation by KHTML. ( for example referenced by stylesheets, images, scripts, subdocuments, embedded elements ).

This option is mainly intended for enabling the "mail reader mode", where you load untrusted content with a file:/ url.

Please note that enabling this option currently automatically disables Javascript, Java and Plugins support. This might change in the future if the security model is becoming more sophisticated, so don't rely on this behaviour.

( default false - everything is loaded unless forbidden by KApplication::authorizeURLAction).

Definition at line 2595 of file khtml_part.cpp.

bool KHTMLPart::onlyLocalReferences ( ) const

Returns whether only file:/ or data:/ references are allowed to be loaded ( default false ).

See setOnlyLocalReferences.

Definition at line 2590 of file khtml_part.cpp.

bool KHTMLPart::isCaretMode ( ) const

Returns whether caret mode is on/off.

Definition at line 2645 of file khtml_part.cpp.

bool KHTMLPart::isEditable ( ) const

Returns true if the document is editable, false otherwise.

Definition at line 2666 of file khtml_part.cpp.

void KHTMLPart::setCaretPosition	(	DOM::Node	node,
		long	offset,
		bool	extendSelection = `false`
	)

Sets the caret to the given position.

If the given location is invalid, it will snap to the nearest valid location. Immediately afterwards a caretPositionChanged signal containing the effective position is emitted

Parameters:

	node	node to set to
	offset	zero-based offset within the node
	extendSelection	If `true`, a selection will be spanned from the last caret position to the given one. Otherwise, any existing selection will be deselected.

Definition at line 2671 of file khtml_part.cpp.

KHTMLPart::CaretDisplayPolicy KHTMLPart::caretDisplayPolicyNonFocused ( ) const

Returns the current caret policy when the view is not focused.

Definition at line 2685 of file khtml_part.cpp.

void KHTMLPart::setCaretDisplayPolicyNonFocused ( CaretDisplayPolicy policy )

Sets the caret display policy when the view is not focused.

Whenever the caret is in use, this property determines how the caret should be displayed when the document view is not focused.

The default policy is CaretInvisible.

Parameters:

policy

new display policy

Definition at line 2694 of file khtml_part.cpp.

KUrl KHTMLPart::baseURL ( ) const

Definition at line 2343 of file khtml_part.cpp.

KUrl KHTMLPart::backgroundURL ( ) const

Returns the URL for the background Image (used by save background).

Definition at line 4019 of file khtml_part.cpp.

void KHTMLPart::scheduleRedirection	(	int	delay,
		const QString &	url,
		bool	lockHistory = `true`
	)

Schedules a redirection after delay seconds.

Definition at line 2365 of file khtml_part.cpp.

void KHTMLPart::begin	(	const KUrl &	url = `KUrl()`,
		int	xOffset = `0`,
		int	yOffset = `0`
	)			`[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" ) );

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.

All child frames and the old document are removed if you call this method.

Definition at line 1851 of file khtml_part.cpp.

void KHTMLPart::write	(	const char *	str,
		int	len = `-1`
	)			`[virtual]`

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

Definition at line 1939 of file khtml_part.cpp.

void KHTMLPart::write ( const QString & str ) [virtual]

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

Definition at line 1963 of file khtml_part.cpp.

void KHTMLPart::end ( ) [virtual]

Call this after your last call to write().

Definition at line 1978 of file khtml_part.cpp.

void KHTMLPart::paint	(	QPainter *	p,
		const QRect &	rc,
		int	yOff = `0`,
		bool *	more = `0`
	)

Paints the HTML page to a QPainter.

See KHTMLView::paint for details

Definition at line 2031 of file khtml_part.cpp.

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

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

Definition at line 2450 of file khtml_part.cpp.

QString KHTMLPart::encoding ( ) const

Returns the encoding the page currently uses.

Note that the encoding might be different from the charset.

void KHTMLPart::setUserStyleSheet ( const KUrl & url )

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

To have an effect this function has to be called after calling begin().

Definition at line 2492 of file khtml_part.cpp.

void KHTMLPart::setUserStyleSheet ( const QString & styleSheet )

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

To have an effect this function has to be called after calling begin().

Definition at line 2498 of file khtml_part.cpp.

void KHTMLPart::setStandardFont ( const QString & name )

Sets the standard font style.

Parameters:

name

The font name to use for standard text.

Definition at line 2570 of file khtml_part.cpp.

void KHTMLPart::setFixedFont ( const QString & name )

Sets the fixed font style.

Parameters:

name The font name to use for fixed text, e.g. the <pre> tag.

Definition at line 2575 of file khtml_part.cpp.

bool KHTMLPart::gotoAnchor ( const QString & name )

Finds the anchor named name.

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

Definition at line 2504 of file khtml_part.cpp.

bool KHTMLPart::nextAnchor ( )

Go to the next anchor.

This is useful to navigate from outside the navigator

Definition at line 2552 of file khtml_part.cpp.

bool KHTMLPart::prevAnchor ( )

Go to previous anchor.

Definition at line 2561 of file khtml_part.cpp.

void KHTMLPart::setURLCursor ( const QCursor & c )

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

Definition at line 2580 of file khtml_part.cpp.

QCursor KHTMLPart::urlCursor ( ) const

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

Definition at line 2585 of file khtml_part.cpp.

void KHTMLPart::findText ( )

Starts a new search by popping up a dialog asking the user what he wants to search for.

Definition at line 2897 of file khtml_part.cpp.

void KHTMLPart::findText	(	const QString &	str,
		long	options,
		QWidget *	parent = `0`,
		KFindDialog *	findDialog = `0`
	)

Starts a new search, but bypasses the user dialog.

Parameters:

	str	The string to search for.
	options	Find options.
	parent	Parent used for centering popups like "string not found".
	findDialog	Optionally, you can supply your own dialog.

Definition at line 2939 of file khtml_part.cpp.

void KHTMLPart::findTextBegin ( )

Initiates a text search.

Definition at line 2720 of file khtml_part.cpp.

bool KHTMLPart::findTextNext ( bool reverse = false )

Finds the next occurrence of a string set by findText().

Parameters:

reverse if true, revert seach direction (only if no find dialog is used)

Returns:: true if a new match was found.

Definition at line 2968 of file khtml_part.cpp.

void KHTMLPart::setZoomFactor ( int percent )

Sets the Zoom factor.

The value is given in percent, larger values mean a generally larger font and larger page contents.

The given value should be in the range of 20..300, values outside that range are not guaranteed to work. A value of 100 will disable all zooming and show the page with the sizes determined via the given lengths in the stylesheets.

Definition at line 5701 of file khtml_part.cpp.

int KHTMLPart::zoomFactor ( ) const

Returns the current zoom factor.

Definition at line 5637 of file khtml_part.cpp.

void KHTMLPart::setFontScaleFactor ( int percent )

Sets the scale factor to be applied to fonts.

The value is given in percent, larger values mean generally larger fonts.

The given value should be in the range of 20..300, values outside that range are not guaranteed to work. A value of 100 will disable all scaling of font sizes and show the page with the sizes determined via the given lengths in the stylesheets.

Definition at line 5780 of file khtml_part.cpp.

int KHTMLPart::fontScaleFactor ( ) const

Returns the current font scale factor.

Definition at line 5804 of file khtml_part.cpp.

QString KHTMLPart::selectedText ( ) const [virtual]

Returns the text the user has marked.

Definition at line 3353 of file khtml_part.cpp.

QString KHTMLPart::selectedTextAsHTML ( ) const

Return the text the user has marked.

This is guaranteed to be valid xml, and to contain the <html> and <body> tags.

FIXME probably should make virtual for 4.0 ?

Definition at line 3336 of file khtml_part.cpp.

DOM::Range KHTMLPart::selection ( ) const

Returns the selected part of the HTML.

Definition at line 3504 of file khtml_part.cpp.

void KHTMLPart::selection	(	DOM::Node &	startNode,
		long &	startOffset,
		DOM::Node &	endNode,
		long &	endOffset
	)			const

Returns the selected part of the HTML by returning the starting and end position.

If there is no selection, both nodes and offsets are equal.

Parameters:

	startNode	returns node selection starts in
	startOffset	returns offset within starting node
	endNode	returns node selection ends in
	endOffset	returns offset within end node.

Definition at line 3558 of file khtml_part.cpp.

void KHTMLPart::setSelection ( const DOM::Range & r )

Sets the current selection.

Definition at line 3566 of file khtml_part.cpp.

bool KHTMLPart::hasSelection ( ) const

Has the user selected anything?

Call selectedText() to retrieve the selected text.

Returns:: true if there is text selected.

Definition at line 3494 of file khtml_part.cpp.

void KHTMLPart::selectAll ( )

Marks all text in the document as selected.

Definition at line 6791 of file khtml_part.cpp.

void KHTMLPart::show ( )

Convenience method to show the document's view.

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

Definition at line 5605 of file khtml_part.cpp.

void KHTMLPart::hide ( )

Convenience method to hide the document's view.

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

Definition at line 5611 of file khtml_part.cpp.

KParts::PartManager * KHTMLPart::partManager ( )

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

Definition at line 4655 of file khtml_part.cpp.

void KHTMLPart::saveState ( QDataStream & stream ) [virtual]

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

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

Definition at line 5318 of file khtml_part.cpp.

void KHTMLPart::restoreState ( QDataStream & stream ) [virtual]

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

See also:: saveState()

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

Definition at line 5406 of file khtml_part.cpp.

DOM::Node KHTMLPart::nodeUnderMouse ( ) const

Returns the Node currently under the mouse.

The returned node may be a shared node (e. g. an <area> node if the mouse is hovering over an image map).

Definition at line 5617 of file khtml_part.cpp.

DOM::Node KHTMLPart::nonSharedNodeUnderMouse ( ) const

Returns the Node currently under the mouse that is not shared.

The returned node is always the node that is physically under the mouse pointer (irrespective of logically overlying elements like, e. g., <area> on image maps).

Definition at line 5622 of file khtml_part.cpp.

const KHTMLSettings * KHTMLPart::settings ( ) const

Definition at line 2337 of file khtml_part.cpp.

KHTMLPart * KHTMLPart::parentPart ( )

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

Returns 0L otherwise.

Definition at line 5280 of file khtml_part.cpp.

QStringList KHTMLPart::frameNames ( ) const

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

Definition at line 5943 of file khtml_part.cpp.

QList< KParts::ReadOnlyPart * > KHTMLPart::frames ( ) const

Definition at line 5956 of file khtml_part.cpp.

KHTMLPart * KHTMLPart::findFrame ( const QString & f )

Finds a frame by name.

Returns 0L if frame can't be found.

Definition at line 5216 of file khtml_part.cpp.

KHTMLPart * KHTMLPart::findFrameParent	(	KParts::ReadOnlyPart *	callingPart,
		const QString &	f,
		khtml::ChildFrame **	childFrame = `0`
	)

Recursively finds the part containing the frame with name f and checks if it is accessible by callingPart Returns 0L if no suitable frame can't be found.

Returns parent part if a suitable frame was found and frame info in *childFrame

Definition at line 5175 of file khtml_part.cpp.

KParts::ReadOnlyPart * KHTMLPart::currentFrame ( ) const

Return the current frame (the one that has focus) Not necessarily a direct child of ours, framesets can be nested.

Returns "this" if this part isn't a frameset.

Definition at line 5235 of file khtml_part.cpp.

bool KHTMLPart::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.

Definition at line 5250 of file khtml_part.cpp.

KJSProxy * KHTMLPart::framejScript ( KParts::ReadOnlyPart * framePart )

Returns child frame framePart its script interpreter.

Definition at line 5262 of file khtml_part.cpp.

KParts::ReadOnlyPart * KHTMLPart::findFramePart ( const QString & f )

Finds a frame by name.

Returns 0L if frame can't be found.

Definition at line 5229 of file khtml_part.cpp.

void KHTMLPart::setJSStatusBarText ( const QString & text )

Called by KJS.

Sets the StatusBarText assigned via window.status

Definition at line 5841 of file khtml_part.cpp.

void KHTMLPart::setJSDefaultStatusBarText ( const QString & text )

Called by KJS.

Sets the DefaultStatusBarText assigned via window.defaultStatus

Definition at line 5846 of file khtml_part.cpp.

QString KHTMLPart::jsStatusBarText ( ) const

Called by KJS.

Returns the StatusBarText assigned via window.status

Definition at line 5851 of file khtml_part.cpp.

QString KHTMLPart::jsDefaultStatusBarText ( ) const

Called by KJS.

Returns the DefaultStatusBarText assigned via window.defaultStatus

Definition at line 5856 of file khtml_part.cpp.

QString KHTMLPart::referrer ( ) const

Referrer used for links in this page.

Definition at line 5861 of file khtml_part.cpp.

QString KHTMLPart::pageReferrer ( ) const

Referrer used to obtain this page.

Definition at line 5866 of file khtml_part.cpp.

QString KHTMLPart::lastModified ( ) const

Last-modified date (in raw string format), if received in the [HTTP] headers.

void KHTMLPart::preloadStyleSheet	(	const QString &	url,
		const QString &	stylesheet
	)

Loads a style sheet into the stylesheet cache.

Definition at line 7015 of file khtml_part.cpp.

void KHTMLPart::preloadScript	(	const QString &	url,
		const QString &	script
	)

Loads a script into the script cache.

Definition at line 7020 of file khtml_part.cpp.

bool KHTMLPart::restored ( ) const

Definition at line 7030 of file khtml_part.cpp.

void KHTMLPart::setFormNotification ( KHTMLPart::FormNotification fn )

Determine if signal should be emitted before, instead or never when a submitForm() happens.

### KDE4 remove me

Definition at line 7296 of file khtml_part.cpp.

KHTMLPart::FormNotification KHTMLPart::formNotification ( ) const

Determine if signal should be emitted before, instead or never when a submitForm() happens.

### KDE4 remove me

Definition at line 7300 of file khtml_part.cpp.

KUrl KHTMLPart::toplevelURL ( )

Returns the toplevel (origin) URL of this document, even if this part is a frame or an iframe.

Returns:: the actual original url.

Definition at line 7304 of file khtml_part.cpp.

bool KHTMLPart::isModified ( ) const

Checks whether the page contains unsubmitted form changes.

Returns:: true if form changes exist

Definition at line 7316 of file khtml_part.cpp.

void KHTMLPart::setSuppressedPopupIndicator	(	bool	enable,
		KHTMLPart *	originPart = `0`
	)

Shows or hides the suppressed popup indicator.

Definition at line 7341 of file khtml_part.cpp.

bool KHTMLPart::inProgress ( ) const

Definition at line 7420 of file khtml_part.cpp.

void KHTMLPart::onURL ( const QString & url ) [signal]

Emitted if the cursor is moved over an URL.

void KHTMLPart::popupMenu	(	const QString &	url,
		const QPoint &	point
	)			`[signal]`

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

See KParts::BrowserExtension for two more popupMenu signals emitted by khtml, with much more information in the signal.

void KHTMLPart::selectionChanged ( ) [signal]

This signal is emitted when the selection changes.

void KHTMLPart::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.

void KHTMLPart::docCreated ( ) [signal]

void KHTMLPart::caretPositionChanged	(	const DOM::Node &	node,
		long	offset
	)			`[signal]`

This signal is emitted whenever the caret position has been changed.

The signal transmits the position the DOM::Range way, the node and the zero-based offset within this node.

Parameters:

	node	node which the caret is in. This can be null if the caret has been deactivated.
	offset	offset within the node. If the node is null, the offset is meaningless.

void KHTMLPart::formSubmitNotification	(	const char *	action,
		const QString &	url,
		const QByteArray &	formData,
		const QString &	target,
		const QString &	contentType,
		const QString &	boundary
	)			`[signal]`

If form notification is on, this will be emitted either for a form submit or before the form submit according to the setting.

### KDE4 remove me

void KHTMLPart::configurationChanged ( ) [signal]

Emitted whenever the configuration has changed.

KUrl KHTMLPart::completeURL ( const QString & url ) [protected]

returns a KUrl object for the given url.

Use when you know what you're doing.

Definition at line 2351 of file khtml_part.cpp.

void KHTMLPart::htmlError	(	int	errorCode,
		const QString &	text,
		const KUrl &	reqUrl
	)			`[protected]`

presents a detailed error message to the user.

errorCode kio error code, eg KIO::ERR_SERVER_TIMEOUT. text kio additional information text. url the url that triggered the error.

Definition at line 1696 of file khtml_part.cpp.

void KHTMLPart::customEvent ( QEvent * event ) [protected, virtual]

Reimplemented from KParts::Part.

Definition at line 5996 of file khtml_part.cpp.

void KHTMLPart::khtmlMousePressEvent ( khtml::MousePressEvent * event ) [protected, virtual]

Eventhandler of the khtml::MousePressEvent.

Definition at line 6098 of file khtml_part.cpp.

void KHTMLPart::khtmlMouseDoubleClickEvent ( khtml::MouseDoubleClickEvent * event ) [protected, virtual]

Eventhandler for the khtml::MouseDoubleClickEvent.

Definition at line 6176 of file khtml_part.cpp.

void KHTMLPart::khtmlMouseMoveEvent ( khtml::MouseMoveEvent * event ) [protected, virtual]

Eventhandler for the khtml::MouseMouseMoveEvent.

Definition at line 6426 of file khtml_part.cpp.

void KHTMLPart::khtmlMouseReleaseEvent ( khtml::MouseReleaseEvent * event ) [protected, virtual]

Eventhandler for the khtml::MouseMouseReleaseEvent.

Definition at line 6558 of file khtml_part.cpp.

void KHTMLPart::khtmlDrawContentsEvent ( khtml::DrawContentsEvent * ) [protected, virtual]

Eventhandler for the khtml::DrawContentsEvent.

Definition at line 6671 of file khtml_part.cpp.

void KHTMLPart::guiActivateEvent ( KParts::GUIActivateEvent * event ) [protected, virtual]

Internal reimplementation of KParts::Part::guiActivateEvent .

Reimplemented from KParts::ReadOnlyPart.

Definition at line 6675 of file khtml_part.cpp.

bool KHTMLPart::openFile ( ) [protected, virtual]

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

Implements KParts::ReadOnlyPart.

Definition at line 1522 of file khtml_part.cpp.

bool KHTMLPart::urlSelected	(	const QString &	url,
		int	button,
		int	state,
		const QString &	_target,
		const KParts::OpenUrlArguments &	args = `KParts::OpenUrlArguments()`,
		const KParts::BrowserArguments &	browserArgs = `KParts::BrowserArguments()`
	)			`[protected, virtual]`

Definition at line 3790 of file khtml_part.cpp.

KParts::ReadOnlyPart * KHTMLPart::createPart	(	QWidget *	parentWidget,
		QObject *	parent,
		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' .

Definition at line 4599 of file khtml_part.cpp.

bool KHTMLPart::pluginPageQuestionAsked ( const QString & mimetype ) const [protected]

Definition at line 7035 of file khtml_part.cpp.

void KHTMLPart::setPluginPageQuestionAsked ( const QString & mimetype ) [protected]

Definition at line 7045 of file khtml_part.cpp.

void KHTMLPart::setPageSecurity ( PageSecurity sec ) [protected]

Definition at line 1549 of file khtml_part.cpp.

bool KHTMLPart::doOpenStream ( const QString & mimeType ) [protected, virtual]

Implements the streaming API of KParts::ReadOnlyPart.

Definition at line 2007 of file khtml_part.cpp.

bool KHTMLPart::doWriteStream ( const QByteArray & data ) [protected, virtual]

Implements the streaming API of KParts::ReadOnlyPart.

Definition at line 2018 of file khtml_part.cpp.

bool KHTMLPart::doCloseStream ( ) [protected, virtual]

Implements the streaming API of KParts::ReadOnlyPart.

Definition at line 2024 of file khtml_part.cpp.

void KHTMLPart::setActiveNode ( const DOM::Node & node ) [slot]

Sets the focused node of the document to the specified node.

If the node is a form control, the control will receive focus in the same way that it would if the user had clicked on it or tabbed to it with the keyboard. For most other types of elements, there is no visual indication of whether or not they are focused.

See activeNode

Parameters:

node

The node to focus

Definition at line 6966 of file khtml_part.cpp.

void KHTMLPart::stopAnimations ( ) [slot]

Stops all animated images on the current and child pages.

Definition at line 2037 of file khtml_part.cpp.

QVariant KHTMLPart::executeScript ( const QString & script ) [slot]

Execute the specified snippet of JavaScript code.

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

Deprecated:: , use executeString( DOM::Node(), script)

Definition at line 1209 of file khtml_part.cpp.

void KHTMLPart::setCaretMode ( bool enable ) [slot]

Enables/disables caret mode.

Enabling caret mode displays a caret which can be used to navigate the document using the keyboard only. Caret mode is switched off by default.

Parameters:

enable true to enable, false to disable caret mode.

Definition at line 2628 of file khtml_part.cpp.

void KHTMLPart::setEditable ( bool enable ) [slot]

Makes the document editable.

Setting this property to true makes the document, and its subdocuments (such as frames, iframes, objects) editable as a whole. FIXME: insert more information about navigation, features etc. as seen fit

Parameters:

enable true to set document editable, false to set it read-only.

Definition at line 2650 of file khtml_part.cpp.

void KHTMLPart::setCaretVisible ( bool show ) [slot]

Sets the visibility of the caret.

This methods displays or hides the caret regardless of the current caret display policy (see setCaretDisplayNonFocused), and regardless of focus.

The caret will be shown/hidden only under at least one of the following conditions:

the document is editable
the document is in caret mode
the document's currently focused element is editable

Parameters:

show true to make visible, false to hide.

Definition at line 2701 of file khtml_part.cpp.

void KHTMLPart::submitFormProxy	(	const char *	action,
		const QString &	url,
		const QByteArray &	formData,
		const QString &	target,
		const QString &	contentType = `QString()`,
		const QString &	boundary = `QString()`
	)			`[slot]`

Definition at line 4681 of file khtml_part.cpp.

void KHTMLPart::slotFinished ( KJob * job ) [protected, virtual, slot]

Called when the job downloading the page is finished.

Can be reimplemented, for instance to get metadata out of the job, but make sure to call KHTMLPart::slotFinished() too.

Definition at line 1795 of file khtml_part.cpp.

virtual void KHTMLPart::startingJob ( KIO::Job * ) [inline, protected, virtual]

Hook for adding code before a job is started.

This can be used to add metadata, like job->addMetaData("PropagateHttpHeader", "true") to get the HTTP headers.

Definition at line 1267 of file khtml_part.h.

Friends And Related Function Documentation

friend class KHTMLView [friend]

Definition at line 189 of file khtml_part.h.

friend class DOM::HTMLTitleElementImpl [friend]

Definition at line 190 of file khtml_part.h.

friend class DOM::HTMLFrameElementImpl [friend]

Definition at line 191 of file khtml_part.h.

friend class DOM::HTMLIFrameElementImpl [friend]

Definition at line 192 of file khtml_part.h.

friend class DOM::HTMLObjectBaseElementImpl [friend]

Definition at line 193 of file khtml_part.h.

friend class DOM::HTMLObjectElementImpl [friend]

Definition at line 194 of file khtml_part.h.

friend class DOM::HTMLAnchorElementImpl [friend]

Definition at line 195 of file khtml_part.h.

friend class DOM::HTMLMetaElementImpl [friend]

Definition at line 196 of file khtml_part.h.

friend class DOM::NodeImpl [friend]

Definition at line 197 of file khtml_part.h.

friend class KHTMLRun [friend]

Definition at line 198 of file khtml_part.h.

friend class DOM::HTMLFormElementImpl [friend]

Definition at line 199 of file khtml_part.h.

friend class KJS::Window [friend]

Definition at line 200 of file khtml_part.h.

friend class KJS::ScheduledAction [friend]

Definition at line 201 of file khtml_part.h.

friend class KJS::JSNodeFilter [friend]

Definition at line 202 of file khtml_part.h.

friend class KJS::WindowFunc [friend]

Definition at line 203 of file khtml_part.h.

friend class KJS::ExternalFunc [friend]

Definition at line 204 of file khtml_part.h.

friend class KJS::JSEventListener [friend]

Definition at line 205 of file khtml_part.h.

friend class KJS::JSLazyEventListener [friend]

Definition at line 206 of file khtml_part.h.

friend class KJS::DOMDocument [friend]

Definition at line 207 of file khtml_part.h.

friend class KJS::HTMLElement [friend]

Definition at line 208 of file khtml_part.h.

friend class KJS::SourceFile [friend]

Definition at line 209 of file khtml_part.h.

friend class KJSProxy [friend]

Definition at line 211 of file khtml_part.h.

friend class KHTMLPartBrowserExtension [friend]

Definition at line 212 of file khtml_part.h.

friend class DOM::DocumentImpl [friend]

Definition at line 213 of file khtml_part.h.

friend class DOM::HTMLDocumentImpl [friend]

Definition at line 214 of file khtml_part.h.

friend class KHTMLPartBrowserHostExtension [friend]

Definition at line 215 of file khtml_part.h.

friend class khtml::HTMLTokenizer [friend]

Definition at line 216 of file khtml_part.h.

friend class khtml::XMLTokenizer [friend]

Definition at line 217 of file khtml_part.h.

friend class khtml::RenderWidget [friend]

Definition at line 218 of file khtml_part.h.

friend class khtml::CSSStyleSelector [friend]

Definition at line 219 of file khtml_part.h.

friend class KHTMLPartIface [friend]

Definition at line 220 of file khtml_part.h.

friend class KHTMLPartFunction [friend]

Definition at line 221 of file khtml_part.h.

friend class KHTMLPopupGUIClient [friend]

Definition at line 222 of file khtml_part.h.

friend class KHTMLPartPrivate [friend]

Definition at line 1676 of file khtml_part.h.

Property Documentation

bool KHTMLPart::javaScriptEnabled [read, write]

Definition at line 224 of file khtml_part.h.

bool KHTMLPart::javaEnabled [read, write]

Definition at line 225 of file khtml_part.h.

bool KHTMLPart::dndEnabled [read, write]

Definition at line 226 of file khtml_part.h.

bool KHTMLPart::pluginsEnabled [read, write]

Definition at line 227 of file khtml_part.h.

bool KHTMLPart::modified [read]

Definition at line 234 of file khtml_part.h.

QString KHTMLPart::encoding [read, write]

Definition at line 235 of file khtml_part.h.

QString KHTMLPart::lastModified [read]

Definition at line 236 of file khtml_part.h.

bool KHTMLPart::metaRefreshEnabled [read, write]

Definition at line 237 of file khtml_part.h.

The documentation for this class was generated from the following files:

KHTML

KHTMLPart Class Reference

Detailed Description

Public Types

Public Slots

Signals

Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Properties

Friends

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Property Documentation

KHTML

kdelibs