Public Member Functions

Overlay Class Reference

Helper filter to collect tiles into stripes required by save. More...

#include <overlay.h>

Inheritance diagram for Overlay:
Inheritance graph
[legend]
Collaboration diagram for Overlay:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Overlay ()
 ~Overlay ()
QuillImage apply (const QuillImage &image) const
bool setOption (const QString &option, const QVariant &value)
QVariant option (const QString &option) const
const QStringList supportedOptions () const
virtual const QString name () const
QuillImageFilter::QuillFilterRole role () const

Detailed Description

Helper filter to collect tiles into stripes required by save.

Each call to the Overlay filter paints one QuillImage (tile) on top of another (horizontal stripe with the whole width of the full image).

Options supported: CropRectangle (the location of the stripe relative to the full image) and Background (a QuillImage for supplying the stripe). The tile will be supplied by a call to apply().

Default behavior: returns empty QuillImage.


Constructor & Destructor Documentation

Overlay::Overlay (  ) 
Overlay::~Overlay (  ) 

Member Function Documentation

QuillImage Overlay::apply ( const QuillImage image  )  const [virtual]

Applies the filter to a given preview or fragment.

Reimplemented from QuillImageFilterImplementation.

virtual const QString Overlay::name (  )  const [inline, virtual]

Reimplemented from QuillImageFilterImplementation.

QVariant Overlay::option ( const QString &  filterOption  )  const [virtual]

Returns the value of a filter option. These options are the recommended way to pass information to the filters. This function needs to be reimplemented in a derived class to support options.

Reimplemented from QuillImageFilterImplementation.

QuillImageFilter::QuillFilterRole Overlay::role (  )  const [virtual]

Reimplemented from QuillImageFilterImplementation.

bool Overlay::setOption ( const QString &  filterOption,
const QVariant &  value 
) [virtual]

Sets the value of a filter option. These options are the recommended way to pass information to the filters. This function needs to be reimplemented in a derived class to support options.

Reimplemented from QuillImageFilterImplementation.

const QStringList Overlay::supportedOptions (  )  const [virtual]

Reimplemented from QuillImageFilterImplementation.


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