.TH "KTextBrowser" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTextBrowser \- An extended \fBQTextBrowser\fP. Extended \fBQTextBrowser\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ktextbrowser.h>\fP
.PP
Inherits \fBQTextBrowser\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBmailClick\fP (const  \fBQString\fP &name, const  \fBQString\fP &address)"
.br
.RI "\fIEmitted when a mail link has been activated and the widget has been configured to emit the signal. \fP"
.ti -1c
.RI "void \fBurlClick\fP (const  \fBQString\fP &url)"
.br
.RI "\fIEmitted if \fBmailClick\fP() is not emitted and the widget has been configured to emit the signal. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKTextBrowser\fP (\fBQWidget\fP *parent=0, const  char *name=0, bool notifyClick=false)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fB~KTextBrowser\fP (void)"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "void \fBsetNotifyClick\fP (bool notifyClick)"
.br
.RI "\fIDecide whether a click on a link should be handled internally or if a signal should be emitted. \fP"
.ti -1c
.RI "bool \fBisNotifyClick\fP () const "
.br
.RI "\fIReturns whether a click on a link should be handled internally or if a signal should be emitted. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetSource\fP (const  \fBQString\fP &name)"
.br
.RI "\fIReimplemented to NOT set the source but to do the special handling. \fP"
.ti -1c
.RI "virtual void \fBkeyPressEvent\fP (\fBQKeyEvent\fP *e)"
.br
.RI "\fIMakes sure Key_Escape is ignored. \fP"
.ti -1c
.RI "virtual void \fBviewportMouseMoveEvent\fP (\fBQMouseEvent\fP *e)"
.br
.RI "\fIMake sure we use our own hand cursor. \fP"
.ti -1c
.RI "virtual void \fBcontentsWheelEvent\fP (\fBQWheelEvent\fP *e)"
.br
.RI "\fIReimplemented to support Qt2 behavior (Ctrl-Wheel = fast scroll). \fP"
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
An extended \fBQTextBrowser\fP. Extended \fBQTextBrowser\fP. 

By default it will invoke the system mailer or the system browser when a link is activated, or it can emit the signal \fBurlClick\fP() or \fBmailClick\fP() when a link is activated.
.PP
\fBAuthor:\fP
.RS 4
Espen Sand (espensa@online.no) 
.RE
.PP
\fBVersion:\fP
.RS 4
\fBId\fP.RS 4
\fBktextbrowser.h\fP,v 1.13 2002/03/04 00:51:51 lunakl Exp 
.RE
.PP
.RE
.PP

.PP
Definition at line 38 of file ktextbrowser.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KTextBrowser::KTextBrowser (\fBQWidget\fP * parent = 0, const char * name = 0, bool notifyClick = false)"
.PP
Constructor. \fBParameters:\fP
.RS 4
\fIparent\fP Parent of the widget. 
.br
\fIname\fP Widget name. 
.br
\fInotifyClick\fP \fCtrue\fP causes signals to be emitted. 
.RE
.PP
Definition at line 82 of file ktextbrowser.cpp.
.PP
References KStdAccel::name().
.SS "KTextBrowser::~\fBKTextBrowser\fP (void)"
.PP
Destructor. Definition at line 92 of file ktextbrowser.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KTextBrowser::setNotifyClick (bool notifyClick)"
.PP
Decide whether a click on a link should be handled internally or if a signal should be emitted. \fBParameters:\fP
.RS 4
\fInotifyClick\fP \fCtrue\fP causes signals to be emitted. 
.RE
.PP
Definition at line 97 of file ktextbrowser.cpp.
.SS "bool KTextBrowser::isNotifyClick () const"
.PP
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.
.SS "void KTextBrowser::setSource (const \fBQString\fP & name)\fC [protected]\fP"
.PP
Reimplemented to NOT set the source but to do the special handling. Do not call. Reimplemented from \fBQTextBrowser\fP.
.PP
Definition at line 109 of file ktextbrowser.cpp.
.PP
References QString::contains(), QString::isNull(), mailClick(), KStdAccel::name(), and urlClick().
.SS "void KTextBrowser::keyPressEvent (\fBQKeyEvent\fP * e)\fC [protected, virtual]\fP"
.PP
Makes sure Key_Escape is ignored. Reimplemented from \fBQTextBrowser\fP.
.PP
Definition at line 141 of file ktextbrowser.cpp.
.PP
References QKeyEvent::ignore(), QKeyEvent::key(), and QTextBrowser::keyPressEvent().
.SS "void KTextBrowser::viewportMouseMoveEvent (\fBQMouseEvent\fP * e)\fC [protected, virtual]\fP"
.PP
Make sure we use our own hand cursor. Definition at line 157 of file ktextbrowser.cpp.
.PP
References KCursor::handCursor().
.SS "void KTextBrowser::contentsWheelEvent (\fBQWheelEvent\fP * e)\fC [protected, virtual]\fP"
.PP
Reimplemented to support Qt2 behavior (Ctrl-Wheel = fast scroll). Definition at line 166 of file ktextbrowser.cpp.
.PP
References QScrollView::contentsWheelEvent(), and KGlobalSettings::wheelMouseZooms().
.SS "void KTextBrowser::mailClick (const \fBQString\fP & name, const \fBQString\fP & address)\fC [signal]\fP"
.PP
Emitted when a mail link has been activated and the widget has been configured to emit the signal. \fBParameters:\fP
.RS 4
\fIname\fP The destination name. It is QString::null at the moment. 
.br
\fIaddress\fP The destination address. 
.RE
.PP
Referenced by setSource().
.SS "void KTextBrowser::urlClick (const \fBQString\fP & url)\fC [signal]\fP"
.PP
Emitted if \fBmailClick\fP() is not emitted and the widget has been configured to emit the signal. \fBParameters:\fP
.RS 4
\fIurl\fP The destination address. 
.RE
.PP
Referenced by setSource().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
