diff options
Diffstat (limited to 'kdeui/ktextbrowser.h')
-rw-r--r-- | kdeui/ktextbrowser.h | 133 |
1 files changed, 133 insertions, 0 deletions
diff --git a/kdeui/ktextbrowser.h b/kdeui/ktextbrowser.h new file mode 100644 index 000000000..68fa7f18e --- /dev/null +++ b/kdeui/ktextbrowser.h @@ -0,0 +1,133 @@ +/* This file is part of the KDE Libraries + * Copyright (C) 1999 Espen Sand (espensa@online.no) + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public License + * along with this library; see the file COPYING.LIB. If not, write to + * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + +#ifndef _KTEXT_BROWSER_H_ +#define _KTEXT_BROWSER_H_ + +#include <qtextbrowser.h> + +#include <kdelibs_export.h> + +/** + * @short 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. + * + * \image html ktextbrowser.png "KDE Text Browser" + * + * @author Espen Sand (espensa@online.no) + */ + +class KDEUI_EXPORT KTextBrowser : public QTextBrowser +{ + Q_OBJECT + Q_PROPERTY( bool notifyClick READ isNotifyClick WRITE setNotifyClick ) + + public: + /** + * Constructor. + * + * @param parent Parent of the widget. + * @param name Widget name. + * @param notifyClick @p true causes signals to be emitted. + */ + KTextBrowser( QWidget *parent=0, const char *name=0, + bool notifyClick=false ); + + /** + * Destructor. + */ + ~KTextBrowser( void ); + + /** + * Decide whether a click on a link should be handled internally + * or if a signal should be emitted. + * + * @param notifyClick @p true causes signals to be emitted. + */ + void setNotifyClick( bool notifyClick ); + /** + * Returns whether a click on a link should be handled internally + * or if a signal should be emitted. + */ + bool isNotifyClick() const; + + protected: + /** + Reimplemented to NOT set the source but to do the special handling. + Do not call. + */ + void setSource(const QString& name); + + /** + * Makes sure Key_Escape is ignored + */ + virtual void keyPressEvent(QKeyEvent *e); + + /** + * Make sure we use our own hand cursor + */ + virtual void viewportMouseMoveEvent( QMouseEvent* e); + + /** + * Reimplemented to support Qt2 behavior (Ctrl-Wheel = fast scroll) + */ + virtual void contentsWheelEvent( QWheelEvent *e ); + + /** + * Re-implemented for internal reasons. API not affected. + * + * See QLineEdit::createPopupMenu(). + */ + virtual QPopupMenu *createPopupMenu( const QPoint &pos ); + + signals: + /** + * Emitted when a mail link has been activated and the widget has + * been configured to emit the signal. + * + * @param name The destination name. It is QString::null at the moment. + * @param address The destination address. + */ + void mailClick( const QString &name, const QString &address ); + + /** + * Emitted if mailClick() is not emitted and the widget has been + * configured to emit the signal. + * + * @param url The destination address. + */ + void urlClick( const QString &url ); + + private: + bool mNotifyClick; + + protected: + virtual void virtual_hook( int id, void* data ); + private: + class KTextBrowserPrivate; + KTextBrowserPrivate *d; +}; + +#endif |