<HTML>
<HEAD>
<TITLE>Source: kanimwidget.h</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>Source: kanimwidget.h</h1>
</TD>
<TD valign="top" align="right" colspan="1"></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<pre>
/* This file is part of the KDE libraries
Copyright (C) 2000 Kurt Granroth <granroth@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef _KANIMWIDGET_H
#define _KANIMWIDGET_H
#include <qframe.h>
#include <kiconloader.h>
class QStringList;
class QPainter;
class QMouseEvent;
/**
* 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:
* <pre>
* QStringList icons;
* icons.append("one");
* icons.append("two");
* icons.append("three");
* KAnimWidget *anim = new KAnimWidget(icons, 0, this);
* anim->start();
* </pre>
*
* 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.
*
* @short Widget animated using individual icons
* @author Kurt Granroth <granroth@kde.org>
*/
class KAnimWidget : public QFrame
{
Q_OBJECT
public:
/**
* 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.
*
* @param icons The icons name (e.g., "kde") to use for the animation
* @param 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.
* @param parent The standard parent
* @param name The standard internal name
*/
KAnimWidget( const QString& icons, int size = 0,
QWidget *parent = 0L, const char *name = 0L );
/**
* This is the constructor to use if you are using custom
* (non-standard) icons for the animation. Pass along your list of
* icons to use for the animation and an optional size to load and
* you're set. If you omit the size, the default size will be used.
*
* @param icons The icons to use for the animation
* @param 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.
* @param parent The standard parent
* @param name The standard internal name
*/
KAnimWidget( const QStringList& icons,
int size = 0,
QWidget *parent = 0L, const char *name = 0L );
/**
* Default constructor. This will not do anything until you use
* @ref setIcons() later.
*
* @param parent The standard parent
* @param name The standard internal name
*/
KAnimWidget( QWidget *parent = 0L, const char *name = 0L );
/**
* Destructor
*/
virtual ~KAnimWidget();
/**
* Start the animation from frame 1
*/
void start();
/**
* Stop the animation. This will also reset the widget to frame 1.
*/
void stop();
/**
* Set the size of the icons.
*
* @param size The size of the icons
*/
void setSize( int size );
/**
* Set the list of icons to use for the animation. They will all be
* loaded using the @p MainBarIcon() function so make sure that they are
* toolbar icons... or at least loadable using @p MainBarIcon().
*
* @param icons The icons to use for the animation
*/
void setIcons( const QStringList& icons );
/**
* Set the name of the animated icons to load. This will use the
* KIconLoader::loadAnimated method for the actual loading.
*
* @param icons The name of the icons to use for the animation
*/
void setIcons( const QString& icons );
signals:
void clicked();
protected:
virtual void drawContents( QPainter *p );
virtual void leaveEvent( QEvent *e );
virtual void enterEvent( QEvent *e );
virtual void hideEvent( QHideEvent *e);
virtual void mousePressEvent( QMouseEvent *e );
protected slots:
void slotTimerUpdate();
void updateIcons();
private:
void loadRemainingIcons();
class KAnimWidgetPrivate;
KAnimWidgetPrivate *d;
};
#endif // _KANIMWIDGET_H
</pre>
<HR>
<table>
<tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:09:05 2002, using kdoc 2.0a53.</small></td></tr>
</table>
</BODY>
</HTML>
