KateAnimation Class Reference

#include <kateanimation.h>

Inheritance diagram for KateAnimation:

Public Types
enum	EffectType { FadeEffect = 0, GrowEffect }

Public Slots
void	hide ()
void	show ()

Signals
void	widgetHidden ()
void	widgetShown ()

Public Member Functions
	KateAnimation (KMessageWidget *widget, EffectType effect)
bool	hideAnimationActive () const
bool	showAnimationActive () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

This class provides a fade in/out effect for KMessageWidgets.

Example:

KateAnimation* animation = new KateAnimation(someMessageWidget);
animation->show();
//...
animation->hide();

Definition at line 41 of file kateanimation.h.

Member Enumeration Documentation

enum KateAnimation::EffectType

The type of supported animation effects.

Enumerator
FadeEffect	fade in/out
GrowEffect	grow / shrink

Definition at line 49 of file kateanimation.h.

Constructor & Destructor Documentation

KateAnimation::KateAnimation	(	KMessageWidget *	widget,
		EffectType	effect
	)

Constructor.

Definition at line 29 of file kateanimation.cpp.

Member Function Documentation

void KateAnimation::hide ( )

slot

Call to hide the widget.

Definition at line 92 of file kateanimation.cpp.

bool KateAnimation::hideAnimationActive

(

)

const

Returns true, if the hide animation is running, otherwise false.

Definition at line 54 of file kateanimation.cpp.

void KateAnimation::show ( )

slot

Call to show and fade in the widget.

Definition at line 64 of file kateanimation.cpp.

bool KateAnimation::showAnimationActive

(

)

const

Returns true, if the how animation is running, otherwise false.

Definition at line 59 of file kateanimation.cpp.

void KateAnimation::widgetHidden ( )

signal

This signal is emitted when the hiding animation is finished.

At this point, the associated widget is hidden.

void KateAnimation::widgetShown ( )

signal

This signal is emitted when the showing animation is finished.

At this point, the associated widget is hidden.

---

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

• kateanimation.h
• kateanimation.cpp