KURLLabel Class Reference
#include <kurllabel.h>
Inheritance diagram for KURLLabel:

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.
By default KURLLabel accepts focus. When focused, standard focus rectangle is displayed as in HTML widget. Pressing Enter key accepts the focused label.
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 465272 2005-09-29 09:47:40Z mueller
Definition at line 71 of file kurllabel.h.
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 |
Constructor & Destructor Documentation
|
Default constructor. Use setURL() and setText() or QListView::setPixmap() to set the resp. properties. Definition at line 89 of file kurllabel.cpp. |
|
Convenience constructor.
parent and name are passed to QLabel, which in turn passes them further down
Definition at line 77 of file kurllabel.cpp. |
|
Destructs the label.
Definition at line 100 of file kurllabel.cpp. |
Member Function Documentation
|
|
|
Emitted when the mouse has passed over the label.
|
|
Emitted when the mouse has passed over the label.
|
|
Overridden for internal reasons; the API remains unaffected.
Definition at line 285 of file kurllabel.cpp. |
|
Catch parent palette changes.
Definition at line 327 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 270 of file kurllabel.cpp. |
|
When this is on, the text will switch to the selected color whenever the mouse passes over it.
Definition at line 265 of file kurllabel.cpp. |
|
Overridden for internal reasons; the API remains unaffected.
Definition at line 311 of file kurllabel.cpp. |
|
Emitted when the user clicked the left mouse button on this label.
|
|
Emitted when the user clicked the left mouse button on this label.
|
|
Emitted when the mouse is no longer over the label.
|
|
Emitted when the mouse is no longer over the label.
|
|
Emitted when the user clicked the left mouse button on this label.
|
|
Emitted when the user clicked the middle mouse button on this label.
|
|
Overridden for internal reasons; the API remains unaffected.
Definition at line 105 of file kurllabel.cpp. |
|
Emitted when the user clicked the right mouse button on this label.
|
|
Emitted when the user clicked the right mouse button on this label.
|
|
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.
Definition at line 275 of file kurllabel.cpp. |
|
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 Definition at line 260 of file kurllabel.cpp. |
|
Overridden for internal reasons; the API remains unaffected.
Definition at line 134 of file kurllabel.cpp. |
|
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 Definition at line 255 of file kurllabel.cpp. |
|
This is an overloaded version for convenience.
Definition at line 237 of file kurllabel.cpp. |
|
Sets the highlight color.
This is the default foreground color (non-selected). By default, it is Definition at line 229 of file kurllabel.cpp. |
|
This is an overloaded version for convenience.
Definition at line 250 of file kurllabel.cpp. |
|
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 Definition at line 242 of file kurllabel.cpp. |
|
Specifies what text to display when tooltips are turned on. If this is not used, the tip will default to the URL.
Definition at line 212 of file kurllabel.cpp. |
|
Turns on or off the underlining.
When this is on, the text will be underlined. By default, it is Definition at line 142 of file kurllabel.cpp. |
|
Sets the URL for this label to
Definition at line 166 of file kurllabel.cpp. |
|
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.
Definition at line 181 of file kurllabel.cpp. |
|
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 Definition at line 202 of file kurllabel.cpp. |
|
Returns the current tooltip text.
|
|
Returns the URL.
|
|
|
|
|
The documentation for this class was generated from the following files: