KDE PIM / Developers / API Docs / libkdepim

LinkLocator Class Reference

LinkLocator assists in identifying sections of text that can usefully be converted in hyperlinks in html. Identifies URLs and email addresses embedded in plaintext. More...

#include <linklocator.h>

Inherited by SpellingFilter::TextCensor.

List of all members.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes


Detailed Description

LinkLocator assists in identifying sections of text that can usefully be converted in hyperlinks in html. Identifies URLs and email addresses embedded in plaintext.

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.

Author:
Dave Corrie <kde@davecorrie.com>


Constructor & Destructor Documentation

LinkLocator::LinkLocator const QString &  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.

Member Function Documentation

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().

int LinkLocator::maxUrlLen  )  const
 

Returns:
The current limit on the maximum length of a URL.
See also:
setMaxUrlLen().

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().

int LinkLocator::maxAddressLen  )  const
 

Returns:
The current limit on the maximum length of an email address.
See also:
setMaxAddressLen().

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

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

QString LinkLocator::convertToHtml const QString &  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.
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.

Member Data Documentation

QString LinkLocator::mText [protected]
 

The plaintext string being scanned for URLs and email addresses.

int LinkLocator::mPos [protected]
 

The current scan position.


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