KUrlLabel

#include <KUrlLabel>

Inheritance diagram for KUrlLabel:

[legend]

Properties
QPixmap	alternatePixmap

bool	floatEnabled

bool	glowEnabled

QString	tipText

QString	url

bool	useCursor

bool	useTips

Properties inherited from QLabel
	alignment

	hasSelectedText

	indent

	margin

	openExternalLinks

	pixmap

	scaledContents

	selectedText

	text

	textFormat

	textInteractionFlags

	wordWrap

Properties inherited from QFrame
	frameRect

	frameShadow

	frameShape

	frameWidth

	lineWidth

	midLineWidth

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	tabletTracking

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Signals
void	enteredUrl ()

void	enteredUrl (const QString &url)

void	leftClickedUrl ()

void	leftClickedUrl (const QString &url)

void	leftUrl ()

void	leftUrl (const QString &url)

void	middleClickedUrl ()

void	middleClickedUrl (const QString &url)

void	rightClickedUrl ()

void	rightClickedUrl (const QString &url)

Public Slots
void	setAlternatePixmap (const QPixmap &pixmap)

void	setFloatEnabled (bool do_float=true)

virtual void	setFont (const QFont &font)

void	setGlowEnabled (bool glow=true)

void	setHighlightedColor (const QColor &highcolor)

void	setHighlightedColor (const QString &highcolor)

void	setSelectedColor (const QColor &color)

void	setSelectedColor (const QString &color)

void	setTipText (const QString &tip)

void	setUnderline (bool on=true)

void	setUrl (const QString &url)

void	setUseCursor (bool on, QCursor *cursor=nullptr)

void	setUseTips (bool on=true)

Public Member Functions
	KUrlLabel (const QString &url, const QString &text=QString(), QWidget *parent=nullptr)

	KUrlLabel (QWidget *parent=nullptr)

	~KUrlLabel () override

const QPixmap *	alternatePixmap () const

bool	isFloatEnabled () const

bool	isGlowEnabled () const

QString	tipText () const

QString	url () const

bool	useCursor () const

bool	useTips () const

Public Member Functions inherited from QLabel
	QLabel (const QString &text, QWidget *parent, Qt::WindowFlags f)

	QLabel (QWidget *parent, Qt::WindowFlags f)

Qt::Alignment	alignment () const const

QWidget *	buddy () const const

void	clear ()

bool	hasScaledContents () const const

bool	hasSelectedText () const const

virtual int	heightForWidth (int w) const const override

int	indent () const const

void	linkActivated (const QString &link)

void	linkHovered (const QString &link)

int	margin () const const

virtual QSize	minimumSizeHint () const const override

QMovie *	movie () const const

bool	openExternalLinks () const const

const QPicture *	picture () const const

QPicture	picture (Qt::ReturnByValueConstant) const const

const QPixmap *	pixmap () const const

QPixmap	pixmap (Qt::ReturnByValueConstant) const const

QString	selectedText () const const

int	selectionStart () const const

void	setAlignment (Qt::Alignment)

void	setBuddy (QWidget *buddy)

void	setIndent (int)

void	setMargin (int)

void	setMovie (QMovie *movie)

void	setNum (double num)

void	setNum (int num)

void	setOpenExternalLinks (bool open)

void	setPicture (const QPicture &picture)

void	setPixmap (const QPixmap &)

void	setScaledContents (bool)

void	setSelection (int start, int length)

void	setText (const QString &)

void	setTextFormat (Qt::TextFormat)

void	setTextInteractionFlags (Qt::TextInteractionFlags flags)

void	setWordWrap (bool on)

virtual QSize	sizeHint () const const override

QString	text () const const

Qt::TextFormat	textFormat () const const

Qt::TextInteractionFlags	textInteractionFlags () const const

bool	wordWrap () const const

Public Member Functions inherited from QFrame
	QFrame (QWidget *parent, Qt::WindowFlags f)

QRect	frameRect () const const

QFrame::Shadow	frameShadow () const const

QFrame::Shape	frameShape () const const

int	frameStyle () const const

int	frameWidth () const const

int	lineWidth () const const

int	midLineWidth () const const

void	setFrameRect (const QRect &)

void	setFrameShadow (QFrame::Shadow)

void	setFrameShape (QFrame::Shape)

void	setFrameStyle (int style)

void	setLineWidth (int)

void	setMidLineWidth (int)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const const

QString	accessibleDescription () const const

QString	accessibleName () const const

QList< QAction * >	actions () const const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (int x, int y) const const

QRect	childrenRect () const const

QRegion	childrenRegion () const const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const const

QRect	contentsRect () const const

Qt::ContextMenuPolicy	contextMenuPolicy () const const

