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

KDEUI

KTextBrowser Class Reference

Extended QTextBrowser. More...

#include <ktextbrowser.h>

Inheritance diagram for KTextBrowser:

Inheritance graph
[legend]

List of all members.


Signals

void mailClick (const QString &name, const QString &address)
void urlClick (const QString &url)

Public Member Functions

bool isNotifyClick () const
 KTextBrowser (QWidget *parent=0, bool notifyClick=false)
void setNotifyClick (bool notifyClick)
 ~KTextBrowser ()

Protected Member Functions

virtual void contextMenuEvent (QContextMenuEvent *event)
virtual void keyPressEvent (QKeyEvent *event)
void setSource (const QUrl &name)
virtual void wheelEvent (QWheelEvent *event)

Properties

bool notifyClick

Detailed Description

Extended QTextBrowser.

An extended QTextBrowser.

By default it will invoke the system mailer or the system browser when a link is activated, or it can emit the signal urlClick() or mailClick() when a link is activated.

If the link starts with the text "whatsthis:" a QWhatsThis box will appear and then display the rest of the text.

ktextbrowser.png

KDE Text Browser

Author:
Espen Sand (espensa@online.no)

Definition at line 47 of file ktextbrowser.h.


Constructor & Destructor Documentation

KTextBrowser::KTextBrowser ( QWidget *  parent = 0,
bool  notifyClick = false 
) [explicit]

Creates a new text browser.

Parameters:
parent Parent of the widget.
notifyClick true causes signals to be emitted.

Definition at line 51 of file ktextbrowser.cpp.

KTextBrowser::~KTextBrowser (  ) 

Destroys the text browser.

Definition at line 57 of file ktextbrowser.cpp.


Member Function Documentation

void KTextBrowser::contextMenuEvent ( QContextMenuEvent *  event  )  [protected, virtual]

Re-implemented for internal reasons.

API not affected.

See QLineEdit::createPopupMenu().

Definition at line 118 of file ktextbrowser.cpp.

bool KTextBrowser::isNotifyClick (  )  const

Returns whether a click on a link should be handled internally or if a signal should be emitted.

Definition at line 69 of file ktextbrowser.cpp.

void KTextBrowser::keyPressEvent ( QKeyEvent *  event  )  [protected, virtual]

Makes sure Key_Escape is ignored.

Reimplemented from QTextBrowser.

Definition at line 100 of file ktextbrowser.cpp.

void KTextBrowser::mailClick ( const QString &  name,
const QString &  address 
) [signal]

Emitted when a mail link has been activated and the widget has been configured to emit the signal.

Parameters:
name The destination name. It is QString() at the moment.
address The destination address.

void KTextBrowser::setNotifyClick ( bool  notifyClick  ) 

Decide whether a click on a link should be handled internally or if a signal should be emitted.

Parameters:
notifyClick true causes signals to be emitted.

Definition at line 63 of file ktextbrowser.cpp.

void KTextBrowser::setSource ( const QUrl &  name  )  [protected]

Reimplemented to NOT set the source but to do the special handling.

Do not call.

Definition at line 75 of file ktextbrowser.cpp.

void KTextBrowser::urlClick ( const QString &  url  )  [signal]

Emitted if mailClick() is not emitted and the widget has been configured to emit the signal.

Parameters:
url The destination address.

void KTextBrowser::wheelEvent ( QWheelEvent *  event  )  [protected, virtual]

Reimplemented to support Qt2 behavior (Ctrl-Wheel = fast scroll).

Definition at line 110 of file ktextbrowser.cpp.


Property Documentation

bool KTextBrowser::notifyClick [read, write]

Definition at line 50 of file ktextbrowser.h.


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

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • 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
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
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