.TH "KAnimWidget" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KAnimWidget \- Standard 'About KDE' dialog box.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kanimwidget.h>\fP
.PP
Inherits \fBQFrame\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBstart\fP ()"
.br
.ti -1c
.RI "void \fBstop\fP ()"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBclicked\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKAnimWidget\fP (const \fBQString\fP &icons, int size=0, \fBQWidget\fP *parent=0L, const char *name=0L)"
.br
.ti -1c
.RI "virtual \fB~KAnimWidget\fP ()"
.br
.ti -1c
.RI "void \fBsetSize\fP (int size)"
.br
.ti -1c
.RI "int \fBsize\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBicons\fP () const "
.br
.ti -1c
.RI "void \fBsetIcons\fP (const \fBQString\fP &icons)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotTimerUpdate\fP ()"
.br
.ti -1c
.RI "void \fBupdateIcons\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBdrawContents\fP (\fBQPainter\fP *p)"
.br
.ti -1c
.RI "virtual void \fBleaveEvent\fP (\fBQEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBenterEvent\fP (\fBQEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBhideEvent\fP (\fBQHideEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBshowEvent\fP (\fBQShowEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBmousePressEvent\fP (\fBQMouseEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBmouseReleaseEvent\fP (\fBQMouseEvent\fP *e)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Properties"

.in +1c
.ti -1c
.RI "int \fBsize\fP"
.br
.ti -1c
.RI "\fBQString\fP \fBicons\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Standard 'About KDE' dialog box. 

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.
.PP
This widget also emits a 'clicked()' signal when it received a mouse press event.
.PP
A quick example: 
.PP
.nf
 KAnimWidget *anim = new KAnimWidget('kde', 0, this);
 anim->start();

.fi
.PP
.PP
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.
.PP
\fBAuthor:\fP
.RS 4
Kurt Granroth <granroth@kde.org> 
.RE
.PP

.PP
Definition at line 55 of file kanimwidget.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KAnimWidget::KAnimWidget (const \fBQString\fP & icons, int size = \fC0\fP, \fBQWidget\fP * parent = \fC0L\fP, const char * name = \fC0L\fP)"
.PP
This is the most common constructor. 
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fIicons\fP The icons name (e.g., 'kde') to use for the animation 
.br
\fIsize\fP The size to load You don't have to set it if the parent is a \fBKToolBar\fP; in this case it will use the toolbar's size. 
.br
\fIparent\fP The standard parent 
.br
\fIname\fP The standard internal name 
.RE
.PP

.PP
Definition at line 43 of file kanimwidget.cpp.
.PP
References QFrame::setFrameStyle(), and setIcons().
.SS "KAnimWidget::~\fBKAnimWidget\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
Definition at line 60 of file kanimwidget.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KAnimWidget::setSize (int size)"
.PP
Sets the size of the icons. 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP The size of the icons 
.RE
.PP

.PP
Definition at line 80 of file kanimwidget.cpp.
.SS "int KAnimWidget::size () const"
.PP
Returns the current size. 
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.SS "\fBQString\fP KAnimWidget::icons () const"
.PP
Returns the current icons since 3.4. 
.PP
.SS "void KAnimWidget::setIcons (const \fBQString\fP & icons)"
.PP
Sets the name of the animated icons to load. 
.PP
This will use the \fBKIconLoader::loadAnimated\fP method for the actual loading.
.PP
\fBParameters:\fP
.RS 4
\fIicons\fP The name of the icons to use for the animation 
.RE
.PP

.PP
Definition at line 89 of file kanimwidget.cpp.
.PP
Referenced by KAnimWidget().
.SS "void KAnimWidget::start ()\fC [slot]\fP"
.PP
Starts the animation from frame 1. 
.PP
Definition at line 67 of file kanimwidget.cpp.
.SS "void KAnimWidget::stop ()\fC [slot]\fP"
.PP
Stops the animation. 
.PP
This will also reset the widget to frame 1. 
.PP
Definition at line 73 of file kanimwidget.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