QCursor	cursor () const const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const const

void	ensurePolished () const const

Qt::FocusPolicy	focusPolicy () const const

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () const const

void	getContentsMargins (int left, int top, int right, int bottom) const const

QPixmap	grab (const QRect &rectangle)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () const const

bool	hasEditFocus () const const

bool	hasFocus () const const

virtual bool	hasHeightForWidth () const const

bool	hasMouseTracking () const const

bool	hasTabletTracking () const const

int	height () const const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const const

bool	isAncestorOf (const QWidget *child) const const

bool	isEnabled () const const

bool	isEnabledTo (const QWidget *ancestor) const const

bool	isEnabledToTLW () const const

bool	isFullScreen () const const

bool	isHidden () const const

bool	isMaximized () const const

bool	isMinimized () const const

bool	isModal () const const

bool	isTopLevel () const const

bool	isVisible () const const

bool	isVisibleTo (const QWidget *ancestor) const const

bool	isWindow () const const

bool	isWindowModified () const const

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const const

QPoint	mapFromGlobal (const QPoint &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const const

QPoint	mapToGlobal (const QPoint &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QRegion	mask () const const

int	maximumHeight () const const

QSize	maximumSize () const const

int	maximumWidth () const const

int	minimumHeight () const const

QSize	minimumSize () const const

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () const const

	QWIDGETSIZE_MAX QWIDGETSIZE_MAX

void	raise ()

QRect	rect () const const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)

void	repaint ()

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const const

QScreen *	screen () const const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setContentsMargins (const QMargins &margins)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus ()

void	setFocus (Qt::FocusReason reason)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

void	setTabletTracking (bool enable)

void	setToolTip (const QString &)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlag (Qt::WindowType flag, bool on)

void	setWindowFlags (Qt::WindowFlags type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const const

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () const const

bool	underMouse () const const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const const

QRegion	visibleRegion () const const

QString	whatsThis () const const

int	width () const const

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () const const

QIcon	windowIcon () const const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const const

qreal	windowOpacity () const const

QString	windowRole () const const

Qt::WindowStates	windowState () const const

QString	windowTitle () const const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const const

WId	winId () const const

int	x () const const

int	y () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
int	colorCount () const const

int	depth () const const

int	devicePixelRatio () const const

qreal	devicePixelRatioF () const const

int	height () const const

int	heightMM () const const

int	logicalDpiX () const const

int	logicalDpiY () const const

bool	paintingActive () const const

int	physicalDpiX () const const

int	physicalDpiY () const const

int	width () const const

int	widthMM () const const

Protected Member Functions
void	enterEvent (QEnterEvent *event) override

bool	event (QEvent *) override

void	leaveEvent (QEvent *) override

void	mouseReleaseEvent (QMouseEvent *) override

Protected Member Functions inherited from QLabel
virtual void	changeEvent (QEvent *ev) override

virtual void	contextMenuEvent (QContextMenuEvent *ev) override

virtual void	focusInEvent (QFocusEvent *ev) override

virtual bool	focusNextPrevChild (bool next) override

virtual void	focusOutEvent (QFocusEvent *ev) override

virtual void	keyPressEvent (QKeyEvent *ev) override

virtual void	mouseMoveEvent (QMouseEvent *ev) override

virtual void	mousePressEvent (QMouseEvent *ev) override

virtual void	paintEvent (QPaintEvent *) override

Protected Member Functions inherited from QFrame
void	initStyleOption (QStyleOptionFrame *option) const const

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	closeEvent (QCloseEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

bool	focusNextChild ()

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual int	metric (QPaintDevice::PaintDeviceMetric m) const const override

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, long result)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QFrame
enum	Shadow

enum	Shape

enum	StyleMask

Public Types inherited from QWidget
enum	RenderFlag

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QFrame
	Box

	HLine

	NoFrame

	Panel

	Plain

	Raised

	Shadow_Mask

	Shape_Mask

	StyledPanel

	Sunken

	VLine

	WinPanel

Public Attributes inherited from QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

typedef	RenderFlags

Public Attributes inherited from QObject
typedef	QObjectList

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

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, &KUrlLabel::leftClickedUrl, this, [this](cont QString &url) { processMyUrl(url); };

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.

KUrlLabel Widget

Author: Kurt Granroth granr[email protected][email protected][email protected]kde.o[email protected]rg (Interface); Peter Putzer putze[email protected][email protected][email protected]e.org (Rewrite)

Definition at line 60 of file kurllabel.h.

Constructor & Destructor Documentation

◆ KUrlLabel() [1/2]

KUrlLabel::KUrlLabel ( QWidget * parent = nullptr )

explicit

Default constructor.

Use setUrl() and setText() or QListView::setPixmap() to set the resp. properties.

Definition at line 82 of file kurllabel.cpp.

◆ KUrlLabel() [2/2]

KUrlLabel::KUrlLabel	(	const QString &	url,
		const QString &	text = `QString()`,
		QWidget *	parent = `nullptr`
	)

explicit

Convenience constructor.

Parameters

url	is the URL emitted when the label is clicked.
text	is the displayed string. If it's equal to QString() the `url` will be used instead.
parent	Passed to lower level constructor

parent and name are passed to QLabel, which in turn passes them further down

Definition at line 73 of file kurllabel.cpp.

◆ ~KUrlLabel()

KUrlLabel::~KUrlLabel ( )

overridedefault

Destructs the label.

Member Function Documentation

◆ alternatePixmap()

const QPixmap* KUrlLabel::alternatePixmap ( ) const

Returns: the alternate pixmap (may be a null pointer if none was set)

◆ enteredUrl [1/2]

void KUrlLabel::enteredUrl ( )

signal

Emitted when the mouse has passed over the label.

◆ enteredUrl [2/2]

void KUrlLabel::enteredUrl ( const QString & url )

signal

Emitted when the mouse has passed over the label.

Parameters

url	The URL for this label.

Deprecated:: Since 5.65, use enteredUrl();

◆ enterEvent()

void KUrlLabel::enterEvent ( QEnterEvent * event )

overrideprotected

Overridden for internal reasons; the API remains unaffected.

Definition at line 265 of file kurllabel.cpp.

◆ event()

bool KUrlLabel::event ( QEvent * event )

overrideprotectedvirtual

Catch parent palette changes.

Reimplemented from QLabel.

Definition at line 316 of file kurllabel.cpp.

◆ isFloatEnabled()

bool KUrlLabel::isFloatEnabled ( ) const

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 249 of file kurllabel.cpp.

◆ isGlowEnabled()

bool KUrlLabel::isGlowEnabled ( ) const

When this is on, the text will switch to the selected color whenever the mouse passes over it.

Definition at line 244 of file kurllabel.cpp.

◆ leaveEvent()

void KUrlLabel::leaveEvent ( QEvent * event )

overrideprotectedvirtual

Overridden for internal reasons; the API remains unaffected.

Reimplemented from QWidget.

Definition at line 297 of file kurllabel.cpp.

◆ leftClickedUrl [1/2]

void KUrlLabel::leftClickedUrl ( )

signal

Emitted when the user clicked the left mouse button on this label.

◆ leftClickedUrl [2/2]

void KUrlLabel::leftClickedUrl ( const QString & url )

signal

Emitted when the user clicked the left mouse button on this label.

Parameters

url	The URL for this label.

Deprecated:: Since 5.65, use leftClickedUrl();

◆ leftUrl [1/2]

void KUrlLabel::leftUrl ( )

signal

Emitted when the mouse is no longer over the label.

◆ leftUrl [2/2]

void KUrlLabel::leftUrl ( const QString & url )

signal

Emitted when the mouse is no longer over the label.

Deprecated:: Since 5.65, use leftUrl();

Parameters

url	The URL for this label.

◆ middleClickedUrl [1/2]

void KUrlLabel::middleClickedUrl ( )

signal

Emitted when the user clicked the left mouse button on this label.

◆ middleClickedUrl [2/2]

void KUrlLabel::middleClickedUrl ( const QString & url )

signal

Emitted when the user clicked the middle mouse button on this label.

Parameters

url	The URL for this label.

Deprecated:: Since 5.65, use middleClickedUrl();

◆ mouseReleaseEvent()

void KUrlLabel::mouseReleaseEvent ( QMouseEvent * event )

overrideprotectedvirtual

Overridden for internal reasons; the API remains unaffected.

Reimplemented from QLabel.

Definition at line 93 of file kurllabel.cpp.

◆ rightClickedUrl [1/2]

void KUrlLabel::rightClickedUrl ( )

signal

Emitted when the user clicked the right mouse button on this label.

◆ rightClickedUrl [2/2]

void KUrlLabel::rightClickedUrl ( const QString & url )

signal

Emitted when the user clicked the right mouse button on this label.

Parameters

url	The URL for this label.

Deprecated:: Since 5.65, use rightClickedUrl();

◆ setAlternatePixmap

void KUrlLabel::setAlternatePixmap ( const QPixmap & pixmap )

slot

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.

See also: alternatePixmap()

Definition at line 254 of file kurllabel.cpp.

◆ setFloatEnabled

void KUrlLabel::setFloatEnabled ( bool do_float = true )

slot

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 false.

Definition at line 239 of file kurllabel.cpp.

◆ setFont

void KUrlLabel::setFont ( const QFont & font )

virtualslot

Overridden for internal reasons; the API remains unaffected.

Definition at line 127 of file kurllabel.cpp.

◆ setGlowEnabled

void KUrlLabel::setGlowEnabled ( bool glow = true )

slot

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 true.

Definition at line 234 of file kurllabel.cpp.

◆ setHighlightedColor [1/2]

void KUrlLabel::setHighlightedColor ( const QColor & highcolor )

slot

Sets the highlight color.

This is the default foreground color (non-selected). By default, it is blue.

Definition at line 206 of file kurllabel.cpp.

◆ setHighlightedColor [2/2]

void KUrlLabel::setHighlightedColor ( const QString & highcolor )

slot

This is an overloaded version for convenience.

See also: setHighlightedColor()

Definition at line 215 of file kurllabel.cpp.

◆ setSelectedColor [1/2]

void KUrlLabel::setSelectedColor ( const QColor & color )

slot

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 red.

Definition at line 220 of file kurllabel.cpp.

◆ setSelectedColor [2/2]

void KUrlLabel::setSelectedColor ( const QString & color )

slot

This is an overloaded version for convenience.

See also: setSelectedColor()

Definition at line 229 of file kurllabel.cpp.

◆ setTipText

void KUrlLabel::setTipText ( const QString & tip )

slot

Specifies what text to display when tooltips are turned on.

If this is not used, the tip will default to the URL.

See also: setUseTips()

Definition at line 189 of file kurllabel.cpp.

◆ setUnderline

void KUrlLabel::setUnderline ( bool on = true )

slot

Turns on or off the underlining.

When this is on, the text will be underlined. By default, it is true.

Definition at line 135 of file kurllabel.cpp.

◆ setUrl

void KUrlLabel::setUrl ( const QString & url )

slot

Sets the URL for this label to url.

See also: url

Definition at line 142 of file kurllabel.cpp.

◆ setUseCursor

void KUrlLabel::setUseCursor	(	bool	on,
		QCursor *	cursor = `nullptr`
	)

slot

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.

Parameters

on	whether a custom cursor should be displayed.
cursor	the custom cursor. A null pointer indicates the default "hand cursor".

Definition at line 157 of file kurllabel.cpp.

◆ setUseTips

void KUrlLabel::setUseTips ( bool on = true )

slot

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 false.

Definition at line 178 of file kurllabel.cpp.

◆ tipText()

QString KUrlLabel::tipText ( ) const

Returns the current tooltip text.

◆ url()

QString KUrlLabel::url ( ) const

Returns the URL.

◆ useCursor()

bool KUrlLabel::useCursor ( ) const

Returns: true if the cursor will change while over the URL.

See also: setUseCursor ()

◆ useTips()

bool KUrlLabel::useTips ( ) const

Returns: true if a tooltip will be displayed.

See also: setTipText()

The documentation for this class was generated from the following files:

KUrlLabel::KUrlLabel

KUrlLabel(QWidget *parent=nullptr)

Default constructor.

Definition: kurllabel.cpp:82

KUrlLabel

A drop-in replacement for QLabel that displays hyperlinks.

Definition: kurllabel.h:60

KUrlLabel::leftClickedUrl

void leftClickedUrl()

Emitted when the user clicked the left mouse button on this label.

QObject::connect

QMetaObject::Connection connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)

QString

KItinerary::LocationUtil::address

PostalAddress address(const QVariant &location)

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KWidgetsAddons

KUrlLabel

Properties

Signals

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KUrlLabel() [1/2]

◆ KUrlLabel() [2/2]

◆ ~KUrlLabel()

Member Function Documentation

◆ alternatePixmap()

◆ enteredUrl [1/2]

◆ enteredUrl [2/2]

◆ enterEvent()

◆ event()

◆ isFloatEnabled()

◆ isGlowEnabled()

◆ leaveEvent()

◆ leftClickedUrl [1/2]

◆ leftClickedUrl [2/2]

◆ leftUrl [1/2]

◆ leftUrl [2/2]

◆ middleClickedUrl [1/2]

◆ middleClickedUrl [2/2]

◆ mouseReleaseEvent()

◆ rightClickedUrl [1/2]

◆ rightClickedUrl [2/2]

◆ setAlternatePixmap

◆ setFloatEnabled

◆ setFont

◆ setGlowEnabled

◆ setHighlightedColor [1/2]

◆ setHighlightedColor [2/2]

◆ setSelectedColor [1/2]

◆ setSelectedColor [2/2]

◆ setTipText

◆ setUnderline

◆ setUrl

◆ setUseCursor

◆ setUseTips

◆ tipText()

◆ url()

◆ useCursor()

◆ useTips()