KURLLabel Class Reference
A drop-in replacement for QLabel that displays hyperlinks. More...
#include <kurllabel.h>
Inheritance diagram for KURLLabel:

Public Slots | |
void | setUnderline (bool on=true) |
void | setURL (const QString &url) |
virtual void | setFont (const QFont &) |
void | setUseTips (bool on=true) |
void | setTipText (const QString &tip) |
void | setHighlightedColor (const QColor &highcolor) |
void | setHighlightedColor (const QString &highcolor) |
void | setSelectedColor (const QColor &selcolor) |
void | setSelectedColor (const QString &selcolor) |
void | setUseCursor (bool on, QCursor *cursor=0L) |
void | setGlow (bool glow=true) |
void | setFloat (bool do_float=true) |
void | setAltPixmap (const QPixmap &altPix) |
Signals | |
void | enteredURL (const QString &url) |
void | enteredURL () |
void | leftURL (const QString &url) |
void | leftURL () |
void | leftClickedURL (const QString &url) |
void | leftClickedURL () |
void | rightClickedURL (const QString &url) |
void | rightClickedURL () |
void | middleClickedURL (const QString &url) |
void | middleClickedURL () |
Public Member Functions | |
KURLLabel (QWidget *parent=0L, const char *name=0L) | |
KURLLabel (const QString &url, const QString &text=QString::null, QWidget *parent=0L, const char *name=0L) | |
virtual | ~KURLLabel () |
const QString & | url () const |
const QString & | tipText () const |
bool | useTips () const |
bool | useCursor () const |
bool | isGlowEnabled () const |
bool | isFloatEnabled () const |
const QPixmap * | altPixmap () const |
Protected Member Functions | |
virtual void | mouseReleaseEvent (QMouseEvent *) |
virtual void | enterEvent (QEvent *) |
virtual void | leaveEvent (QEvent *) |
virtual bool | event (QEvent *e) |
virtual void | virtual_hook (int id, void *data) |
Properties | |
QString | url |
QString | tipText |
QPixmap | altPixmap |
bool | glowEnabled |
bool | floatEnabled |
bool | useTips |
bool | useCursor |
Detailed Description
A drop-in replacement for QLabel that displays hyperlinks.KURLLabel is a drop-in replacement for QLabel that handles text in a fashion similar to how an HTML widget handles hyperlinks. The text can be underlined (or not) and set to different colors. It can also "glow" (cycle colors) when the mouse passes over it.
KURLLabel also provides signals for several events, including the mouse leaving and entering the text area and all forms of mouse clicking.
A typical usage would be something like so:
KURLLabel *address = new KURLLabel(this); address->setText("My homepage"); address->setURL("http://www.home.com/~me"); connect(address, SIGNAL(leftClickedURL(const QString&)), SLOT(processMyURL(const QString&)));
In this example, the text "My homepage" would be displayed as blue, underlined text. When the mouse passed over it, it would "glow" red. When the user clicks on the text, the signal leftClickedURL() would be emitted with "http://www.home.com/~me" as its argument.

KDE URL Label
- Author:
- Kurt Granroth <granroth@kde.org> (Interface)
Peter Putzer <putzer@kde.org> (Rewrite)
- Version:
- Id
- kurllabel.h,v 1.28 2003/09/11 14:03:17 staikos Exp
Definition at line 64 of file kurllabel.h.
Constructor & Destructor Documentation
|
Default constructor. Use setURL() and setText() or QListView::setPixmap() to set the resp. properties. Definition at line 84 of file kurllabel.cpp. References setFont(). |
|
Convenience constructor.
parent and name are passed to QLabel, which in turn passes them further down Definition at line 74 of file kurllabel.cpp.
References setFont(). |
|
Destructs the label. Definition at line 93 of file kurllabel.cpp. |
Member Function Documentation
|
Returns the URL.
|
|
Returns the current tooltip text.
|
|
|
|
|
|
When this is on, the text will switch to the selected color whenever the mouse passes over it. Definition at line 258 of file kurllabel.cpp. |
|
This feature is very similar to the "glow" feature in that the color of the label switches to the selected color when the cursor passes over it. In addition, underlining is turned on for as long as the mouse is overhead. Note that if "glow" and underlining are both already turned on, this feature will have no visible effect. Definition at line 263 of file kurllabel.cpp. |
|
|
|
Turns on or off the underlining.
When this is on, the text will be underlined. By default, it is References setFont(). Referenced by KDialogBase::enableLinkedHelp(), enterEvent(), and leaveEvent(). |
|
Sets the URL for this label to
References setUseTips(). |
|
Overridden for internal reasons; the API remains unaffected.
Reimplemented from QLabel. Definition at line 127 of file kurllabel.cpp. References QLabel::setFont(), and QFont::setUnderline(). Referenced by KURLLabel(), and setUnderline(). |
|
Turns on or off the tool tip feature.
When this is on, the URL will be displayed as a tooltip whenever the mouse passes passes over it. By default, it is References QToolTip::add(), and QToolTip::remove(). Referenced by setTipText(), and setURL(). |
|
Specifies what text to display when tooltips are turned on. If this is not used, the tip will default to the URL.
References setUseTips(). |
|
Sets the highlight color.
This is the default foreground color (non-selected). By default, it is Referenced by setHighlightedColor(). |
|
This is an overloaded version for convenience.
References setHighlightedColor(). |
|
Sets the selected color.
This is the color the text will change to when either a mouse passes over it and "glow" mode is on or when it is selected (clicked). By default, it is Referenced by setSelectedColor(). |
|
This is an overloaded version for convenience.
References setSelectedColor(). |
|
Turns the custom cursor feature on or off. When this is on, the cursor will change to a custom cursor (default is a "pointing hand") whenever the cursor passes over the label. By default, it is on.
|
|
Turns on or off the "glow" feature.
When this is on, the text will switch to the selected color whenever the mouse passes over it. By default, it is |
|
Turns on or off the "float" feature.
This feature is very similar to the "glow" feature in that the color of the label switches to the selected color when the cursor passes over it. In addition, underlining is turned on for as long as the mouse is overhead. Note that if "glow" and underlining are both already turned on, this feature will have no visible effect. By default, it is Referenced by KDialogBase::enableLinkedHelp(). |
|
Sets the "alt" pixmap. This pixmap will be displayed when the cursor passes over the label. The effect is similar to the trick done with 'onMouseOver' in javascript.
|
|
Emitted when the mouse has passed over the label.
|
|
Emitted when the mouse has passed over the label.
Referenced by enterEvent(). |
|
Emitted when the mouse is no longer over the label.
|
|
Emitted when the mouse is no longer over the label.
Referenced by leaveEvent(). |
|
Emitted when the user clicked the left mouse button on this label.
|
|
Emitted when the user clicked the left mouse button on this label.
Referenced by mouseReleaseEvent(). |
|
Emitted when the user clicked the right mouse button on this label.
|
|
Emitted when the user clicked the right mouse button on this label.
Referenced by mouseReleaseEvent(). |
|
Emitted when the user clicked the middle mouse button on this label.
|
|
Emitted when the user clicked the left mouse button on this label.
Referenced by mouseReleaseEvent(). |
|
Overridden for internal reasons; the API remains unaffected. Definition at line 98 of file kurllabel.cpp. References QMouseEvent::button(), leftClickedURL(), middleClickedURL(), and rightClickedURL(). |
|
Overridden for internal reasons; the API remains unaffected. Definition at line 278 of file kurllabel.cpp. References enteredURL(), QLabel::pixmap(), QLabel::setPixmap(), and setUnderline(). |
|
Overridden for internal reasons; the API remains unaffected. Definition at line 304 of file kurllabel.cpp. References leftURL(), QLabel::pixmap(), QLabel::setPixmap(), and setUnderline(). |
|
Catch parent palette changes. Definition at line 320 of file kurllabel.cpp. References QPalette::brush(), KGlobalSettings::linkColor(), QPalette::setBrush(), QPalette::setColor(), and QEvent::type(). |
The documentation for this class was generated from the following files: