Hyperlink Class Reference

Represents a named, rectangular region in a rendered documentPage. More...

#include <hyperlink.h>

List of all members.

Public Member Functions
	Hyperlink (Q_UINT32 bl, const QRect &re, const QString &lT)
	Hyperlink ()
Public Attributes
Q_UINT32	baseline
QRect	box
QString	linkText

---

Detailed Description

Represents a named, rectangular region in a rendered documentPage.

This trivial class is used in the documentPage class to represent a hyperlink in a rendered documentPage.

Author:

Stefan Kebekus <kebekus@kde.org>

Version:

1.0.0

Definition at line 25 of file hyperlink.h.

---

Constructor & Destructor Documentation

Hyperlink::Hyperlink

(

)

[inline]

Default Constructor.

The default constructor leaves all fields uninitialized.

Definition at line 32 of file hyperlink.h.

Hyperlink::Hyperlink	(	Q_UINT32	bl,
		const QRect &	re,
		const QString &	lT
	)			[inline]

Constructor.

Trivial constructor leaves that initialized all members.

Parameters:

	bl	value for the baseline field
	re	value for the box
	lT	valus for the text field

Definition at line 42 of file hyperlink.h.

---

Member Data Documentation

Q_UINT32 Hyperlink::baseline

Base line of a hyperlink.

This field specifies the Y-coordinate of the base line of the bounding box in the same coordinates that were used when the associated documentPage was rendered by the documentRenderer.drawPage() method. It is used to underline hyperlinks in blue. Note that this field does generally differ from the Y-coordinate of the bottom of the bounding box, e.g. if the text in the box contains characters with underlengths, such as 'y', 'j' or 'g'.

Definition at line 55 of file hyperlink.h.

QRect Hyperlink::box

Bounding box of the text or hyperlink.

This rectangle specifies where on the page the hyperlink is found. It uses the same coordinates that were used when the associated documentPage was rendered by the documentRenderer.drawPage() method. The box is used to determine if the mouse pointer hovers over the link.

Definition at line 65 of file hyperlink.h.

QString Hyperlink::linkText

Name of the region.

This field contains the name of the target, e.g. "http://www.kde.org". If the Hyperlink class is used to represent text, then the text is stored here.

Definition at line 73 of file hyperlink.h.

---

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

• hyperlink.h