• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Konsole

Konsole::FilterChain

Konsole::FilterChain Class Reference

#include <Filter.h>

Inheritance diagram for Konsole::FilterChain:

Inheritance graph
[legend]

List of all members.


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 325 of file Filter.h.


Public Member Functions

void addFilter (Filter *filter)
void clear ()
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)
virtual ~FilterChain ()

Constructor & Destructor Documentation

FilterChain::~FilterChain (  )  [virtual]

Definition at line 44 of file Filter.cpp.


Member Function Documentation

void FilterChain::addFilter ( Filter *  filter  ) 

Adds a new filter to the chain.

The chain will delete this filter when it is destroyed

Definition at line 56 of file Filter.cpp.

void FilterChain::clear (  ) 

Removes all filters from the chain.

Reimplemented from QList.

Definition at line 86 of file Filter.cpp.

bool FilterChain::containsFilter ( Filter *  filter  ) 

Returns true if the chain contains filter.

Definition at line 64 of file Filter.cpp.

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.

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

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

Definition at line 106 of file Filter.cpp.

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.

void FilterChain::process (  ) 

Processes each filter in the chain.

Definition at line 80 of file Filter.cpp.

void FilterChain::removeFilter ( Filter *  filter  ) 

Removes a filter from the chain.

The chain will no longer delete the filter when destroyed

Definition at line 60 of file Filter.cpp.

void FilterChain::reset (  ) 

Resets each filter in the chain.

Definition at line 68 of file Filter.cpp.

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

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

Definition at line 74 of file Filter.cpp.


The documentation for this class was generated from the following files:
  • Filter.h
  • Filter.cpp

Konsole

Skip menu "Konsole"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • Konsole
  • Libraries
  •   libkonq
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal