An animation display. More...

#include <klfguiutil.h>

Public Slots
virtual void	setWaitMovie (QMovie *movie)
	Set which animation to display while searching.
virtual void	setWaitMovie (const QString &file)
void	setWidthPercent (int widthpercent)
	Sets the width of this label.
void	setHeightPercent (int heightpercent)
	Sets the height of this label.
void	setPositionXPercent (int xpc)
	Sets the horizontal position of this label relative to the parent widget.
void	setPositionYPercent (int ypc)
	Sets the vertical position of this label relative to the parent widget.
void	setBackgroundColor (const QColor &c)
	Set the label background color.
virtual void	startWait ()
	Display the animation.
virtual void	stopWait ()
	Hide the animation.
Public Member Functions
	KLFWaitAnimationOverlay (QWidget *parent)
virtual	~KLFWaitAnimationOverlay ()
QString	waitMovieFileName () const
int	widthPercent () const
int	heightPercent () const
int	positionXPercent () const
int	positionYPercent () const
QColor	backgroundColor () const
Protected Member Functions
virtual void	timerEvent (QTimerEvent *event)
virtual QRect	calcAnimationLabelGeometry ()
Properties
QString	waitMovie
int	widthPercent
int	heightPercent
int	positionXPercent
int	positionYPercent
QColor	backgroundColor

Detailed Description

An animation display.

This animation widget can be used as an overlay widget (meaning, not positioned within a layout) to indicate the user to be patient.

Note that this label relies on a non-NULL parent widget. (Exception: the parent is only needed in calcAnimationLabelGeometry(); if you need a parentless animation widget, subclass this animation label and reimplement that function to fit your needs without calling the base implemenation of that function).

Definition at line 412 of file klfguiutil.h.

Constructor & Destructor Documentation

KLFWaitAnimationOverlay::KLFWaitAnimationOverlay ( QWidget * parent )

Definition at line 338 of file klfguiutil.cpp.

References setBackgroundColor().

KLFWaitAnimationOverlay::~KLFWaitAnimationOverlay ( ) [virtual]

Definition at line 363 of file klfguiutil.cpp.

Member Function Documentation

QColor KLFWaitAnimationOverlay::backgroundColor ( ) const

QRect KLFWaitAnimationOverlay::calcAnimationLabelGeometry ( ) [protected, virtual]

Calculate the geometry the label should have, according to current parent geometry. This function is called just before the label is shown.

The returned QRect should be relative to the parent widget.

Definition at line 439 of file klfguiutil.cpp.

References QRect::height(), QSize::height(), KLF_DEBUG_TEE, KLF_FUNC_NAME, klfDbg, QSize::width(), and QRect::width().

Referenced by startWait().

int KLFWaitAnimationOverlay::heightPercent ( ) const [inline]

Definition at line 428 of file klfguiutil.h.

int KLFWaitAnimationOverlay::positionXPercent ( ) const [inline]

Definition at line 429 of file klfguiutil.h.

int KLFWaitAnimationOverlay::positionYPercent ( ) const [inline]

Definition at line 430 of file klfguiutil.h.

void KLFWaitAnimationOverlay::setBackgroundColor ( const QColor & c ) [slot]

Set the label background color.

This function will set the label background color. It may contain an alpha value to make the label translucent or semi-translucent.

This function internally sets a style sheet to this label.

Definition at line 389 of file klfguiutil.cpp.

References QColor::alpha(), QColor::blue(), QColor::green(), and QColor::red().

Referenced by KLFWaitAnimationOverlay().

void KLFWaitAnimationOverlay::setHeightPercent ( int heightpercent ) [inline, slot]

Sets the height of this label.

See setWidthPercent().

Definition at line 466 of file klfguiutil.h.

void KLFWaitAnimationOverlay::setPositionXPercent ( int xpc ) [inline, slot]

Sets the horizontal position of this label relative to the parent widget.

The value given is, in percent, the amout of space on the left of this label (relative to parent), with 0% being aligned completely to the left (no space left on the left) and 100% being aligned completely to the right (no space left on the right). 50% will center the label.

The label will never go beyond the parent widget's geometry.

This function has no effect if calcAnimationLabelGeometry() has been reimplemented in a subclass that does not call the base implementation of that function.