DtSymbolFilterLens Class Reference

This filter loads a DtSymbol and does something to it. More...

Inheritance diagram for DtSymbolFilterLens:

Public Slots
virtual void	filterSymbolDestroyed (QObject *)

Public Member Functions
	DtSymbolFilterLens (const char *name=0, DtLensArea *parent=0)
	constructor, parent must be a Lens area
virtual	~DtSymbolFilterLens ()
	destructor
virtual void	grabRelevantData (DtSymbolList *original, DtSymbolList *modified, QPixmap *background=0, bool isGlobal=false)
virtual void	filterOriginals (DtSymbolList *symbolList)
	This function filter through all the symbols on the list and modifies them as if they were a part of the filter.
virtual DtSymbol *	modifySymbol (DtSymbol *orig, bool createClone=false)
	This either modifies the current symbol, or creates a copy of the symbol and modifies the copy (if the createClone bit is set)
virtual bool	modifyConditional (DtSymbol *newSymbol)
	Override this function to modify new symbols.
virtual bool	checkConditional (DtSymbol *newSymbol)
	Checks if this symbol will be modified without actually modifying the symbol.
virtual bool	deleteModifiedList ()
	Return true if you want to know when the modified list should be deleted.
virtual void	modifiedListAboutToBeFreed (DtSymbolList *sl)
	Override to handle modified list being deleted and having autoDelete turned on (which means that all symbols internally will be deleted as well).
virtual bool	createClone () const
	Return true if, when looking to create a modified symbol, to create a clone.
Public Member Functions inherited from DtFilterLens
	DtFilterLens (const char *name=0, DtLensArea *parent=0)
	constructor, parent must be a Lens area
virtual	~DtFilterLens ()
	destructor

Protected Attributes
DtSymbolList	myModifiedSymbolList
	This is a list of protected symbols.

Detailed Description

This filter loads a DtSymbol and does something to it.

It takes in a DtSymbolList or a DtQuadTree as well as a background pixmap. The lenses should be coupled with DtSymmbolLensArea for the full filtering experience.

Constructor & Destructor Documentation

DtSymbolFilterLens::DtSymbolFilterLens	(	const char *	name = 0,
		DtLensArea *	parent = 0
	)

constructor, parent must be a Lens area

virtual DtSymbolFilterLens::~DtSymbolFilterLens ( )

virtual

destructor

Member Function Documentation

virtual void DtSymbolFilterLens::grabRelevantData ( DtSymbolList *  original, DtSymbolList *  modified, QPixmap *  background = 0, bool  isGlobal = false  )

virtual

Reimplemented in DtReorderingSymbolFilterLens.

virtual void DtSymbolFilterLens::filterOriginals ( DtSymbolList *  symbolList )

virtual

This function filter through all the symbols on the list and modifies them as if they were a part of the filter.

It does this permanently by modifying the originals. There is no way to back up the changes if you change your mind

virtual DtSymbol* DtSymbolFilterLens::modifySymbol ( DtSymbol *  orig, bool  createClone = false  )

virtual

This either modifies the current symbol, or creates a copy of the symbol and modifies the copy (if the createClone bit is set)

virtual bool DtSymbolFilterLens::modifyConditional ( DtSymbol *  newSymbol )

inlinevirtual

Override this function to modify new symbols.

Reimplemented in DtAggregateSymbolFilter, and DtFormationSymbolFilter.

virtual bool DtSymbolFilterLens::checkConditional ( DtSymbol *  newSymbol )

virtual

Checks if this symbol will be modified without actually modifying the symbol.

Reimplemented in DtAggregateSymbolFilter.

virtual bool DtSymbolFilterLens::deleteModifiedList ( )

virtual

Return true if you want to know when the modified list should be deleted.

Reimplemented in DtReorderingSymbolFilterLens.

virtual void DtSymbolFilterLens::modifiedListAboutToBeFreed ( DtSymbolList *  sl )

virtual

Override to handle modified list being deleted and having autoDelete turned on (which means that all symbols internally will be deleted as well).

This should be implemented in the case where a filter lens keeps its own list of symbols and expects them to be kept around from tick to tick (as the DtReorderingSymbolFilterLens)

Reimplemented in DtReorderingSymbolFilterLens.

virtual bool DtSymbolFilterLens::createClone ( ) const

virtual

Return true if, when looking to create a modified symbol, to create a clone.

If false is returned will use original symbol. By default returns true

Reimplemented in DtReorderingSymbolFilterLens.

virtual void DtSymbolFilterLens::filterSymbolDestroyed ( QObject *  )

virtualslot

Member Data Documentation

DtSymbolList DtSymbolFilterLens::myModifiedSymbolList

protected

This is a list of protected symbols.

All symbols that this filter lens create and you don't want removed on every tick should come in here. by default, all modified symbols are stored in here

---

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

• include/filterLenses/symbolFilterLens.h