---

KAnimWidget Class Reference

Widget animated using individual icons. More...

#include <kanimwidget.h>

List of all members.

Public Methods
	KAnimWidget (const QString &icons, int size=0, QWidget *parent=0L, const char *name=0L)
	KAnimWidget (QWidget *parent=0L, const char *name=0L)
virtual	~KAnimWidget ()
void	start ()
void	stop ()
void	setSize (int size)
void	setIcons (const QString &icons)

---

Detailed Description

Widget animated using individual icons.

This is a widget used to display animation using multiple individual pixmaps. This widget allows you to deal with variable size icons (e.g., ones that will change based on a global setting) as it loads the icons internally. All you need to do is pass along a list of icon names and their size and everything else is taken care of.

This widget also emits a 'clicked()' signal when it received a mouse press event.

A quick example:

 QStringList icons;
 icons.append("one");
 icons.append("two");
 icons.append("three");
 KAnimWidget *anim = new KAnimWidget(icons, 0, this);
 anim->start();
 

That example will search for the pixmaps "one.png", "two.png", and "three.png" in the share/icons/small/ directories as well as the app's pics directory.

Author:

Kurt Granroth <granroth@kde.org>

Definition at line 56 of file kanimwidget.h.

---

Constructor & Destructor Documentation

KAnimWidget::KAnimWidget (  const QString &    icons, int    size = 0, QWidget *    parent = 0L, const char *    name = 0L )

This is the most common constructor. Pass along the name of the animated icons to use (e.g., "kde") for the animation and an optional size to load and you're set. If you omit the size, the default size will be used. Parameters: icons  The icons name (e.g., "kde") to use for the animation size  The size to load You don't have to set it if the parent is a KToolBar; in this case it will use the toolbar's size. parent  The standard parent name  The standard internal name

KAnimWidget::KAnimWidget (  QWidget *    parent = 0L, const char *    name = 0L )

Default constructor. This will not do anything until you use setIcons() later. Parameters: parent  The standard parent name  The standard internal name

virtual KAnimWidget::~KAnimWidget (    )  [virtual]

Destructor

---

Member Function Documentation

void KAnimWidget::setIcons (  const QString &    icons )

Sets the name of the animated icons to load. This will use the KIconLoader::loadAnimated method for the actual loading. Parameters: icons  The name of the icons to use for the animation

void KAnimWidget::setSize (  int    size )

Sets the size of the icons. Parameters: size  The size of the icons

void KAnimWidget::start (    )

Starts the animation from frame 1

void KAnimWidget::stop (    )

Stops the animation. This will also reset the widget to frame 1.

---

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

• kanimwidget.h

---