• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KHTML

KHTMLView Class Reference

#include <khtmlview.h>

Inheritance diagram for KHTMLView:

Inheritance graph
[legend]

List of all members.


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.


Public Slots

virtual void resizeContents (int w, int h)
void layout ()

Signals

void finishedLayout ()
void cleared ()
void zoomView (int)
void hideAccessKeys ()
void repaintAccessKeys ()
void findAheadActive (bool)

Public Member Functions

 KHTMLView (KHTMLPart *part, QWidget *parent)
virtual ~KHTMLView ()
KHTMLPart * part () const
int frameWidth () const
void setMarginWidth (int x)
int marginWidth () const
void setMarginHeight (int y)
int marginHeight ()
virtual void setVerticalScrollBarPolicy (Qt::ScrollBarPolicy policy)
virtual void setHorizontalScrollBarPolicy (Qt::ScrollBarPolicy policy)
void print (bool quick=false)
void displayAccessKeys ()
int contentsWidth () const
int contentsHeight () const
int contentsX () const
int contentsY () const
int visibleWidth () const
int visibleHeight () const
void setContentsPos (int x, int y)
QPoint contentsToViewport (const QPoint &p) const
QPoint viewportToContents (const QPoint &p) const
void viewportToContents (int x, int y, int &cx, int &cy) const
void contentsToViewport (int x, int y, int &cx, int &cy) const
void scrollBy (int x, int y)
void updateContents (const QRect &r)
void updateContents (int x, int y, int w, int h)
void addChild (QWidget *child, int dx, int dy)
void repaintContents (const QRect &r)
void repaintContents (int x, int y, int w, int h)
void setZoomLevel (int percent)
int zoomLevel () const

Protected Slots

void slotPaletteChanged ()

Protected Member Functions

void clear ()
virtual bool event (QEvent *event)
virtual void paintEvent (QPaintEvent *)
virtual void resizeEvent (QResizeEvent *event)
virtual void showEvent (QShowEvent *)
virtual void hideEvent (QHideEvent *)
virtual bool focusNextPrevChild (bool next)
virtual void mousePressEvent (QMouseEvent *)
virtual void focusInEvent (QFocusEvent *)
virtual void focusOutEvent (QFocusEvent *)
virtual void mouseDoubleClickEvent (QMouseEvent *)
virtual void mouseMoveEvent (QMouseEvent *)
virtual void mouseReleaseEvent (QMouseEvent *)
virtual void wheelEvent (QWheelEvent *)
virtual void dragEnterEvent (QDragEnterEvent *)
virtual void dropEvent (QDropEvent *)
virtual void closeEvent (QCloseEvent *)
virtual bool widgetEvent (QEvent *)
virtual bool viewportEvent (QEvent *e)
virtual bool eventFilter (QObject *, QEvent *)
virtual void scrollContentsBy (int dx, int dy)
void keyPressEvent (QKeyEvent *_ke)
void keyReleaseEvent (QKeyEvent *_ke)
void doAutoScroll ()
void timerEvent (QTimerEvent *)

Friends

class DOM::HTMLDocumentImpl
class DOM::HTMLTitleElementImpl
class DOM::HTMLGenericFormElementImpl
class DOM::HTMLFormElementImpl
class DOM::HTMLAnchorElementImpl
class DOM::HTMLInputElementImpl
class DOM::NodeImpl
class DOM::DocumentImpl
class KHTMLPart
class khtml::RenderCanvas
class khtml::RenderObject
class khtml::RenderLineEdit
class khtml::RenderPartObject
class khtml::RenderWidget
class khtml::RenderLayer
class khtml::RenderBox
class khtml::CSSStyleSelector
class khtml::LineEditWidget
class KJS::WindowFunc
class KJS::ExternalFunc
void applyRule (DOM::CSSProperty *prop)

Constructor & Destructor Documentation

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

Constructs a KHTMLView.

Definition at line 525 of file khtmlview.cpp.

KHTMLView::~KHTMLView (  )  [virtual]

Definition at line 545 of file khtmlview.cpp.


Member Function Documentation

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

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

Definition at line 129 of file khtmlview.h.

int KHTMLView::frameWidth (  )  const [inline]

Definition at line 131 of file khtmlview.h.

void KHTMLView::setMarginWidth ( int  x  ) 

Sets a margin in x direction.

Definition at line 917 of file khtmlview.cpp.

int KHTMLView::marginWidth (  )  const [inline]

Returns the margin width.

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

Definition at line 143 of file khtmlview.h.

void KHTMLView::setMarginHeight ( int  y  ) 

Definition at line 923 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 155 of file khtmlview.h.

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 3384 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 3393 of file khtmlview.cpp.

void KHTMLView::print ( bool  quick = false  ) 

Prints the HTML document.

Parameters:
quick if true, fully automated printing, without print dialog

Definition at line 3056 of file khtmlview.cpp.

void KHTMLView::displayAccessKeys (  ) 

Display all accesskeys in small tooltips.

Definition at line 2538 of file khtmlview.cpp.

int KHTMLView::contentsWidth (  )  const

Returns the contents area's width.

Definition at line 652 of file khtmlview.cpp.

