KHTML
#include <khtmlview.h>

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 | |
KHTMLView (KHTMLPart *part, QWidget *parent) | |
virtual | ~KHTMLView () |
void | addChild (QWidget *child, int dx, int dy) |
int | contentsHeight () const |
QPoint | contentsToViewport (const QPoint &p) const |
void | contentsToViewport (int x, int y, int &cx, int &cy) const |
int | contentsWidth () const |
int | contentsX () const |
int | contentsY () const |
void | displayAccessKeys () |
int | frameWidth () const |
int | marginHeight () |
int | marginWidth () const |
KHTMLPart * | part () const |
void | print (bool quick=false) |
void | repaintContents (const QRect &r) |
void | repaintContents (int x, int y, int w, int h) |
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 (const QRect &r) |
void | updateContents (int x, int y, int w, int h) |
QPoint | viewportToContents (const QPoint &p) const |
void | viewportToContents (int x, int y, int &cx, int &cy) const |
int | visibleHeight () const |
int | visibleWidth () const |
int | zoomLevel () const |
![]() | |
KHTMLWidget () | |
~KHTMLWidget () | |
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 *) |
Additional Inherited Members | |
![]() | |
KHTMLWidgetPrivate * | m_kwp |
Detailed Description
Renders and displays HTML in a QScrollArea.
Suitable for use as an application's main view.
Definition at line 92 of file khtmlview.h.
Member Enumeration Documentation
◆ 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 305 of file khtmlview.h.
Constructor & Destructor Documentation
◆ KHTMLView()
Constructs a KHTMLView.
Definition at line 549 of file khtmlview.cpp.
◆ ~KHTMLView()
|
virtual |
Definition at line 563 of file khtmlview.cpp.
Member Function Documentation
◆ addChild()
void KHTMLView::addChild | ( | QWidget * | child, |
int | dx, | ||
int | dy | ||
) |
Definition at line 3952 of file khtmlview.cpp.
◆ clear()
|
protected |
Definition at line 621 of file khtmlview.cpp.
◆ cleared
|
signal |
◆ closeEvent()
|
protectedvirtual |
Definition at line 1062 of file khtmlview.cpp.
◆ contentsHeight()
int KHTMLView::contentsHeight | ( | ) | const |
Returns the contents area's height.
Definition at line 676 of file khtmlview.cpp.
◆ contentsToViewport() [1/2]
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 747 of file khtmlview.cpp.
◆ contentsToViewport() [2/2]
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 752 of file khtmlview.cpp.
◆ contentsWidth()
int KHTMLView::contentsWidth | ( | ) | const |
Returns the contents area's width.
Definition at line 671 of file khtmlview.cpp.
◆ contentsX()
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 690 of file khtmlview.cpp.
◆ contentsY()
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 695 of file khtmlview.cpp.
◆ displayAccessKeys()
void KHTMLView::displayAccessKeys | ( | ) |
Display all accesskeys in small tooltips.
Definition at line 2502 of file khtmlview.cpp.
◆ doAutoScroll()
|
protected |
Definition at line 1887 of file khtmlview.cpp.
◆ dragEnterEvent()
|
protectedvirtual |
Definition at line 3716 of file khtmlview.cpp.
◆ dropEvent()
|
protectedvirtual |
Definition at line 3722 of file khtmlview.cpp.
◆ event()
|
protectedvirtual |
Definition at line 481 of file khtmlview.cpp.
◆ eventFilter()
Definition at line 2024 of file khtmlview.cpp.
◆ findAheadActive
|
signal |
◆ finishedLayout
|
signal |
This signal is used for internal layouting.
Don't use it to check if rendering finished. Use KHTMLPart completed() signal instead.
◆ focusInEvent()
|
protectedvirtual |
Definition at line 3728 of file khtmlview.cpp.
◆ focusNextPrevChild()
|
protectedvirtual |
Definition at line 1868 of file khtmlview.cpp.
◆ focusOutEvent()
|
protectedvirtual |
Definition at line 3739 of file khtmlview.cpp.
◆ frameWidth()
|
inline |
Definition at line 137 of file khtmlview.h.
◆ hideAccessKeys
|
signal |
◆ hideEvent()
|
protectedvirtual |
Definition at line 641 of file khtmlview.cpp.
◆ keyPressEvent()
|
protected |
Definition at line 1676 of file khtmlview.cpp.
◆ keyReleaseEvent()
|
protected |
Definition at line 1826 of file khtmlview.cpp.
◆ layout
|
slot |
ensure the display is up to date
Definition at line 954 of file khtmlview.cpp.
◆ marginHeight()
|
inline |
Returns the margin height.
A return value of -1 means the default value will be used.
Definition at line 161 of file khtmlview.h.
◆ marginWidth()
|
inline |
Returns the margin width.
A return value of -1 means the default value will be used.
Definition at line 149 of file khtmlview.h.
◆ mouseDoubleClickEvent()
|
protectedvirtual |
Definition at line 1242 of file khtmlview.cpp.
◆ mouseMoveEvent()
|
protectedvirtual |
Definition at line 1301 of file khtmlview.cpp.
◆ mousePressEvent()
|
protectedvirtual |
Definition at line 1113 of file khtmlview.cpp.
◆ mouseReleaseEvent()
|
protectedvirtual |
Definition at line 1545 of file khtmlview.cpp.
◆ paintEvent()
|
protectedvirtual |
Definition at line 869 of file khtmlview.cpp.
◆ part()
|
inline |
Returns a pointer to the KHTMLPart that is rendering the page.
Definition at line 135 of file khtmlview.h.
◆ print()
void KHTMLView::print | ( | bool | quick = false | ) |
Prints the HTML document.
- Parameters
-
quick if true, fully automated printing, without print dialog
Definition at line 3027 of file khtmlview.cpp.
◆ repaintAccessKeys
|
signal |
◆ repaintContents() [1/2]
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 800 of file khtmlview.cpp.
◆ repaintContents() [2/2]
void KHTMLView::repaintContents | ( | int | x, |
int | y, | ||
int | w, | ||
int | h | ||
) |
Definition at line 789 of file khtmlview.cpp.
◆ resizeContents
|
virtualslot |
Resize the contents area.
- Parameters
-
w the new width h the new height
Definition at line 681 of file khtmlview.cpp.
◆ resizeEvent()
|
protectedvirtual |
Definition at line 837 of file khtmlview.cpp.
◆ scrollBy()
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 739 of file khtmlview.cpp.
◆ scrollContentsBy()
|
protectedvirtual |
Definition at line 3752 of file khtmlview.cpp.
◆ setContentsPos()
void KHTMLView::setContentsPos | ( | int | x, |
int | y | ||
) |
Place the contents area point x/y at the top left of the viewport.
Definition at line 732 of file khtmlview.cpp.
◆ setHorizontalScrollBarPolicy()
|
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 3377 of file khtmlview.cpp.
◆ setMarginHeight()
void KHTMLView::setMarginHeight | ( | int | y | ) |
Definition at line 948 of file khtmlview.cpp.
◆ setMarginWidth()
void KHTMLView::setMarginWidth | ( | int | x | ) |
Sets a margin in x direction.
Definition at line 942 of file khtmlview.cpp.
◆ setSmoothScrollingMode()
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 1085 of file khtmlview.cpp.
◆ setSmoothScrollingModeDefault()
|
protected |
Definition at line 1093 of file khtmlview.cpp.
◆ setVerticalScrollBarPolicy()
|
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 3367 of file khtmlview.cpp.
◆ setZoomLevel()
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 1068 of file khtmlview.cpp.
◆ showEvent()
|
protectedvirtual |
Definition at line 646 of file khtmlview.cpp.
◆ slotPaletteChanged
|
protectedslot |
Definition at line 3215 of file khtmlview.cpp.
◆ smoothScrollingMode()
KHTMLView::SmoothScrollingMode KHTMLView::smoothScrollingMode | ( | ) | const |
◆ timerEvent()
|
protected |
Definition at line 3965 of file khtmlview.cpp.
◆ updateContents() [1/2]
void KHTMLView::updateContents | ( | const QRect & | r | ) |
Requests an update of the content area.
- Parameters
-
r the content area rectangle to update
Definition at line 784 of file khtmlview.cpp.
◆ updateContents() [2/2]
void KHTMLView::updateContents | ( | int | x, |
int | y, | ||
int | w, | ||
int | h | ||
) |
Definition at line 773 of file khtmlview.cpp.
◆ viewportEvent()
|
protectedvirtual |
Definition at line 1979 of file khtmlview.cpp.
◆ viewportToContents() [1/2]
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 760 of file khtmlview.cpp.
◆ viewportToContents() [2/2]
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 765 of file khtmlview.cpp.
◆ visibleHeight()
int KHTMLView::visibleHeight | ( | ) | const |
Returns the height of the viewport.
Definition at line 716 of file khtmlview.cpp.
◆ visibleWidth()
int KHTMLView::visibleWidth | ( | ) | const |
Returns the width of the viewport.
Definition at line 700 of file khtmlview.cpp.
◆ wheelEvent()
|
protectedvirtual |
Definition at line 3636 of file khtmlview.cpp.
◆ widgetEvent()
|
protectedvirtual |
Definition at line 2195 of file khtmlview.cpp.
◆ zoomLevel()
int KHTMLView::zoomLevel | ( | ) | const |
Retrieve the current zoom level.
Definition at line 1080 of file khtmlview.cpp.
◆ zoomView
|
signal |
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.