Konsole::FilterChain Class Reference

#include <Filter.h>

Inheritance diagram for Konsole::FilterChain:

Public Member Functions
void	addFilter (std::unique_ptr< Filter > &&filter)
bool	containsFilter (Filter *filter)
Filter::HotSpot *	hotSpotAt (int line, int column) const
QList< Filter::HotSpot * >	hotSpots () const
QList< Filter::HotSpot >	hotSpotsAtLine (int line) const
void	process ()
void	removeFilter (Filter *filter)
void	reset ()
void	setBuffer (const QString *buffer, const QList< int > *linePositions)

Detailed Description

A chain which allows a group of filters to be processed as one.

The chain owns the filters added to it and deletes them when the chain itself is destroyed.

Use addFilter() to add a new filter to the chain. When new text to be filtered arrives, use addLine() to add each additional line of text which needs to be processed and then after adding the last line, use process() to cause each filter in the chain to process the text.

After processing a block of text, the reset() method can be used to set the filter chain's internal cursor back to the first line.

The hotSpotAt() method will return the first hotspot which covers a given position.

The hotSpots() and hotSpotsAtLine() method return all of the hotspots in the text and on a given line respectively.

Definition at line 319 of file Filter.h.

Member Function Documentation

addFilter()

void FilterChain::addFilter

(

std::unique_ptr< Filter > &&

filter

)

Adds a new filter to the chain.

The chain will delete this filter when it is destroyed

Definition at line 47 of file Filter.cpp.

containsFilter()

bool FilterChain::containsFilter

(

Filter *

filter

)

Returns true if the chain contains filter.

Definition at line 59 of file Filter.cpp.

hotSpotAt()

Filter::HotSpot * FilterChain::hotSpotAt	(	int	line,
		int	column ) const

Returns the first hotspot which occurs at line, column or 0 if no hotspot was found.

Definition at line 90 of file Filter.cpp.

hotSpots()

QList< Filter::HotSpot * > FilterChain::hotSpots

(

)

const

Returns a list of all the hotspots in all the chain's filters.

Definition at line 102 of file Filter.cpp.

hotSpotsAtLine()

QList< Filter::HotSpot > Konsole::FilterChain::hotSpotsAtLine

(

int

line

)

const

Returns a list of all hotspots at the given line in all the chain's filters.

process()

void FilterChain::process

(

)

Processes each filter in the chain.

Definition at line 83 of file Filter.cpp.

removeFilter()

void FilterChain::removeFilter

(

Filter *

filter

)

Removes a filter from the chain.

The chain will no longer delete the filter when destroyed

Definition at line 52 of file Filter.cpp.

reset()

void FilterChain::reset

(

)

Resets each filter in the chain.

Definition at line 69 of file Filter.cpp.

setBuffer()

void FilterChain::setBuffer	(	const QString *	buffer,
		const QList< int > *	linePositions )

Sets the buffer for each filter in the chain to process.

Definition at line 76 of file Filter.cpp.

---

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

• Filter.h
• Filter.cpp