int KHTMLView::contentsHeight (  )  const

Returns the contents area's height.

Definition at line 657 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 671 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 676 of file khtmlview.cpp.

int KHTMLView::visibleWidth (  )  const

Returns the width of the viewport.

Definition at line 681 of file khtmlview.cpp.

int KHTMLView::visibleHeight (  )  const

Returns the height of the viewport.

Definition at line 700 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 719 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 731 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 744 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 749 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 736 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 725 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 768 of file khtmlview.cpp.

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

Definition at line 757 of file khtmlview.cpp.

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

Definition at line 3867 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 784 of file khtmlview.cpp.

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

Definition at line 773 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 1052 of file khtmlview.cpp.

int KHTMLView::zoomLevel (  )  const

Retrieve the current zoom level.

Definition at line 1064 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 662 of file khtmlview.cpp.

void KHTMLView::layout (  )  [slot]

ensure the display is up to date

Definition at line 929 of file khtmlview.cpp.

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::cleared (  )  [signal]

void KHTMLView::zoomView ( int   )  [signal]

void KHTMLView::hideAccessKeys (  )  [signal]

void KHTMLView::repaintAccessKeys (  )  [signal]

void KHTMLView::findAheadActive ( bool   )  [signal]

void KHTMLView::clear (  )  [protected]

Definition at line 591 of file khtmlview.cpp.

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

Definition at line 464 of file khtmlview.cpp.

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

Definition at line 841 of file khtmlview.cpp.

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

Definition at line 821 of file khtmlview.cpp.

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

Definition at line 625 of file khtmlview.cpp.

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

Definition at line 618 of file khtmlview.cpp.

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

Definition at line 1940 of file khtmlview.cpp.

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

Definition at line 1074 of file khtmlview.cpp.

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

Definition at line 3721 of file khtmlview.cpp.

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

Definition at line 3751 of file khtmlview.cpp.

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

Definition at line 1198 of file khtmlview.cpp.

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

Definition at line 1261 of file khtmlview.cpp.

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

Definition at line 1476 of file khtmlview.cpp.

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

Definition at line 3631 of file khtmlview.cpp.

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

Definition at line 3709 of file khtmlview.cpp.

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

Definition at line 3715 of file khtmlview.cpp.

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

Definition at line 1046 of file khtmlview.cpp.

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

Definition at line 2253 of file khtmlview.cpp.

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

Definition at line 2048 of file khtmlview.cpp.

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

Definition at line 2101 of file khtmlview.cpp.

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

Definition at line 3797 of file khtmlview.cpp.

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

Definition at line 1609 of file khtmlview.cpp.

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

Definition at line 1887 of file khtmlview.cpp.

void KHTMLView::doAutoScroll (  )  [protected]

Definition at line 1959 of file khtmlview.cpp.

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

Definition at line 3880 of file khtmlview.cpp.

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

Definition at line 3242 of file khtmlview.cpp.


Friends And Related Function Documentation

friend class DOM::HTMLDocumentImpl [friend]

Definition at line 95 of file khtmlview.h.

friend class DOM::HTMLTitleElementImpl [friend]

Definition at line 96 of file khtmlview.h.

friend class DOM::HTMLGenericFormElementImpl [friend]

Definition at line 97 of file khtmlview.h.

friend class DOM::HTMLFormElementImpl [friend]

Definition at line 98 of file khtmlview.h.

friend class DOM::HTMLAnchorElementImpl [friend]

Definition at line 99 of file khtmlview.h.

friend class DOM::HTMLInputElementImpl [friend]

Definition at line 100 of file khtmlview.h.

friend class DOM::NodeImpl [friend]

Definition at line 101 of file khtmlview.h.

friend class DOM::DocumentImpl [friend]

Definition at line 102 of file khtmlview.h.

friend class KHTMLPart [friend]

Definition at line 103 of file khtmlview.h.

friend class khtml::RenderCanvas [friend]

Definition at line 104 of file khtmlview.h.

friend class khtml::RenderObject [friend]

Definition at line 105 of file khtmlview.h.

friend class khtml::RenderLineEdit [friend]

Definition at line 106 of file khtmlview.h.

friend class khtml::RenderPartObject [friend]

Definition at line 107 of file khtmlview.h.

friend class khtml::RenderWidget [friend]

Definition at line 108 of file khtmlview.h.

friend class khtml::RenderLayer [friend]

Definition at line 109 of file khtmlview.h.

friend class khtml::RenderBox [friend]

Definition at line 110 of file khtmlview.h.

friend class khtml::CSSStyleSelector [friend]

Definition at line 111 of file khtmlview.h.

friend class khtml::LineEditWidget [friend]

Definition at line 112 of file khtmlview.h.

friend class KJS::WindowFunc [friend]

Definition at line 113 of file khtmlview.h.

friend class KJS::ExternalFunc [friend]

Definition at line 114 of file khtmlview.h.

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


The documentation for this class was generated from the following files:
  • khtmlview.h
  • khtmlview.cpp

KHTML

Skip menu "KHTML"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   WTF
  • KJSEmbed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  •   core
  • Phonon
  •   Backend
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal