class KAnimWidget

# class KAnimWidget | Widget animated using individual icons. More...
Definition | `#include <kanimwidget.h>`
Inherits | QFrame (qt) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### 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 )

#### Signals

- void clicked ()

#### Protected Methods

- virtual void drawContents ( QPainter *p )
- virtual void leaveEvent ( QEvent *e )
- virtual void enterEvent ( QEvent *e )
- virtual void hideEvent ( QHideEvent *e)
- virtual void showEvent ( QShowEvent *e)
- virtual void mousePressEvent ( QMouseEvent *e )
- virtual void mouseReleaseEvent ( QMouseEvent *e )
- virtual void virtual_hook ( int id, void* data )

#### Protected Slots

- void slotTimerUpdate ()
- void updateIcons ()

## Detailed Description

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.

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

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 ( QWidget *parent = 0L, const char *name = 0L ) | ### KAnimWidget

Default constructor. This will not do anything until you use setIcons() later.

Parameters:

parent | The standard parent
name | The standard internal name

~KAnimWidget () | ### ~KAnimWidget

[virtual]

Destructor

void start () | ### start

Starts the animation from frame 1

void stop () | ### stop

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

void setSize ( int size ) | ### setSize

Sets the size of the icons.

Parameters:

size | The size of the icons

void setIcons ( const QString& icons ) | ### setIcons

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 clicked () | ### clicked

[signal]

void drawContents ( QPainter *p ) | ### drawContents

[protected virtual]

void leaveEvent ( QEvent *e ) | ### leaveEvent

[protected virtual]

void enterEvent ( QEvent *e ) | ### enterEvent

[protected virtual]

void hideEvent ( QHideEvent *e) | ### hideEvent

[protected virtual]

void showEvent ( QShowEvent *e) | ### showEvent

[protected virtual]

void mousePressEvent ( QMouseEvent *e ) | ### mousePressEvent

[protected virtual]

void mouseReleaseEvent ( QMouseEvent *e ) | ### mouseReleaseEvent

[protected virtual]

void slotTimerUpdate () | ### slotTimerUpdate

[protected slots slot]

void updateIcons () | ### updateIcons

[protected slots slot]

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

- Author: Kurt Granroth
- Generated: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:37 2003, using kdoc 2.0a54.