KHTMLView Class Reference

Renders and displays HTML in a QScrollArea. More...

#include <khtmlview.h>

Inheritance diagram for KHTMLView:

Public Types
enum	SmoothScrollingMode { SSMDisabled = 0, SSMWhenEfficient, SSMEnabled }
Public Slots
void	layout ()
virtual void	resizeContents (int w, int h)
Signals
void	cleared ()
void	findAheadActive (bool)
void	finishedLayout ()
void	hideAccessKeys ()
void	repaintAccessKeys ()
void	zoomView (int)
Public Member Functions
void	addChild (QWidget *child, int dx, int dy)
int	contentsHeight () const
void	contentsToViewport (int x, int y, int &cx, int &cy) const
QPoint	contentsToViewport (const QPoint &p) const
int	contentsWidth () const
int	contentsX () const
int	contentsY () const
void	displayAccessKeys ()
int	frameWidth () const
	KHTMLView (KHTMLPart part, QWidget parent)
int	marginHeight ()
int	marginWidth () const
KHTMLPart *	part () const
void	print (bool quick=false)
void	repaintContents (int x, int y, int w, int h)
void	repaintContents (const QRect &r)
void	scrollBy (int x, int y)
void	setContentsPos (int x, int y)
virtual void	setHorizontalScrollBarPolicy (Qt::ScrollBarPolicy policy)
void	setMarginHeight (int y)
void	setMarginWidth (int x)
void	setSmoothScrollingMode (SmoothScrollingMode m)
virtual void	setVerticalScrollBarPolicy (Qt::ScrollBarPolicy policy)
void	setZoomLevel (int percent)
SmoothScrollingMode	smoothScrollingMode () const
void	updateContents (int x, int y, int w, int h)
void	updateContents (const QRect &r)
void	viewportToContents (int x, int y, int &cx, int &cy) const
QPoint	viewportToContents (const QPoint &p) const
int	visibleHeight () const
int	visibleWidth () const
int	zoomLevel () const
virtual	~KHTMLView ()
Protected Slots
void	slotPaletteChanged ()
Protected Member Functions
void	clear ()
virtual void	closeEvent (QCloseEvent *)
void	doAutoScroll ()
virtual void	dragEnterEvent (QDragEnterEvent *)
virtual void	dropEvent (QDropEvent *)
virtual bool	event (QEvent *event)
virtual bool	eventFilter (QObject , QEvent )
virtual void	focusInEvent (QFocusEvent *)
virtual bool	focusNextPrevChild (bool next)
virtual void	focusOutEvent (QFocusEvent *)
virtual void	hideEvent (QHideEvent *)
void	keyPressEvent (QKeyEvent *_ke)
void	keyReleaseEvent (QKeyEvent *_ke)
virtual void	mouseDoubleClickEvent (QMouseEvent *)
virtual void	mouseMoveEvent (QMouseEvent *)
virtual void	mousePressEvent (QMouseEvent *)
virtual void	mouseReleaseEvent (QMouseEvent *)
virtual void	paintEvent (QPaintEvent *)
virtual void	resizeEvent (QResizeEvent *event)
virtual void	scrollContentsBy (int dx, int dy)
void	setSmoothScrollingModeDefault (SmoothScrollingMode m)
virtual void	showEvent (QShowEvent *)
void	timerEvent (QTimerEvent *)
virtual bool	viewportEvent (QEvent *e)
virtual void	wheelEvent (QWheelEvent *)
virtual bool	widgetEvent (QEvent *)
Friends
void	khtml::applyRule (DOM::CSSProperty *prop)

Detailed Description

Renders and displays HTML in a QScrollArea.

Suitable for use as an application's main view.

Definition at line 91 of file khtmlview.h.

Member Enumeration Documentation

enum KHTMLView::SmoothScrollingMode

Smooth Scrolling Mode enumeration.

SSMDisabled smooth scrolling is disabled
SSMWhenEfficient only use smooth scrolling on pages that do not require a full repaint of the content area when scrolling
SSMAlways smooth scrolling is performed unconditionally

Enumerator:

SSMDisabled
SSMWhenEfficient
SSMEnabled

Definition at line 303 of file khtmlview.h.

Constructor & Destructor Documentation

KHTMLView::KHTMLView	(	KHTMLPart *	part,
		QWidget *	parent
	)

Constructs a KHTMLView.

Definition at line 551 of file khtmlview.cpp.

KHTMLView::~KHTMLView ( ) [virtual]

Definition at line 569 of file khtmlview.cpp.

Member Function Documentation

void KHTMLView::addChild	(	QWidget *	child,
		int	dx,
		int	dy
	)

Definition at line 4101 of file khtmlview.cpp.

void KHTMLView::clear ( ) [protected]

Definition at line 621 of file khtmlview.cpp.

void KHTMLView::cleared ( ) [signal]

void KHTMLView::closeEvent ( QCloseEvent * ev ) [protected, virtual]

Definition at line 1067 of file khtmlview.cpp.

int KHTMLView::contentsHeight ( ) const

Returns the contents area's height.

Definition at line 684 of file khtmlview.cpp.

void KHTMLView::contentsToViewport	(	int	x,
		int	y,
		int &	cx,
		int &	cy
	)			const

Returns a point translated to viewport coordinates.

Parameters:

	x	x coordinate of contents area point to translate
	y	y coordinate of contents area point to translate
	cx	resulting x coordinate
	cy	resulting y coordinate

Definition at line 760 of file khtmlview.cpp.

QPoint KHTMLView::contentsToViewport ( const QPoint & p ) const

Returns a point translated to viewport coordinates.

Parameters:

p

the contents area point to translate

Definition at line 755 of file khtmlview.cpp.

int KHTMLView::contentsWidth ( ) const

Returns the contents area's width.

Definition at line 679 of file khtmlview.cpp.

int KHTMLView::contentsX ( ) const

Returns the x coordinate of the contents area point that is currently located at the top left in the viewport.

Definition at line 698 of file khtmlview.cpp.

int KHTMLView::contentsY ( ) const

Returns the y coordinate of the contents area point that is currently located at the top left in the viewport.

Definition at line 703 of file khtmlview.cpp.

void KHTMLView::displayAccessKeys ( )

Display all accesskeys in small tooltips.

Definition at line 2624 of file khtmlview.cpp.

void KHTMLView::doAutoScroll ( ) [protected]

Definition at line 2017 of file khtmlview.cpp.

void KHTMLView::dragEnterEvent ( QDragEnterEvent * ev ) [protected, virtual]

Definition at line 3828 of file khtmlview.cpp.

void KHTMLView::dropEvent ( QDropEvent * ev ) [protected, virtual]

Definition at line 3834 of file khtmlview.cpp.

bool KHTMLView::event ( QEvent * event ) [protected, virtual]

Definition at line 483 of file khtmlview.cpp.

bool KHTMLView::eventFilter	(	QObject *	o,
		QEvent *	e
	)			`[protected, virtual]`

Definition at line 2159 of file khtmlview.cpp.

void KHTMLView::findAheadActive ( bool ) [signal]

void KHTMLView::finishedLayout ( ) [signal]

This signal is used for internal layouting.

Don't use it to check if rendering finished. Use KHTMLPart completed() signal instead.

void KHTMLView::focusInEvent ( QFocusEvent * e ) [protected, virtual]

Definition at line 3840 of file khtmlview.cpp.

bool KHTMLView::focusNextPrevChild ( bool next ) [protected, virtual]

Definition at line 1998 of file khtmlview.cpp.

void KHTMLView::focusOutEvent ( QFocusEvent * e ) [protected, virtual]

Definition at line 3855 of file khtmlview.cpp.

int KHTMLView::frameWidth ( ) const [inline]

Definition at line 135 of file khtmlview.h.

void KHTMLView::hideAccessKeys ( ) [signal]

void KHTMLView::hideEvent ( QHideEvent * e ) [protected, virtual]

Definition at line 645 of file khtmlview.cpp.

void KHTMLView::keyPressEvent ( QKeyEvent * _ke ) [protected]

Definition at line 1678 of file khtmlview.cpp.

void KHTMLView::keyReleaseEvent ( QKeyEvent * _ke ) [protected]

Definition at line 1949 of file khtmlview.cpp.

void KHTMLView::layout ( ) [slot]

ensure the display is up to date

Definition at line 959 of file khtmlview.cpp.

int KHTMLView::marginHeight ( ) [inline]

Returns the margin height.

A return value of -1 means the default value will be used.

Definition at line 159 of file khtmlview.h.

int KHTMLView::marginWidth ( ) const [inline]

Returns the margin width.

A return value of -1 means the default value will be used.

Definition at line 147 of file khtmlview.h.

void KHTMLView::mouseDoubleClickEvent ( QMouseEvent * _mouse ) [protected, virtual]

Definition at line 1247 of file khtmlview.cpp.

void KHTMLView::mouseMoveEvent ( QMouseEvent * _mouse ) [protected, virtual]

Definition at line 1306 of file khtmlview.cpp.

void KHTMLView::mousePressEvent ( QMouseEvent * _mouse ) [protected, virtual]

Definition at line 1118 of file khtmlview.cpp.

void KHTMLView::mouseReleaseEvent ( QMouseEvent * _mouse ) [protected, virtual]

Definition at line 1545 of file khtmlview.cpp.

void KHTMLView::paintEvent ( QPaintEvent * e ) [protected, virtual]

Definition at line 876 of file khtmlview.cpp.

KHTMLPart* KHTMLView::part ( ) const [inline]

Returns a pointer to the KHTMLPart that is rendering the page.

Definition at line 133 of file khtmlview.h.

void KHTMLView::print ( bool quick = false )

Prints the HTML document.

Parameters:

quick

if true, fully automated printing, without print dialog

Definition at line 3143 of file khtmlview.cpp.

void KHTMLView::repaintAccessKeys ( ) [signal]

void KHTMLView::repaintContents	(	int	x,
		int	y,
		int	w,
		int	h
	)

Definition at line 797 of file khtmlview.cpp.

void KHTMLView::repaintContents ( const QRect & r )

Requests an immediate repaint of the content area.

Parameters:

r

the content area rectangle to repaint

Definition at line 808 of file khtmlview.cpp.

void KHTMLView::resizeContents	(	int	w,
		int	h
	)			`[virtual, slot]`

Resize the contents area.

Parameters:

	w	the new width
	h	the new height

Definition at line 689 of file khtmlview.cpp.

void KHTMLView::resizeEvent ( QResizeEvent * event ) [protected, virtual]

Definition at line 845 of file khtmlview.cpp.

void KHTMLView::scrollBy	(	int	x,
		int	y
	)

Scrolls the content area by a given amount.

Parameters:

	x	x offset
	y	y offset

Definition at line 747 of file khtmlview.cpp.

void KHTMLView::scrollContentsBy	(	int	dx,
		int	dy
	)			`[protected, virtual]`

Definition at line 3877 of file khtmlview.cpp.

void KHTMLView::setContentsPos	(	int	x,
		int	y
	)

Place the contents area point x/y at the top left of the viewport.

Definition at line 740 of file khtmlview.cpp.

void KHTMLView::setHorizontalScrollBarPolicy ( Qt::ScrollBarPolicy policy ) [virtual]

Sets horizontal scrollbar mode.

WARNING: do not call this method on a base class pointer unless you specifically want QAbstractScrollArea's variant (not recommended). QAbstractScrollArea::setHorizontalScrollBarPolicy is *not* virtual.

Definition at line 3489 of file khtmlview.cpp.

void KHTMLView::setMarginHeight ( int y )

Definition at line 953 of file khtmlview.cpp.

void KHTMLView::setMarginWidth ( int x )

Sets a margin in x direction.

Definition at line 947 of file khtmlview.cpp.

void KHTMLView::setSmoothScrollingMode ( SmoothScrollingMode m )

Set the smooth scrolling mode.

Smooth scrolling mode is normally controlled by the configuration file's SmoothScrolling key. Using this setter will override the configuration file's settings.

Since:: 4.1

Definition at line 1090 of file khtmlview.cpp.

void KHTMLView::setSmoothScrollingModeDefault ( SmoothScrollingMode m ) [protected]

Definition at line 1098 of file khtmlview.cpp.

void KHTMLView::setVerticalScrollBarPolicy ( Qt::ScrollBarPolicy policy ) [virtual]

Sets vertical scrollbar mode.

WARNING: do not call this method on a base class pointer unless you specifically want QAbstractScrollArea's variant (not recommended). QAbstractScrollArea::setVerticalScrollBarPolicy is *not* virtual.

Definition at line 3479 of file khtmlview.cpp.

void KHTMLView::setZoomLevel ( int percent )

Apply a zoom level to the content area.

Parameters:

percent

a zoom level expressed as a percentage

Definition at line 1073 of file khtmlview.cpp.

void KHTMLView::showEvent ( QShowEvent * e ) [protected, virtual]

Definition at line 652 of file khtmlview.cpp.

void KHTMLView::slotPaletteChanged ( ) [protected, slot]

Definition at line 3331 of file khtmlview.cpp.

KHTMLView::SmoothScrollingMode KHTMLView::smoothScrollingMode ( ) const

Retrieve the current smooth scrolling mode.

Since:: 4.1

Definition at line 1108 of file khtmlview.cpp.

void KHTMLView::timerEvent ( QTimerEvent * e ) [protected]

Definition at line 4114 of file khtmlview.cpp.

void KHTMLView::updateContents	(	int	x,
		int	y,
		int	w,
		int	h
	)

Definition at line 781 of file khtmlview.cpp.

void KHTMLView::updateContents ( const QRect & r )

Requests an update of the content area.

Parameters:

r

the content area rectangle to update

Definition at line 792 of file khtmlview.cpp.

bool KHTMLView::viewportEvent ( QEvent * e ) [protected, virtual]

Definition at line 2106 of file khtmlview.cpp.

void KHTMLView::viewportToContents	(	int	x,
		int	y,
		int &	cx,
		int &	cy
	)			const

Returns a point translated to contents area coordinates.

Parameters:

	x	x coordinate of viewport point to translate
	y	y coordinate of viewport point to translate
	cx	resulting x coordinate
	cy	resulting y coordinate

Definition at line 773 of file khtmlview.cpp.

QPoint KHTMLView::viewportToContents ( const QPoint & p ) const

Returns a point translated to contents area coordinates.

Parameters:

p

the viewport point to translate

Definition at line 768 of file khtmlview.cpp.

int KHTMLView::visibleHeight ( ) const

Returns the height of the viewport.

Definition at line 724 of file khtmlview.cpp.

int KHTMLView::visibleWidth ( ) const

Returns the width of the viewport.

Definition at line 708 of file khtmlview.cpp.

void KHTMLView::wheelEvent ( QWheelEvent * e ) [protected, virtual]

Definition at line 3748 of file khtmlview.cpp.

bool KHTMLView::widgetEvent ( QEvent * e ) [protected, virtual]

Definition at line 2322 of file khtmlview.cpp.

int KHTMLView::zoomLevel ( ) const

Retrieve the current zoom level.

Definition at line 1085 of file khtmlview.cpp.

void KHTMLView::zoomView ( int ) [signal]

Friends And Related Function Documentation

void khtml::applyRule ( DOM::CSSProperty * prop ) [friend]

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

KHTML

KHTMLView Class Reference

Public Types

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

KHTML

kdelibs