libs/flake

KoFilterEffectStack Class Reference

This class manages a stack of filter effects. More...

#include <KoFilterEffectStack.h>

List of all members.

Public Member Functions

 KoFilterEffectStack ()
 ~KoFilterEffectStack ()
void addUser ()
void appendFilterEffect (KoFilterEffect *filter)
QRectF clipRect () const
QRectF clipRectForBoundingRect (const QRectF &boundingRect) const
QList< KoFilterEffect * > filterEffects () const
void insertFilterEffect (int index, KoFilterEffect *filter)
void removeFilterEffect (int index)
bool removeUser ()
void save (KoXmlWriter &writer, const QString &filterId)
void setClipRect (const QRectF &clipRect)
KoFilterEffect * takeFilterEffect (int index)
int useCount () const

Detailed Description

This class manages a stack of filter effects.

Definition at line 32 of file KoFilterEffectStack.h.

Constructor & Destructor Documentation

KoFilterEffectStack::KoFilterEffectStack (  ) 

Creates an empty filter effect stack.

Definition at line 44 of file KoFilterEffectStack.cpp.

KoFilterEffectStack::~KoFilterEffectStack (  ) 

Destroys the filter effect stack, deleting all filter effects.

Definition at line 49 of file KoFilterEffectStack.cpp.

Member Function Documentation

void KoFilterEffectStack::addUser (  ) 

Increase reference counter.

Definition at line 101 of file KoFilterEffectStack.cpp.

void KoFilterEffectStack::appendFilterEffect ( KoFilterEffect *  filter  ) 

Appends a new filter at the end of the filter list.

The filter stack take ownership of the appended filter effect.

Parameters:
filter the new filter to append

Definition at line 65 of file KoFilterEffectStack.cpp.

QRectF KoFilterEffectStack::clipRect (  )  const

Returns the clipping rectangle used for this filter in bounding box units.

Definition at line 87 of file KoFilterEffectStack.cpp.

QRectF KoFilterEffectStack::clipRectForBoundingRect ( const QRectF &  boundingRect  )  const

Returns the clipping rectangle for the given bounding rect.

Definition at line 92 of file KoFilterEffectStack.cpp.

QList< KoFilterEffect * > KoFilterEffectStack::filterEffects (  )  const

The first filter of the list is the first to be applied.

Returns:
the list of filter effects applied on the shape when rendering.

Definition at line 54 of file KoFilterEffectStack.cpp.

void KoFilterEffectStack::insertFilterEffect ( int  index,
KoFilterEffect *  filter 
)

Inserts a new filter at the given position in the filter list.

The filter stack take ownership of the inserted filter effect.

Parameters:
index the list index to insert the new filter at
filter the new filter to insert

Definition at line 59 of file KoFilterEffectStack.cpp.

void KoFilterEffectStack::removeFilterEffect ( int  index  ) 

Removes the filter with the given index from the filter list.

The filter gets deleted after removal from the list.

Parameters:
index the index of the filter to remove

Definition at line 71 of file KoFilterEffectStack.cpp.

bool KoFilterEffectStack::removeUser (  ) 

Decrease reference counter.

Definition at line 106 of file KoFilterEffectStack.cpp.

void KoFilterEffectStack::save ( KoXmlWriter &  writer,
const QString &  filterId 
)

Saves filter stack using given xml writer.

Parameters:
writer the xml writer to write data to
id the filter id to write, used for referencing the filter

Definition at line 116 of file KoFilterEffectStack.cpp.

void KoFilterEffectStack::setClipRect ( const QRectF &  clipRect  ) 

Sets the clipping rectangle used for this filter in bounding box units.

Definition at line 82 of file KoFilterEffectStack.cpp.

KoFilterEffect * KoFilterEffectStack::takeFilterEffect ( int  index  ) 

Take filter effect with given index from the stack and returns it.

Parameters:
index the index of the filter to take
Returns:
the filter effect, of 0 if no filter effect with the given index exists

Definition at line 77 of file KoFilterEffectStack.cpp.

int KoFilterEffectStack::useCount (  )  const

Return reference counter.

Definition at line 111 of file KoFilterEffectStack.cpp.

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