kdeui Library API Documentation

KTextBrowser Class Reference

An extended QTextBrowser. Extended QTextBrowser. More...

#include <ktextbrowser.h>

Inheritance diagram for KTextBrowser:

QTextBrowser List of all members.

Signals

void mailClick (const QString &name, const QString &address)
 Emitted when a mail link has been activated and the widget has been configured to emit the signal.

void urlClick (const QString &url)
 Emitted if mailClick() is not emitted and the widget has been configured to emit the signal.


Public Methods

 KTextBrowser (QWidget *parent=0, const char *name=0, bool notifyClick=false)
 Constructor.

 ~KTextBrowser (void)
 Destructor.

void setNotifyClick (bool notifyClick)
 Decide whether a click on a link should be handled internally or if a signal should be emitted.

bool isNotifyClick () const
 Returns whether a click on a link should be handled internally or if a signal should be emitted.


Protected Methods

void setSource (const QString &name)
 Reimplemented to NOT set the source but to do the special handling.

virtual void keyPressEvent (QKeyEvent *e)
 Makes sure Key_Escape is ignored.

virtual void viewportMouseMoveEvent (QMouseEvent *e)
 Make sure we use our own hand cursor.

virtual void contentsWheelEvent (QWheelEvent *e)
 Reimplemented to support Qt2 behavior (Ctrl-Wheel = fast scroll).


Detailed Description

An extended QTextBrowser. 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.

Author:
Espen Sand (espensa@online.no)
Version:
Id:
ktextbrowser.h,v 1.13 2002/03/04 00:51:51 lunakl Exp

Definition at line 38 of file ktextbrowser.h.


Constructor & Destructor Documentation

KTextBrowser::KTextBrowser QWidget   parent = 0,
const char *    name = 0,
bool    notifyClick = false
 

Constructor.

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

Definition at line 82 of file ktextbrowser.cpp.

KTextBrowser::~KTextBrowser void   
 

Destructor.

Definition at line 92 of file ktextbrowser.cpp.


Member Function Documentation

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 97 of file ktextbrowser.cpp.

bool KTextBrowser::isNotifyClick  
 

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

Definition at line 103 of file ktextbrowser.cpp.

void KTextBrowser::setSource const QString   name [protected]
 

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

Do not call.

Reimplemented from QTextBrowser.

Definition at line 109 of file ktextbrowser.cpp.

References QString::contains(), QString::isNull(), mailClick(), and urlClick().

void KTextBrowser::keyPressEvent QKeyEvent   e [protected, virtual]
 

Makes sure Key_Escape is ignored.

Reimplemented from QTextBrowser.

Definition at line 141 of file ktextbrowser.cpp.

References QKeyEvent::ignore(), QKeyEvent::key(), and QTextBrowser::keyPressEvent().

void KTextBrowser::viewportMouseMoveEvent QMouseEvent   e [protected, virtual]
 

Make sure we use our own hand cursor.

Definition at line 157 of file ktextbrowser.cpp.

References KCursor::handCursor().

void KTextBrowser::contentsWheelEvent QWheelEvent   e [protected, virtual]
 

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

Definition at line 166 of file ktextbrowser.cpp.

References QScrollView::contentsWheelEvent(), and KGlobalSettings::wheelMouseZooms().

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::null at the moment.
address  The destination address.

Referenced by setSource().

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.

Referenced by setSource().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:07 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001