TerminalImageFilterChain Class Reference

A filter chain which processes character images from terminal displays. More...

#include "Filter.h"

Inheritance diagram for TerminalImageFilterChain:

Collaboration diagram for TerminalImageFilterChain:

Public Member Functions
	TerminalImageFilterChain ()
virtual	~TerminalImageFilterChain ()
void	addFilter (Filter *filter)
	Adds a new filter to the chain.
void	clear ()
	Removes all filters from the chain.
bool	containsFilter (Filter *filter)
	Returns true if the chain contains filter.
Filter::HotSpot *	hotSpotAt (int line, int column) const
	Returns the first hotspot which occurs at line, column or 0 if no hotspot was found.
QList< Filter::HotSpot * >	hotSpots () const
	Returns a list of all the hotspots in all the chain's filters.
QList< Filter::HotSpot >	hotSpotsAtLine (int line) const
	Returns a list of all hotspots at the given line in all the chain's filters.
void	process ()
	Processes each filter in the chain.
void	removeFilter (Filter *filter)
	Removes a filter from the chain.
void	reset ()
	Resets each filter in the chain.
void	setBuffer (const QString *buffer, const QList< int > *linePositions)
	Sets the buffer for each filter in the chain to process.
void	setImage (const Character *const image, int lines, int columns, const QVector< LineProperty > &lineProperties)
	Set the current terminal image to image.

Private Attributes
QString *	_buffer
QList< int > *	_linePositions

Detailed Description

A filter chain which processes character images from terminal displays.

Definition at line 358 of file Filter.h.

Constructor & Destructor Documentation

TerminalImageFilterChain::TerminalImageFilterChain

(

)

Definition at line 114 of file Filter.cpp.

TerminalImageFilterChain::~TerminalImageFilterChain ( )

virtual

Definition at line 120 of file Filter.cpp.

References _buffer, and _linePositions.

Member Function Documentation

void FilterChain::addFilter ( Filter *  filter )

inherited

Adds a new filter to the chain.

The chain will delete this filter when it is destroyed

Definition at line 52 of file Filter.cpp.

void FilterChain::clear ( void  )

inherited

Removes all filters from the chain.

Definition at line 82 of file Filter.cpp.

bool FilterChain::containsFilter ( Filter *  filter )

inherited

Returns true if the chain contains filter.

Definition at line 60 of file Filter.cpp.

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

inherited

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

Definition at line 86 of file Filter.cpp.

References filter(), and Filter::hotSpotAt().

Referenced by TerminalView::filterActions(), and TerminalView::mouseMoveEvent().

QList< Filter::HotSpot * > FilterChain::hotSpots ( ) const

inherited

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

Definition at line 102 of file Filter.cpp.

References filter(), and Filter::hotSpots().

Referenced by TerminalView::hotSpotRegion(), and TerminalView::paintFilters().

QList<Filter::HotSpot> FilterChain::hotSpotsAtLine ( int  line ) const

inherited

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

void FilterChain::process ( )

inherited

Processes each filter in the chain.

Definition at line 76 of file Filter.cpp.

Referenced by TerminalView::processFilters().

void FilterChain::removeFilter ( Filter *  filter )

inherited

Removes a filter from the chain.

The chain will no longer delete the filter when destroyed

Definition at line 56 of file Filter.cpp.

void FilterChain::reset ( void  )

inherited

Resets each filter in the chain.

Definition at line 64 of file Filter.cpp.

Referenced by setImage().

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

inherited

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

Definition at line 70 of file Filter.cpp.

Referenced by setImage().

void TerminalImageFilterChain::setImage	(	const Character *const	image,
		int	lines,
		int	columns,
		const QVector< LineProperty > &	lineProperties
	)

Set the current terminal image to image.

Parameters

image	The terminal image
lines	The number of lines in the terminal image
columns	The number of columns in the terminal image

Definition at line 126 of file Filter.cpp.

References _buffer, _linePositions, PlainTextDecoder::begin(), PlainTextDecoder::decodeLine(), PlainTextDecoder::end(), LINE_DEFAULT, LINE_WRAPPED, FilterChain::reset(), FilterChain::setBuffer(), and PlainTextDecoder::setTrailingWhitespace().

Referenced by TerminalView::processFilters().

Member Data Documentation

QString* TerminalImageFilterChain::_buffer

private

Definition at line 375 of file Filter.h.

Referenced by setImage(), and ~TerminalImageFilterChain().

QList<int>* TerminalImageFilterChain::_linePositions

private

Definition at line 376 of file Filter.h.

Referenced by setImage(), and ~TerminalImageFilterChain().

---

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

• libgui/qterminal/libqterminal/unix/Filter.h
• libgui/qterminal/libqterminal/unix/Filter.cpp