LinkLocator Class Reference

#include <linklocator.h>

Inherited by SpellingFilter::TextCensor.

Public Member Functions
	LinkLocator (const TQString &text, int pos=0)
void	setMaxUrlLen (int length)
int	maxUrlLen () const
void	setMaxAddressLen (int length)
int	maxAddressLen () const
TQString	getUrl ()
TQString	getEmailAddress ()

Static Public Member Functions
static TQString	convertToHtml (const TQString &plainText, int flags=0, int maxUrlLen=4096, int maxAddressLen=255)
static TQString	pngToDataUrl (const TQString &iconPath)

Static Public Attributes
static const int	PreserveSpaces = 0x01
static const int	ReplaceSmileys = 0x02
static const int	IgnoreUrls = 0x04
static const int	HighlightText = 0x08

Protected Attributes
TQString	mText
int	mPos

Detailed Description

LinkLocator assists in identifying sections of text that can usefully be converted in hyperlinks in html.

It is intended to be used in two ways: either by calling convertToHtml() to convert a plaintext string into html, or to be derived from where more control is needed.

Identifies URLs and email addresses embedded in plaintext.

Author

Dave Corrie kde@d.nosp@m.avec.nosp@m.orrie.nosp@m..com

Definition at line 41 of file linklocator.h.

Constructor & Destructor Documentation

LinkLocator()

LinkLocator::LinkLocator	(	const TQString &	text,
		int	pos = 0
	)

Constructs a LinkLocator that will search a plaintext string from a given starting point.

Parameters

text	The string in which to search.
pos	An index into 'text' from where the search should begin.

Definition at line 44 of file linklocator.cpp.

Member Function Documentation

convertToHtml()

TQString LinkLocator::convertToHtml ( const TQString &  plainText, int  flags = 0, int  maxUrlLen = 4096, int  maxAddressLen = 255  )

static

Converts plaintext into html.

The following characters are converted to HTML entities: & " < >. Newlines are also preserved.

Parameters

plainText	The text to be converted into HTML.
flags	The flags to consider when processing plainText. Currently supported flags are: PreserveSpaces, preserves the appearance of sequences of space and tab characters in the resulting HTML. ReplaceSmileys, replace text smileys with emoticon images. IgnoreUrls, doesn't parse any URLs. HighlightText, interprets text highlighting markup like bold, underlined and /italic/.
maxUrlLen	The maximum length of permitted URLs. (See maxUrlLen().)
maxAddressLen	The maximum length of permitted email addresses. (See maxAddressLen().)

Returns

An HTML version of the text supplied in the 'plainText' parameter, suitable for inclusion in the BODY of an HTML document.

Definition at line 226 of file linklocator.cpp.

getEmailAddress()

TQString LinkLocator::getEmailAddress

(

)

Attempts to grab an email address.

If there is an @ symbol at the current scan position, then the text will be searched both backwards and forwards to find the email address. If there is no @ symbol at the current scan position, an empty string is returned. If an address is found, then the current scan position is set to the index of the last character in the address.

Returns

The email address at the current scan position, or an empty string.

Definition at line 169 of file linklocator.cpp.

getUrl()

TQString LinkLocator::getUrl

(

)

Attempts to grab a URL starting at the current scan position.

If there is no URL at the current scan position, then an empty string is returned. If a URL is found, the current scan position is set to the index of the last character in the URL.

Returns

The URL at the current scan position, or an empty string.

Definition at line 88 of file linklocator.cpp.

maxAddressLen()

int LinkLocator::maxAddressLen

(

)

const

Returns

The current limit on the maximum length of an email address.

See also

setMaxAddressLen().

Definition at line 83 of file linklocator.cpp.

maxUrlLen()

int LinkLocator::maxUrlLen

(

)

const

Returns

The current limit on the maximum length of a URL.

See also

setMaxUrlLen().

Definition at line 73 of file linklocator.cpp.

pngToDataUrl()

TQString LinkLocator::pngToDataUrl ( const TQString &  iconPath )

static

Embed the given PNG image into a data URL.

Parameters

iconPath

path to the PNG image

Returns

A data URL, TQString() if the image could not be read.

Definition at line 354 of file linklocator.cpp.

setMaxAddressLen()

void LinkLocator::setMaxAddressLen

(

int

length

)

Sets the maximum length of email addresses that will be matched by getEmailAddress().

By default, this is set to 255 characters. The reason for this limit is that there may be possible security implications in handling addresses of unlimited length.

Parameters

length

The new maximum length of email addresses that will be matched by getEmailAddress().

Definition at line 78 of file linklocator.cpp.

setMaxUrlLen()

void LinkLocator::setMaxUrlLen

(

int

length

)

Sets the maximum length of URLs that will be matched by getUrl().

By default, this is set to 4096 characters. The reason for this limit is that there may be possible security implications in handling URLs of unlimited length.

Parameters

length

The new maximum length of URLs that will be matched by getUrl().

Definition at line 68 of file linklocator.cpp.

Member Data Documentation

mPos

int LinkLocator::mPos

protected

The current scan position.

Definition at line 161 of file linklocator.h.

mText

TQString LinkLocator::mText

protected

The plaintext string being scanned for URLs and email addresses.

Definition at line 157 of file linklocator.h.

---

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

• linklocator.h
• linklocator.cpp