Paints a KPixmapSequence on top of any widget at any position. More...

#include <KPixmapSequenceOverlayPainter>

Inheritance diagram for KPixmapSequenceOverlayPainter:

Public Slots
void	setAlignment (Qt::Alignment align)
void	setInterval (int msecs)
void	setOffset (const QPoint &offset)
void	setRect (const QRect &rect)
void	setSequence (const KPixmapSequence &seq)
void	setWidget (QWidget *w)
void	start ()
void	stop ()
Public Member Functions
	KPixmapSequenceOverlayPainter (QObject *parent=0)
	~KPixmapSequenceOverlayPainter ()
Qt::Alignment	alignment () const
int	interval () const
QPoint	offset () const
QRect	rect () const
KPixmapSequence	sequence () const

Detailed Description

Paints a KPixmapSequence on top of any widget at any position.

The KPixmapSequenceOverlayPainter paints an overlay on top of an arbitrary QWidget using a KPixmapSequence. This is typically used for spinners indicating that a process is not finished yet.

Author:: Sebastian Trueg <trueg@kde.org>

Since:: 4.4

Definition at line 46 of file kpixmapsequenceoverlaypainter.h.

Constructor & Destructor Documentation

KPixmapSequenceOverlayPainter::KPixmapSequenceOverlayPainter ( QObject * parent = 0 )

Constructor.

Definition at line 109 of file kpixmapsequenceoverlaypainter.cpp.

KPixmapSequenceOverlayPainter::~KPixmapSequenceOverlayPainter ( )

Destructor.

Definition at line 122 of file kpixmapsequenceoverlaypainter.cpp.

Member Function Documentation

Qt::Alignment KPixmapSequenceOverlayPainter::alignment ( ) const

The alignment of the pixmaps in the rect.

See also:: setAlignment

Definition at line 155 of file kpixmapsequenceoverlaypainter.cpp.

int KPixmapSequenceOverlayPainter::interval ( ) const

The interval between frames.

See also:: setInterval

Definition at line 135 of file kpixmapsequenceoverlaypainter.cpp.

QPoint KPixmapSequenceOverlayPainter::offset ( ) const

The optional offset within the rect.

See also:: setOffset

Definition at line 161 of file kpixmapsequenceoverlaypainter.cpp.

QRect KPixmapSequenceOverlayPainter::rect ( ) const

The optional rect to draw the pixmaps in.

See also:: setRect

Definition at line 141 of file kpixmapsequenceoverlaypainter.cpp.

KPixmapSequence KPixmapSequenceOverlayPainter::sequence ( ) const

The sequence used to draw the overlay.

See also:: setSequence

Definition at line 129 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::setAlignment ( Qt::Alignment align ) [slot]

Set the alignment of the sequence in rect.

Parameters:

align alignment of the overlay. Qt::AlignJustify does not make sense here. Defaults to Qt::Center.

Definition at line 198 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::setInterval ( int msecs ) [slot]

Set the interval between frames.

The default is 200.

Definition at line 176 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::setOffset ( const QPoint & offset ) [slot]

Set the offset relative to the placement determined by alignment and rect.

Parameters:

offset An optional offset which allows an absolute placement.

Defaults to an empty point.

Definition at line 207 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::setRect ( const QRect & rect ) [slot]

Set the rect in which to place the sequence.

Be aware that this optional property does not scale the pixmaps (except if it is smaller) but allows to change the placement.

Parameters:

rect	The rect in which to draw the pixmap using alignment and offset. Be aware that setting a rect bigger than the widget can lead to weird painting errors.

Defaults to the widget's rect.

Definition at line 189 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::setSequence ( const KPixmapSequence & seq ) [slot]

Set the sequence to be used.

By default the KDE busy sequence is used.

Definition at line 167 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::setWidget ( QWidget * w ) [slot]

Set the widget to draw the overlay on.

Definition at line 182 of file kpixmapsequenceoverlaypainter.cpp.

void KPixmapSequenceOverlayPainter::start ( ) [slot]

Start drawing the sequence.

The overlay will be drawn until a call to stop()