A filter processes blocks of text looking for certain patterns (such as URLs or keywords from a list) and marks the areas which match the filter's patterns as 'hotspots'. More...

#include "Filter.h"

Inheritance diagram for Filter:

[legend]

Collaboration diagram for Filter:

[legend]

Classes
class	HotSpot
	Represents an area of text which matched the pattern a particular filter has been looking for. More...

Public Member Functions
	Filter ()
	Constructs a new filter.
virtual	~Filter ()
HotSpot *	hotSpotAt (int line, int column) const
	Adds a new line of text to the filter and increments the line count.
QList< HotSpot * >	hotSpots () const
	Returns the list of hotspots identified by the filter.
QList< HotSpot * >	hotSpotsAtLine (int line) const
	Returns the list of hotspots identified by the filter which occur on a given line.
virtual void	process ()=0
	Causes the filter to process the block of text currently in its internal buffer.
void	reset ()
	Empties the filters internal buffer and resets the line count back to 0.
void	setBuffer (const QString buffer, const QList< int > linePositions)
	TODO: Document me.

Protected Member Functions
void	addHotSpot (HotSpot *)
	Adds a new hotspot to the list.
const QString *	buffer ()
	Returns the internal buffer.
void	getLineColumn (int position, int &startLine, int &startColumn)
	Converts a character position within buffer() to a line and column.

Private Attributes
const QString *	_buffer
QList< HotSpot * >	_hotspotList
QMultiHash< int, HotSpot * >	_hotspots
const QList< int > *	_linePositions

Detailed Description

A filter processes blocks of text looking for certain patterns (such as URLs or keywords from a list) and marks the areas which match the filter's patterns as 'hotspots'.

Each hotspot has a type identifier associated with it ( such as a link or a highlighted section ), and an action. When the user performs some activity such as a mouse-click in a hotspot area ( the exact action will depend on what is displaying the block of text which the filter is processing ), the hotspot's activate() method should be called. Depending on the type of hotspot this will trigger a suitable response.

For example, if a hotspot represents a URL then a suitable action would be opening that URL in a web browser. Hotspots may have more than one action, in which case the list of actions can be obtained using the actions() method.

Different subclasses of filter will return different types of hotspot. Subclasses must reimplement the process() method to examine a block of text and identify sections of interest. When processing the text they should create instances of Filter::HotSpot subclasses for sections of interest and add them to the filter's list of hotspots using addHotSpot()

Definition at line 54 of file Filter.h.