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>
Public Member Functions | |
LinkLocator (const QString &text, int pos=0) | |
void | setMaxUrlLen (int length) |
int | maxUrlLen () const |
void | setMaxAddressLen (int length) |
int | maxAddressLen () const |
QString | getUrl () |
QString | getEmailAddress () |
Static Public Member Functions | |
QString | convertToHtml (const QString &plainText, bool preserveBlanks=false, int maxUrlLen=4096, int maxAddressLen=255) |
Protected Attributes | |
QString | mText |
int | mPos |
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>
Definition at line 38 of file linklocator.h.
Constructor & Destructor Documentation
|
Constructs a LinkLocator that will search a plaintext string from a given starting point.
|
Member Function Documentation
|
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.
Referenced by convertToHtml(). |
|
Referenced by getUrl(). |
|
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.
Referenced by convertToHtml(). |
|
Referenced by getEmailAddress(). |
|
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.
References maxUrlLen(), mPos, and mText. Referenced by convertToHtml(). |
|
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.
References maxAddressLen(), mPos, and mText. Referenced by convertToHtml(). |
|
Converts plaintext into html. The following characters are converted to HTML entities: & " < >. Newlines are also preserved.
References getEmailAddress(), getUrl(), mPos, mText, setMaxAddressLen(), and setMaxUrlLen(). |
Member Data Documentation
|
The plaintext string being scanned for URLs and email addresses. Definition at line 134 of file linklocator.h. Referenced by convertToHtml(), getEmailAddress(), and getUrl(). |
|
The current scan position. Definition at line 138 of file linklocator.h. Referenced by convertToHtml(), getEmailAddress(), and getUrl(). |
The documentation for this class was generated from the following files: